forked from github/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into update-new-site-tree-deps
- Loading branch information
Showing
104 changed files
with
7,417 additions
and
4,198 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
name: Copy to REST API issue to docs-content | ||
|
||
# **What it does**: Copies an issue in the open source repo to the docs-content repo, comments on and closes the original issue | ||
# **Why we have it**: REST API updates cannot be made in the open source repo. Instead, we copy the issue to an internal issue (we do not transfer so that the issue does not disappear for the contributor) and close the original issue. | ||
# **Who does it impact**: Open source and docs-content maintainers | ||
|
||
on: | ||
issues: | ||
types: | ||
- labeled | ||
|
||
jobs: | ||
transfer-issue: | ||
name: Transfer issue | ||
runs-on: ubuntu-latest | ||
if: github.event.label.name == 'rest-description' && github.repository == 'github/docs' | ||
steps: | ||
- name: Check if this run was triggered by a member of the docs team | ||
uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 | ||
id: triggered-by-member | ||
with: | ||
github-token: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}} | ||
result-encoding: string | ||
script: | | ||
const triggerer_login = context.payload.sender.login | ||
const teamMembers = await github.request( | ||
`/orgs/github/teams/docs/members?per_page=100` | ||
) | ||
const logins = teamMembers.data.map(member => member.login) | ||
if (logins.includes(triggerer_login)) { | ||
console.log(`This workflow was triggered by ${triggerer_login} (on the docs team).`) | ||
return 'true' | ||
} | ||
console.log(`This workflow was triggered by ${triggerer_login} (not on the docs team), so no action will be taken.`) | ||
return 'false' | ||
- name: Exit if not triggered by a docs team member | ||
if: steps.triggered-by-member.outputs.result == 'false' | ||
run: | | ||
echo Aborting. This workflow must be triggered by a member of the docs team. | ||
exit 1 | ||
- name: Create an issue in the docs-content repo | ||
run: | | ||
new_issue_url="$(gh issue create --title "$ISSUE_TITLE" --body "$ISSUE_BODY" --repo github/docs-content)" | ||
echo 'NEW_ISSUE='$new_issue_url >> $GITHUB_ENV | ||
env: | ||
GITHUB_TOKEN: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}} | ||
ISSUE_TITLE: ${{ github.event.issue.title }} | ||
ISSUE_BODY: ${{ github.event.issue.body }} | ||
|
||
- name: Comment on the new issue | ||
run: gh issue comment $NEW_ISSUE --body "This issue was originally opened in the open source repo as $OLD_ISSUE" | ||
env: | ||
GITHUB_TOKEN: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}} | ||
NEW_ISSUE: ${{ env.NEW_ISSUE }} | ||
OLD_ISSUE: ${{ github.event.issue.html_url }} | ||
|
||
- name: Comment on the old issue | ||
run: gh issue comment $OLD_ISSUE --body "Thank you for opening this issue! Updates to the REST API description must be made internally. I have copied your issue to an internal issue, so I will close this issue." | ||
env: | ||
GITHUB_TOKEN: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}} | ||
OLD_ISSUE: ${{ github.event.issue.html_url }} | ||
|
||
- name: Close the old issue | ||
run: gh issue close $OLD_ISSUE | ||
env: | ||
GITHUB_TOKEN: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}} | ||
OLD_ISSUE: ${{ github.event.issue.html_url }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
name: Transfer REST API issue to rest-api-description | ||
|
||
# **What it does**: Transfers an issue in the open source repo to the open source rest-api-description repo | ||
# **Why we have it**: Requests to change the OpenAPI schema (unless the schema is just a description update) should be made in github/rest-api-description | ||
# **Who does it impact**: Open source and docs-content maintainers | ||
|
||
on: | ||
issues: | ||
types: | ||
- labeled | ||
|
||
jobs: | ||
transfer-issue: | ||
name: Transfer issue | ||
runs-on: ubuntu-latest | ||
if: github.event.label.name == 'rest-schema' && github.repository == 'github/docs' | ||
steps: | ||
- name: Check if this run was triggered by a member of the docs team | ||
uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 | ||
id: triggered-by-member | ||
with: | ||
github-token: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}} | ||
result-encoding: string | ||
script: | | ||
const triggerer_login = context.payload.sender.login | ||
const teamMembers = await github.request( | ||
`/orgs/github/teams/docs/members?per_page=100` | ||
) | ||
const logins = teamMembers.data.map(member => member.login) | ||
if (logins.includes(triggerer_login)) { | ||
console.log(`This workflow was triggered by ${triggerer_login} (on the docs team).`) | ||
return 'true' | ||
} | ||
console.log(`This workflow was triggered by ${triggerer_login} (not on the docs team), so no action will be taken.`) | ||
return 'false' | ||
- name: Exit if not triggered by a docs team member | ||
if: steps.triggered-by-member.outputs.result == 'false' | ||
run: | | ||
echo Aborting. This workflow must be triggered by a member of the docs team. | ||
exit 1 | ||
- name: Comment on the old issue | ||
run: gh issue comment $OLD_ISSUE --body "Thank you for opening this issue! Changes to the REST API schema can be requested in [github/rest-api-description](https://github.com/github/rest-api-description). I will transfer your issue over to that open source repo." | ||
env: | ||
GITHUB_TOKEN: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}} | ||
OLD_ISSUE: ${{ github.event.issue.html_url }} | ||
|
||
- name: Transfer the issue to the rest-api-description repo | ||
run: | | ||
new_issue_url="$(gh issue transfer $OLD_ISSUE github/rest-api-description)" | ||
echo 'NEW_ISSUE='$new_issue_url >> $GITHUB_ENV | ||
env: | ||
GITHUB_TOKEN: ${{secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES}} | ||
OLD_ISSUE: ${{ github.event.issue.html_url }} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
-31.8 KB
(40%)
assets/images/help/repository/repo-transfer-free-plan-warnings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+30.7 KB
assets/images/help/sponsors/example-of-open-source-project-dependency.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -46,6 +46,7 @@ In the tutorial, you will first make a workflow file that uses the [`andymckay/l | |
uses: andymckay/[email protected] | ||
with: | ||
add-labels: "triage" | ||
repo-token: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} | ||
``` | ||
4. Customize the parameters in your workflow file: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -89,7 +89,12 @@ There are two types of snapshots: | |
|
||
{% note %} | ||
|
||
**Note**: Installing a hotpatch using the {% data variables.enterprise.management_console %} is not available in clustered environments. To install a hotpatch in a clustered environment, see "[Upgrading a cluster](/enterprise/{{ currentVersion }}/admin/clustering/upgrading-a-cluster#upgrading-with-a-hotpatch)." | ||
**{% if currentVersion ver_gt "[email protected]" %}Notes{% else %}Note{% endif %}**: | ||
|
||
{% if currentVersion ver_gt "[email protected]" %} | ||
- If {% data variables.product.product_location %} is running a release candidate build, you can't upgrade with a hotpatch. | ||
|
||
- {% endif %}Installing a hotpatch using the {% data variables.enterprise.management_console %} is not available in clustered environments. To install a hotpatch in a clustered environment, see "[Upgrading a cluster](/enterprise/{{ currentVersion }}/admin/clustering/upgrading-a-cluster#upgrading-with-a-hotpatch)." | ||
|
||
{% endnote %} | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -34,6 +34,12 @@ If you don't have private mode enabled, the migration script will have no effect | |
### Running the migration | ||
|
||
1. Connect to the administrative shell. For more information, see "[Accessing the administrative shell (SSH)](/enterprise/admin/installation/accessing-the-administrative-shell-ssh)." | ||
{% if currentVersion ver_gt "[email protected]" or currentVersion == "github-ae@latest" %} | ||
2. Run the migration command. | ||
```shell | ||
github-env bin/safe-ruby lib/github/transitions/20191210220630_convert_public_ghes_repos_to_internal.rb --verbose -w | tee -a /tmp/convert_public_ghes_repos_to_internal.log | ||
``` | ||
{% else %} | ||
2. Navigate to the `/data/github/current` directory. | ||
```shell | ||
cd /data/github/current | ||
|
@@ -42,6 +48,7 @@ If you don't have private mode enabled, the migration script will have no effect | |
```shell | ||
sudo bin/safe-ruby lib/github/transitions/20191210220630_convert_public_ghes_repos_to_internal.rb --verbose -w | tee -a /tmp/convert_public_ghes_repos_to_internal.log | ||
``` | ||
{% endif %} | ||
|
||
Log output will appear in the terminal and `/tmp/convert_public_ghes_repos_to_internal.log`. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
36 changes: 36 additions & 0 deletions
36
...pply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
title: Upgrading from Dependabot.com to GitHub-native Dependabot | ||
intro: 'You can upgrade to GitHub-native Dependabot by merging a pull request that will allow your dependencies to continue being updated.' | ||
versions: | ||
free-pro-team: '*' | ||
topics: | ||
- repositories | ||
--- | ||
|
||
### About upgrading from Dependabot Preview to {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} | ||
|
||
Dependabot Preview has been built directly into {% data variables.product.prodname_dotcom %}, so you can use {% data variables.product.prodname_dependabot %} alongside all the other functionality in {% data variables.product.prodname_dotcom %} without having to install and use a separate application. By migrating to {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}, we can also focus on bringing lots of exciting new features to {% data variables.product.prodname_dependabot %}, including more [ecosystem updates](https://github.com/github/roadmap/issues/150), [improved notifications](https://github.com/github/roadmap/issues/133), and {% data variables.product.prodname_dependabot %} support for [{% data variables.product.prodname_ghe_server %}](https://github.com/github/roadmap/issues/86) and [{% data variables.product.prodname_ghe_managed %}](https://github.com/github/roadmap/issues/135). | ||
|
||
### Differences between Dependabot Preview and {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} | ||
|
||
While most of the Dependabot Preview features exist in {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}, a few remain unavailable: | ||
- **Live updates:** We hope to bring these back in the future. For now, you can run {% data variables.product.prodname_dotcom %} {% data variables.product.prodname_dependabot %} daily to catch new packages within one day of release. | ||
- **PHP environment variable registries:** For now, you can use {% data variables.product.prodname_actions %} to fetch dependencies from these registries. | ||
- **Auto-merge:** We always recommend verifying your dependencies before merging them; therefore, auto-merge will not be supported for the foreseeable future. For those of you who have vetted your dependencies, or are only using internal dependencies, we recommend adding third-party auto-merge apps, or setting up GitHub Actions to merge. | ||
|
||
In {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}, you can configure all version updates using the configuration file. This file is similar to the Dependabot Preview configuration file with a few changes and improvements that will be automatically included in your upgrade pull request. For more information about the upgrade pull request, see "[Upgrading to GitHub-native Dependabot](/code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot#upgrading-to-github-native-dependabot)". | ||
|
||
To see update logs for {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} that were previously on the Dependabot.com dashboard: | ||
|
||
1. Navigate to your repository’s **Insights** page. | ||
2. Click **Dependency graph** to the left. | ||
3. Click **{% data variables.product.prodname_dependabot %}**. | ||
|
||
For more information about version updates with {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}, see "[About Dependabot version updates](/code-security/supply-chain-security/about-dependabot-version-updates)." | ||
|
||
### Upgrading to {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} | ||
|
||
Upgrading from Dependabot Preview to {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} requires only one step: merge the *Upgrade to GitHub-native Dependabot* pull request in your repository. This pull request includes the updated configuration file needed for {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}. | ||
|
||
If you have any questions or need help migrating, you can view or open issues in the [dependabot/dependabot-core](https://github.com/dependabot/dependabot-core/issues) repository. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.