diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 49b7490204..9d87656bb8 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -21,8 +21,8 @@ package.json @github/docs-engineering /content/github/site-policy/ @github/site-policy-admins # Content strategy -/contributing/content-markup-reference.md @github/product-docs-content-strategy -/contributing/content-style-guide.md @github/product-docs-content-strategy +/contributing/content-markup-reference.md @github/docs-content-strategy +/contributing/content-style-guide.md @github/docs-content-strategy # Make sure that Octokit maintainers get notified about changes # relevant to the Octokit libraries (https://github.com/octokit) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 69d8ee5fe9..7f845f8e67 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -21,7 +21,6 @@ Thanks again! ### Check off the following: -- [ ] All of the tests are passing. - [ ] I have reviewed my changes in staging. (look for the **deploy-to-heroku** link in your pull request, then click **View deployment**) - [ ] For content changes, I have reviewed the [localization checklist](https://github.com/github/docs/blob/main/contributing/localization-checklist.md) - [ ] For content changes, I have reviewed the [Content style guide for GitHub Docs](https://github.com/github/docs/blob/main/contributing/content-style-guide.md). diff --git a/.github/allowed-actions.js b/.github/allowed-actions.js index 6dc56f0ab0..e82b20e905 100644 --- a/.github/allowed-actions.js +++ b/.github/allowed-actions.js @@ -12,6 +12,7 @@ module.exports = [ 'actions/setup-ruby@5f29a1cd8dfebf420691c4c9a0e832e2fae5a526', //actions/setup-ruby@v1.1.2 'actions/stale@af4072615903a8b031f986d25b1ae3bf45ec44d4', //actions/stale@v3.0.13 'crowdin/github-action@fd9429dd63d6c0f8a8cb4b93ad8076990bd6e688', + 'crykn/copy_folder_to_another_repo_action@abc264e1c16eb3d7b1f7763bfdb0e1699ad43120', 'dawidd6/action-delete-branch@47743101a121ad657031e6704086271ca81b1911', 'docker://chinthakagodawita/autoupdate-action:v1', 'fkirc/skip-duplicate-actions@36feb0d8d062137530c2e00bd278d138fe191289', diff --git a/.github/workflows/repo-sync-stalls.yml b/.github/workflows/repo-sync-stalls.yml index bc946b9703..73417814b5 100644 --- a/.github/workflows/repo-sync-stalls.yml +++ b/.github/workflows/repo-sync-stalls.yml @@ -36,6 +36,13 @@ jobs: return } + // Remove all pull requests that don't have the + // 'automated-reposync-pr' label + pulls.data = pulls.data.filter(pr => + pr.labels.some(label => label.name === 'automated-reposync-pr') + ) + + // Search for pull requests that have been open too long pulls.data.forEach(pr => { const timeDelta = Date.now() - Date.parse(pr.created_at); const minutesOpen = timeDelta / 1000 / 60; @@ -51,4 +58,4 @@ jobs: channel: ${{ secrets.DOCS_ALERTS_SLACK_CHANNEL_ID }} bot-token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }} color: failure - text: Repo sync appears to be stalled for ${{github.repository}}. See https://github.com/${{github.repository}}/pulls?q=is%3Apr+is%3Aopen+repo+sync + text: Repo sync appears to be stalled for ${{github.repository}}. See https://github.com/${{github.repository}}/pulls?q=is%3Apr+is%3Aopen+label%3Aautomated-reposync-pr diff --git a/.github/workflows/site-policy-sync.yml b/.github/workflows/site-policy-sync.yml new file mode 100644 index 0000000000..fcb5c28902 --- /dev/null +++ b/.github/workflows/site-policy-sync.yml @@ -0,0 +1,39 @@ +name: site-policy-sync + +# Controls when the action will run. +on: + # Triggers the workflow pull requests merged to the main branch + pull_request: + branches: + - main + types: + - closed + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# A workflow run is made up of one or more jobs that can run sequentially or in parallel +jobs: + # This workflow contains a single job called "build" + copy-file: + # The type of runner that the job will run on + runs-on: ubuntu-latest + + # Steps represent a sequence of tasks that will be executed as part of the job + steps: + # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it + - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f + + # Pushes to other repo + - name: Push folder to another repository + uses: crykn/copy_folder_to_another_repo_action@abc264e1c16eb3d7b1f7763bfdb0e1699ad43120 + env: + API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_SITEPOLICY }} + with: + source_folder: 'content/github/site-policy' + destination_repo: 'github/site-policy' + destination_branch: 'non-substantive-changes' + destination_folder: 'Policies' + user_email: 'pcihon@users.noreply.github.com' + user_name: 'pcihon' + commit_msg: 'Mirroring non-substantive changes.' diff --git a/Procfile b/Procfile index 94f69e48bb..6d92caa7fb 100644 --- a/Procfile +++ b/Procfile @@ -1 +1,3 @@ web: NODE_ENV=production node server.js + +release: NODE_ENV=production node script/purge-redis-pages.js diff --git a/assets/images/github-apps/github_apps_probot-registration.png b/assets/images/github-apps/github_apps_probot-registration.png index f7e211412a..709dee1244 100644 Binary files a/assets/images/github-apps/github_apps_probot-registration.png and b/assets/images/github-apps/github_apps_probot-registration.png differ diff --git a/assets/images/help/delete-container-package-version.png b/assets/images/help/delete-container-package-version.png new file mode 100644 index 0000000000..e94ec9ca49 Binary files /dev/null and b/assets/images/help/delete-container-package-version.png differ diff --git a/assets/images/help/organizations/codespaces-sidebar-tab.png b/assets/images/help/organizations/codespaces-sidebar-tab.png new file mode 100644 index 0000000000..d4b122861a Binary files /dev/null and b/assets/images/help/organizations/codespaces-sidebar-tab.png differ diff --git a/assets/images/help/organizations/security-and-analysis-disable-or-enable-all-ghas-dotcom.png b/assets/images/help/organizations/security-and-analysis-disable-or-enable-all-ghas-dotcom.png new file mode 100644 index 0000000000..22beed7afd Binary files /dev/null and b/assets/images/help/organizations/security-and-analysis-disable-or-enable-all-ghas-dotcom.png differ diff --git a/assets/images/help/organizations/security-and-analysis-disable-or-enable-all.png b/assets/images/help/organizations/security-and-analysis-disable-or-enable-all.png deleted file mode 100644 index 80f95c37a4..0000000000 Binary files a/assets/images/help/organizations/security-and-analysis-disable-or-enable-all.png and /dev/null differ diff --git a/assets/images/help/organizations/security-and-analysis-enable-or-disable-feature-checkbox-dotcom.png b/assets/images/help/organizations/security-and-analysis-enable-or-disable-feature-checkbox-dotcom.png new file mode 100644 index 0000000000..1fbeec5190 Binary files /dev/null and b/assets/images/help/organizations/security-and-analysis-enable-or-disable-feature-checkbox-dotcom.png differ diff --git a/assets/images/help/organizations/security-and-analysis-enable-or-disable-feature-checkbox.png b/assets/images/help/organizations/security-and-analysis-enable-or-disable-feature-checkbox.png deleted file mode 100644 index 6b01311f0e..0000000000 Binary files a/assets/images/help/organizations/security-and-analysis-enable-or-disable-feature-checkbox.png and /dev/null differ diff --git a/assets/images/help/organizations/security-and-analysis-highlight-ghas.png b/assets/images/help/organizations/security-and-analysis-highlight-ghas.png new file mode 100644 index 0000000000..cd441e834a Binary files /dev/null and b/assets/images/help/organizations/security-and-analysis-highlight-ghas.png differ diff --git a/assets/images/help/organizations/select-selected-users-radio-button.png b/assets/images/help/organizations/select-selected-users-radio-button.png new file mode 100644 index 0000000000..c851dbdbb5 Binary files /dev/null and b/assets/images/help/organizations/select-selected-users-radio-button.png differ diff --git a/assets/images/help/package-registry/confirm-container-package-deletion.png b/assets/images/help/package-registry/confirm-container-package-deletion.png new file mode 100644 index 0000000000..ea1dcf4a50 Binary files /dev/null and b/assets/images/help/package-registry/confirm-container-package-deletion.png differ diff --git a/assets/images/help/package-registry/confirm-container-package-version-deletion.png b/assets/images/help/package-registry/confirm-container-package-version-deletion.png new file mode 100644 index 0000000000..164194ceda Binary files /dev/null and b/assets/images/help/package-registry/confirm-container-package-version-deletion.png differ diff --git a/assets/images/help/package-registry/delete-container-package-button.png b/assets/images/help/package-registry/delete-container-package-button.png new file mode 100644 index 0000000000..4e421abbee Binary files /dev/null and b/assets/images/help/package-registry/delete-container-package-button.png differ diff --git a/assets/images/help/package-registry/delete-container-package-version.png b/assets/images/help/package-registry/delete-container-package-version.png new file mode 100644 index 0000000000..2d21854495 Binary files /dev/null and b/assets/images/help/package-registry/delete-container-package-version.png differ diff --git a/assets/images/help/package-registry/delete-package-under-danger-zone.png b/assets/images/help/package-registry/delete-package-under-danger-zone.png new file mode 100644 index 0000000000..97f1f4a698 Binary files /dev/null and b/assets/images/help/package-registry/delete-package-under-danger-zone.png differ diff --git a/assets/images/help/package-registry/make-all-container-versions-visible.png b/assets/images/help/package-registry/make-all-container-versions-visible.png new file mode 100644 index 0000000000..265ac6216a Binary files /dev/null and b/assets/images/help/package-registry/make-all-container-versions-visible.png differ diff --git a/assets/images/help/package-registry/options-for-container-settings.png b/assets/images/help/package-registry/options-for-container-settings.png new file mode 100644 index 0000000000..de94379d54 Binary files /dev/null and b/assets/images/help/package-registry/options-for-container-settings.png differ diff --git a/assets/images/help/repository/choose-used-by-package.png b/assets/images/help/repository/choose-used-by-package.png new file mode 100644 index 0000000000..eb2cebb751 Binary files /dev/null and b/assets/images/help/repository/choose-used-by-package.png differ diff --git a/assets/images/help/repository/dependency-graph-enable-button.png b/assets/images/help/repository/dependency-graph-enable-button.png index 813b0ada5a..768617e607 100644 Binary files a/assets/images/help/repository/dependency-graph-enable-button.png and b/assets/images/help/repository/dependency-graph-enable-button.png differ diff --git a/assets/images/help/repository/enable-ghas-confirmation-dotcom.png b/assets/images/help/repository/enable-ghas-confirmation-dotcom.png new file mode 100644 index 0000000000..e220b74272 Binary files /dev/null and b/assets/images/help/repository/enable-ghas-confirmation-dotcom.png differ diff --git a/assets/images/help/repository/enable-ghas-dotcom.png b/assets/images/help/repository/enable-ghas-dotcom.png new file mode 100644 index 0000000000..1cd0df7494 Binary files /dev/null and b/assets/images/help/repository/enable-ghas-dotcom.png differ diff --git a/assets/images/help/repository/enable-secret-scanning-dotcom.png b/assets/images/help/repository/enable-secret-scanning-dotcom.png new file mode 100644 index 0000000000..66c7da0847 Binary files /dev/null and b/assets/images/help/repository/enable-secret-scanning-dotcom.png differ diff --git a/assets/images/help/repository/repo-change-confirm.png b/assets/images/help/repository/repo-change-confirm.png index 217d2362f4..8131fe667a 100644 Binary files a/assets/images/help/repository/repo-change-confirm.png and b/assets/images/help/repository/repo-change-confirm.png differ diff --git a/assets/images/help/repository/repo-change-select.png b/assets/images/help/repository/repo-change-select.png index 161f81e6e4..750ace9809 100644 Binary files a/assets/images/help/repository/repo-change-select.png and b/assets/images/help/repository/repo-change-select.png differ diff --git a/assets/images/help/repository/security-and-analysis-disable-or-enable-dotcom-private.png b/assets/images/help/repository/security-and-analysis-disable-or-enable-dotcom-private.png new file mode 100644 index 0000000000..3ec05be4d6 Binary files /dev/null and b/assets/images/help/repository/security-and-analysis-disable-or-enable-dotcom-private.png differ diff --git a/assets/images/help/repository/security-and-analysis-disable-or-enable-dotcom-public.png b/assets/images/help/repository/security-and-analysis-disable-or-enable-dotcom-public.png new file mode 100644 index 0000000000..8ee5919cb8 Binary files /dev/null and b/assets/images/help/repository/security-and-analysis-disable-or-enable-dotcom-public.png differ diff --git a/assets/images/help/repository/used-by-section.png b/assets/images/help/repository/used-by-section.png new file mode 100644 index 0000000000..2bc3efe084 Binary files /dev/null and b/assets/images/help/repository/used-by-section.png differ diff --git a/assets/images/help/settings/codespaces-access-and-security-radio-buttons.png b/assets/images/help/settings/codespaces-access-and-security-radio-buttons.png new file mode 100644 index 0000000000..490d595c80 Binary files /dev/null and b/assets/images/help/settings/codespaces-access-and-security-radio-buttons.png differ diff --git a/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png b/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png new file mode 100644 index 0000000000..32a44c2e45 Binary files /dev/null and b/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png differ diff --git a/assets/images/help/settings/codespaces-gpg-verification-radio-buttons.png b/assets/images/help/settings/codespaces-gpg-verification-radio-buttons.png new file mode 100644 index 0000000000..2968fec10f Binary files /dev/null and b/assets/images/help/settings/codespaces-gpg-verification-radio-buttons.png differ diff --git a/assets/images/help/settings/codespaces-gpg-verification-repository-drop-down.png b/assets/images/help/settings/codespaces-gpg-verification-repository-drop-down.png new file mode 100644 index 0000000000..5ef31929b4 Binary files /dev/null and b/assets/images/help/settings/codespaces-gpg-verification-repository-drop-down.png differ diff --git a/assets/images/help/settings/codespaces-new-secret-button.png b/assets/images/help/settings/codespaces-new-secret-button.png new file mode 100644 index 0000000000..591805192c Binary files /dev/null and b/assets/images/help/settings/codespaces-new-secret-button.png differ diff --git a/assets/images/help/settings/codespaces-secret-delete-button.png b/assets/images/help/settings/codespaces-secret-delete-button.png new file mode 100644 index 0000000000..33f75225c0 Binary files /dev/null and b/assets/images/help/settings/codespaces-secret-delete-button.png differ diff --git a/assets/images/help/settings/codespaces-secret-delete-warning.png b/assets/images/help/settings/codespaces-secret-delete-warning.png new file mode 100644 index 0000000000..89b8f555dc Binary files /dev/null and b/assets/images/help/settings/codespaces-secret-delete-warning.png differ diff --git a/assets/images/help/settings/codespaces-secret-name-field.png b/assets/images/help/settings/codespaces-secret-name-field.png new file mode 100644 index 0000000000..0d8d3f73fc Binary files /dev/null and b/assets/images/help/settings/codespaces-secret-name-field.png differ diff --git a/assets/images/help/settings/codespaces-secret-repository-access-drop-down.png b/assets/images/help/settings/codespaces-secret-repository-access-drop-down.png new file mode 100644 index 0000000000..14ab01e911 Binary files /dev/null and b/assets/images/help/settings/codespaces-secret-repository-access-drop-down.png differ diff --git a/assets/images/help/settings/codespaces-secret-repository-checkboxes.png b/assets/images/help/settings/codespaces-secret-repository-checkboxes.png new file mode 100644 index 0000000000..4982682ab0 Binary files /dev/null and b/assets/images/help/settings/codespaces-secret-repository-checkboxes.png differ diff --git a/assets/images/help/settings/codespaces-secret-update-button.png b/assets/images/help/settings/codespaces-secret-update-button.png new file mode 100644 index 0000000000..275888c195 Binary files /dev/null and b/assets/images/help/settings/codespaces-secret-update-button.png differ diff --git a/assets/images/help/settings/codespaces-secret-update-value-text.png b/assets/images/help/settings/codespaces-secret-update-value-text.png new file mode 100644 index 0000000000..ffc1c6113b Binary files /dev/null and b/assets/images/help/settings/codespaces-secret-update-value-text.png differ diff --git a/assets/images/help/settings/codespaces-secret-value-field.png b/assets/images/help/settings/codespaces-secret-value-field.png new file mode 100644 index 0000000000..637d352ac3 Binary files /dev/null and b/assets/images/help/settings/codespaces-secret-value-field.png differ diff --git a/assets/images/help/settings/codespaces-tab.png b/assets/images/help/settings/codespaces-tab.png new file mode 100644 index 0000000000..b83fed5ad6 Binary files /dev/null and b/assets/images/help/settings/codespaces-tab.png differ diff --git a/content/README.md b/content/README.md index 901427d4be..71f39c6f2f 100644 --- a/content/README.md +++ b/content/README.md @@ -20,6 +20,7 @@ See the [contributing docs](/CONTRIBUTING.md) for general information about work - [`showMiniToc`](#showminitoc) - [`miniTocMaxHeadingLevel`](#minitocmaxheadinglevel) - [`allowTitleToDifferFromFilename`](#allowtitletodifferfromfilename) + - [`defaultPlatform`](#defaultplatform) - [Escaping single quotes](#escaping-single-quotes) - [Autogenerated mini TOCs](#autogenerated-mini-tocs) - [Versioning](#versioning) @@ -172,6 +173,18 @@ featuredLinks: - Type: `Array`, items are objects `{ href: string, title: string, date: 'YYYY-MM-DD' }` - Optional. +### `defaultPlatform` + +- Purpose: Override the initial platform selection for a page. If this frontmatter is omitted, then the platform-specific content matching the reader's operating system is shown by default. This behavior can be changed for individual pages, for which a manual selection is more reasonable. For example, most GitHub Actions runners use Linux and their operating system is independent of the reader's operating system. +- Type: `String`, one of: `mac`, `windows`, `linux`. +- Optional. + +Example: + +```yaml +defaultPlatform: linux +``` + ### Escaping single quotes If you see two single quotes in a row (`''`) in YML frontmatter where you might expect to see one (`'`), this is the YML-preferred way to escape a single quote. From [the YAML spec](https://yaml.org/spec/history/2001-12-10.html): diff --git a/content/actions/creating-actions/metadata-syntax-for-github-actions.md b/content/actions/creating-actions/metadata-syntax-for-github-actions.md index 941135be54..d0c4b338f7 100644 --- a/content/actions/creating-actions/metadata-syntax-for-github-actions.md +++ b/content/actions/creating-actions/metadata-syntax-for-github-actions.md @@ -209,6 +209,8 @@ For example, this `cleanup.js` will only run on Linux-based runners: ##### `runs.steps[*].run` **Required** The command you want to run. This can be inline or a script in your action repository: + +{% raw %} ```yaml runs: using: "composite" @@ -216,6 +218,7 @@ runs: - run: ${{ github.action_path }}/test/script.sh shell: bash ``` +{% endraw %} Alternatively, you can use `$GITHUB_ACTION_PATH`: diff --git a/content/actions/guides/publishing-docker-images.md b/content/actions/guides/publishing-docker-images.md index 14ae4aea83..dab057d611 100644 --- a/content/actions/guides/publishing-docker-images.md +++ b/content/actions/guides/publishing-docker-images.md @@ -46,7 +46,7 @@ In this guide, we will use the Docker `build-push-action` action to build the Do In the example workflow below, we use the Docker `build-push-action` action to build the Docker image and, if the build succeeds, push the built image to Docker Hub. -To push to Docker Hub, you will need to have a Docker Hub account, and have a Docker Hub repository created. For more information, see "[Share images on Docker Hub](https://docs.docker.com/get-started/part3/)" in the Docker documentation. +To push to Docker Hub, you will need to have a Docker Hub account, and have a Docker Hub repository created. For more information, see "[Pushing a Docker container image to Docker Hub](https://docs.docker.com/docker-hub/repos/#pushing-a-docker-container-image-to-docker-hub)" in the Docker documentation. The `build-push-action` options required for Docker Hub are: diff --git a/content/actions/guides/publishing-nodejs-packages.md b/content/actions/guides/publishing-nodejs-packages.md index c6272bd7a8..361ba42f97 100644 --- a/content/actions/guides/publishing-nodejs-packages.md +++ b/content/actions/guides/publishing-nodejs-packages.md @@ -87,9 +87,28 @@ always-auth=true Each time you create a new release, you can trigger a workflow to publish your package. The workflow in the example below runs anytime the `release` event with type `created` occurs. The workflow publishes the package to {% data variables.product.prodname_registry %} if CI tests pass. -By default, {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the `name` field of the *package.json* file. For example, you would publish a package named `@my-org/test` to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. For more information, see [`npm-scope`](https://docs.npmjs.com/misc/scope) in the npm documentation. +#### Configuring the destination repository -To perform authenticated operations against the {% data variables.product.prodname_registry %} registry in your workflow, you can use the `GITHUB_TOKEN`. The `GITHUB_TOKEN` exists in your repository by default and has read and write permissions for packages in the repository where the workflow runs. For more information, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." +If you don't provide the `repository` key in your *package.json* file, then {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the `name` field of the *package.json* file. For example, a package named `@my-org/test` is published to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. + +However, if you do provide the `repository` key, then the repository in that key is used as the destination npm registry for {% data variables.product.prodname_registry %}. For example, publishing the below *package.json* results in a package named `my-amazing-package` published to the `octocat/my-other-repo` {% data variables.product.prodname_dotcom %} repository. + +```json +{ + "name": "@octocat/my-amazing-package", + "repository": { + "type": "git", + "url": "https://github.com/octocat/my-other-repo.git" + }, +``` + +#### Authenticating to the destination repository + +To authenticate to the {% data variables.product.prodname_registry %} registry in your workflow, you can use the `GITHUB_TOKEN` from your repository. It is created automatically and has _read_ and _write_ permissions for packages in the repository where the workflow runs. For more information, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow)." + +If you want to publish your package to a different repository, you must use a personal access token (PAT) that has permission to write to packages in the destination repository. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)" and "[Encrypted secrets](http://localhost:4000/en/free-pro-team@latest/actions/reference/encrypted-secrets)." + +#### Example workflow This example stores the `GITHUB_TOKEN` secret in the `NODE_AUTH_TOKEN` environment variable. When the `setup-node` action creates an *.npmrc* file, it references the token from the `NODE_AUTH_TOKEN` environment variable. diff --git a/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md b/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md index ad2f7553f4..2106948b11 100644 --- a/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md +++ b/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md @@ -6,6 +6,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' +defaultPlatform: linux --- {% data reusables.actions.enterprise-beta %} diff --git a/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md b/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md index d345f7018b..e29d2fe178 100644 --- a/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md @@ -8,6 +8,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' +defaultPlatform: linux --- {% data reusables.actions.enterprise-beta %} diff --git a/content/actions/learn-github-actions/finding-and-customizing-actions.md b/content/actions/learn-github-actions/finding-and-customizing-actions.md index 65f7193727..d8789d48fa 100644 --- a/content/actions/learn-github-actions/finding-and-customizing-actions.md +++ b/content/actions/learn-github-actions/finding-and-customizing-actions.md @@ -79,7 +79,7 @@ steps: #### Using branches -Referring to a specific branch means that the action will always use the latest updates on the target branch, but can create problems if those updates include breaking changes. This example targets a branch named `@main`: +Specifying a target branch for the action means it will always run the version currently on that branch. This approach can create problems if an update to the branch includes breaking changes. This example targets a branch named `@main`: ```yaml steps: diff --git a/content/actions/quickstart.md b/content/actions/quickstart.md index 812f317f03..5be4d372b2 100644 --- a/content/actions/quickstart.md +++ b/content/actions/quickstart.md @@ -123,7 +123,7 @@ Printing "Hello, World!" is a great way to explore the basic set up and syntax o {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %} -1. In the left sidebar, click the workfow you want to run. +1. In the left sidebar, click the workflow you want to run. ![Select say hello job](/assets/images/help/repository/say-hello-job.png) 1. On the right, click the **Run workflow** drop-down and click **Run workflow**. Optionally, you can enter a custom message into the "Person to greet" input before running the workflow. ![Trigger the manual workflow](/assets/images/help/repository/manual-workflow-trigger.png) diff --git a/content/actions/reference/encrypted-secrets.md b/content/actions/reference/encrypted-secrets.md index 7042534c0d..f7f502c99d 100644 --- a/content/actions/reference/encrypted-secrets.md +++ b/content/actions/reference/encrypted-secrets.md @@ -118,7 +118,7 @@ You can check which access policies are being applied to a secret in your organi ### Using encrypted secrets in a workflow -With the exception of `GITHUB_TOKEN`, secrets are not passed to the runner when a workflow is triggered from a forked repository. +{% data reusables.actions.forked-secrets %} To provide an action with a secret as an input or environment variable, you can use the `secrets` context to access secrets you've created in your repository. For more information, see "[Context and expression syntax for {% data variables.product.prodname_actions %}](/actions/reference/context-and-expression-syntax-for-github-actions)" and "[Workflow syntax for {% data variables.product.prodname_actions %}](/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions)." diff --git a/content/actions/reference/events-that-trigger-workflows.md b/content/actions/reference/events-that-trigger-workflows.md index fa52d38cb3..c77bceac85 100644 --- a/content/actions/reference/events-that-trigger-workflows.md +++ b/content/actions/reference/events-that-trigger-workflows.md @@ -530,12 +530,6 @@ on: types: [assigned, opened, synchronize, reopened] ``` -{% note %} - -**Note:** In order to protect public repositories from malicious users, all pull request workflows raised from repository forks run with a read-only token and no access to secrets. - -{% endnote %} - {% data reusables.developer-site.pull_request_forked_repos_link %} #### `pull_request_review` @@ -582,17 +576,11 @@ on: #### `pull_request_target` -{% warning %} - -**Warning:** The `pull_request_target` event is granted a read/write repository token and access to secrets, even from a fork. (The `pull_request` event does not grant read/write or secret access from a repository fork.) Do not check out and build or run untrusted code from pull request with this event. - -{% endwarning %} - -This event runs in the context of the base repository of the pull request, rather than in the merge commit as `pull_request` does. This is by design to prevent you from executing unsafe code that could alter your repository or steal any secrets you use in your workflow. For example, this event allows you to create workflows that label and comment on pull requests, based on the contents of the event payload. +This event runs in the context of the base of the pull request, rather than in the merge commit as the `pull_request` event does. This prevents executing unsafe workflow code from the head of the pull request that could alter your repository or steal any secrets you use in your workflow. This event allows you to do things like create workflows that label and comment on pull requests based on the contents of the event payload. {% warning %} -**Warning**: When using the `pull_request_target` event, be aware that it runs in the context of the base repository. This means that the `GITHUB_TOKEN` has write access to the repository, and the cache shares the same scope as the base branch. As a result, do not run untrusted code in the same context, as there is a risk that it may access sensitive information and unexpectedly manipulate the workflow environment. In addition, to help prevent cache poisoning, do not save the cache if there is a possibility that the cache contents were altered. +**Warning:** The `pull_request_target` event is granted a read/write repository token and can access secrets, even when it is triggered from a fork. Although the workflow runs in the context of the base of the pull request, you should make sure that you do not check out, build, or run untrusted code from the pull request with this event. Additionally, any caches share the same scope as the base branch, and to help prevent cache poisoning, you should not save the cache if there is a possibility that the cache contents were altered. {% endwarning %} @@ -605,7 +593,8 @@ By default, a workflow only runs when a `pull_request_target`'s activity type is For example, you can run a workflow when a pull request has been `assigned`, `opened`, `synchronize`, or `reopened`. ```yaml -on: pull_request_target +on: + pull_request_target: types: [assigned, opened, synchronize, reopened] ``` diff --git a/content/actions/reference/workflow-commands-for-github-actions.md b/content/actions/reference/workflow-commands-for-github-actions.md index 7c20f9df3a..a66233c2af 100644 --- a/content/actions/reference/workflow-commands-for-github-actions.md +++ b/content/actions/reference/workflow-commands-for-github-actions.md @@ -301,11 +301,13 @@ steps: `echo "{path}" >> $GITHUB_PATH` -Prepends a directory to the system `PATH` variable for all subsequent actions in the current job. The currently running action cannot access the new path variable. +Prepends a directory to the system `PATH` variable and makes it available to all subsequent actions in the current job; the currently running action cannot access the updated path variable. To see the currently defined paths for your job, you can use `echo "$PATH"` in a step or an action. #### Example +This example demonstrates how to add the user `$HOME/.local/bin` directory to `PATH`: + ``` bash -echo "/path/to/dir" >> $GITHUB_PATH +echo "$HOME/.local/bin" >> $GITHUB_PATH ``` {% endif %} diff --git a/content/actions/reference/workflow-syntax-for-github-actions.md b/content/actions/reference/workflow-syntax-for-github-actions.md index 96af71fa5e..6822c87b0b 100644 --- a/content/actions/reference/workflow-syntax-for-github-actions.md +++ b/content/actions/reference/workflow-syntax-for-github-actions.md @@ -1163,7 +1163,7 @@ You can use special characters in path, branch, and tag filters. - `**`: Matches zero or more of any character. - `?`: Matches zero or one single character. For example, `Octoc?t` matches `Octocat`. - `+`: Matches one or more of the preceding character. -- `[]` Matches one character listed in the brackets or included in ranges. Ranges can only include `a-z`, `A-Z`, and `0-9`. For example, the range`[0-9a-f]` matches any digits or lowercase letter. For example, `[CB]at` matches `Cat` or `Bat` and `[1-2]00` matches `100` and `200`. +- `[]` Matches one character listed in the brackets or included in ranges. Ranges can only include `a-z`, `A-Z`, and `0-9`. For example, the range`[0-9a-z]` matches any digit or lowercase letter. For example, `[CB]at` matches `Cat` or `Bat` and `[1-2]00` matches `100` and `200`. - `!`: At the start of a pattern makes it negate previous positive patterns. It has no special meaning if not the first character. The characters `*`, `[`, and `!` are special characters in YAML. If you start a pattern with `*`, `[`, or `!`, you must enclose the pattern in quotes. @@ -1183,14 +1183,14 @@ For more information about branch, tag, and path filter syntax, see "[`on.-`feature/your-branch` | -| `feature/**` | The `**` wildcard matches any character including slash (`/`) in branch and tag names. | -`feature/beta-a/my-branch`
-`feature/your-branch`
-`feature/mona/the/octocat` | -| -`main`
-`releases/mona-the-octcat` | Matches the exact name of a branch or tag name. | -`main`
-`releases/mona-the-octocat` | -| `'*'` | Matches all branch and tag names that don't contain a slash (`/`). The `*` character is a special character in YAML. When you start a pattern with `*`, you must use quotes. | -`main`
-`releases` | -| `'**'` | Matches all branch and tag names. This is the default behavior when you don't use a `branches` or `tags` filter. | -`all/the/branches`
-`every/tag` | -| `'*feature'` | The `*` character is a special character in YAML. When you start a pattern with `*`, you must use quotes. | -`mona-feature`
-`feature`
-`ver-10-feature` | -| `v2*` | Matches branch and tag names that start with `v2`. | -`v2`
-`v2.0`
-`v2.9` | -| `v[12].[0-9]+.[0-9]+` | Matches all semantic versioning tags with major version 1 or 2 | -`v1.10.1`
-`v2.0.0` | +| `feature/*` | The `*` wildcard matches any character, but does not match slash (`/`). | `feature/my-branch`

`feature/your-branch` | +| `feature/**` | The `**` wildcard matches any character including slash (`/`) in branch and tag names. | `feature/beta-a/my-branch`

`feature/your-branch`

`feature/mona/the/octocat` | +| `main`

`releases/mona-the-octcat` | Matches the exact name of a branch or tag name. | `main`

`releases/mona-the-octocat` | +| `'*'` | Matches all branch and tag names that don't contain a slash (`/`). The `*` character is a special character in YAML. When you start a pattern with `*`, you must use quotes. | `main`

`releases` | +| `'**'` | Matches all branch and tag names. This is the default behavior when you don't use a `branches` or `tags` filter. | `all/the/branches`

`every/tag` | +| `'*feature'` | The `*` character is a special character in YAML. When you start a pattern with `*`, you must use quotes. | `mona-feature`

`feature`

`ver-10-feature` | +| `v2*` | Matches branch and tag names that start with `v2`. | `v2`

`v2.0`

`v2.9` | +| `v[12].[0-9]+.[0-9]+` | Matches all semantic versioning tags with major version 1 or 2 | `v1.10.1`

`v2.0.0` | #### Patterns to match file paths @@ -1198,18 +1198,18 @@ Path patterns must match the whole path, and start from the repository's root. | Pattern | Description of matches | Example matches | |---------|------------------------|-----------------| -| `'*'` | The `*` wildcard matches any character, but does not match slash (`/`). The `*` character is a special character in YAML. When you start a pattern with `*`, you must use quotes. | -`README.md`
-`server.rb` | -| `'*.jsx?'` | The `?` character matches zero or one of the preceding character. | -`page.js`
-`page.jsx` | -| `'**'` | The `**` wildcard matches any character including slash (`/`). This is the default behavior when you don't use a `path` filter. | -`all/the/files.md` | -| `'*.js'` | The `*` wildcard matches any character, but does not match slash (`/`). Matches all `.js` files at the root of the repository. | -`app.js`
-`index.js` -| `'**.js'` | Matches all `.js` files in the repository. | -`index.js`
-`js/index.js`
-`src/js/app.js` | -| `docs/*` | All files within the root of the `docs` directory, at the root of the repository. | -`docs/README.md`
-`docs/file.txt` | -| `docs/**` | Any files in the `/docs` directory at the root of the repository. | -`docs/README.md`
-`docs/mona/octocat.txt` | -| `docs/**/*.md` | A file with a `.md` suffix anywhere in the `docs` directory. | -`docs/README.md`
-`docs/mona/hello-world.md`
-`docs/a/markdown/file.md` -| `'**/docs/**'` | Any files in a `docs` directory anywhere in the repository. | -`/docs/hello.md`
-`dir/docs/my-file.txt`
-`space/docs/plan/space.doc` -| `'**/README.md'` | A README.md file anywhere in the repository. | -`README.md`
-`js/README.md` -| `'**/*src/**'` | Any file in a folder with a `src` suffix anywhere in the repository. | -`a/src/app.js`
-`my-src/code/js/app.js` -| `'**/*-post.md'` | A file with the suffix `-post.md` anywhere in the repository. | -`my-post.md`
-`path/their-post.md` | -| `'**/migrate-*.sql'` | A file with the prefix `migrate-` and suffix `.sql` anywhere in the repository. | -`migrate-10909.sql`
-`db/migrate-v1.0.sql`
-`db/sept/migrate-v1.sql` | -| -`*.md`
-`!README.md` | Using an exclamation mark (`!`) in front of a pattern negates it. When a file matches a pattern and also matches a negative pattern defined later in the file, the file will not be included. | -`hello.md`
_Does not match_
-`README.md`
-`docs/hello.md` | -| -`*.md`
-`!README.md`
-`README*` | Patterns are checked sequentially. A pattern that negates a previous pattern will re-include file paths. | -`hello.md`
-`README.md`
-`README.doc`| +| `'*'` | The `*` wildcard matches any character, but does not match slash (`/`). The `*` character is a special character in YAML. When you start a pattern with `*`, you must use quotes. | `README.md`

`server.rb` | +| `'*.jsx?'` | The `?` character matches zero or one of the preceding character. | `page.js`

`page.jsx` | +| `'**'` | The `**` wildcard matches any character including slash (`/`). This is the default behavior when you don't use a `path` filter. | `all/the/files.md` | +| `'*.js'` | The `*` wildcard matches any character, but does not match slash (`/`). Matches all `.js` files at the root of the repository. | `app.js`

`index.js` +| `'**.js'` | Matches all `.js` files in the repository. | `index.js`

`js/index.js`

`src/js/app.js` | +| `docs/*` | All files within the root of the `docs` directory, at the root of the repository. | `docs/README.md`

`docs/file.txt` | +| `docs/**` | Any files in the `/docs` directory at the root of the repository. | `docs/README.md`

`docs/mona/octocat.txt` | +| `docs/**/*.md` | A file with a `.md` suffix anywhere in the `docs` directory. | `docs/README.md`

`docs/mona/hello-world.md`

`docs/a/markdown/file.md` +| `'**/docs/**'` | Any files in a `docs` directory anywhere in the repository. | `/docs/hello.md`

`dir/docs/my-file.txt`

`space/docs/plan/space.doc` +| `'**/README.md'` | A README.md file anywhere in the repository. | `README.md`

`js/README.md` +| `'**/*src/**'` | Any file in a folder with a `src` suffix anywhere in the repository. | `a/src/app.js`

`my-src/code/js/app.js` +| `'**/*-post.md'` | A file with the suffix `-post.md` anywhere in the repository. | `my-post.md`

`path/their-post.md` | +| `'**/migrate-*.sql'` | A file with the prefix `migrate-` and suffix `.sql` anywhere in the repository. | `migrate-10909.sql`

`db/migrate-v1.0.sql`

`db/sept/migrate-v1.sql` | +| `*.md`

`!README.md` | Using an exclamation mark (`!`) in front of a pattern negates it. When a file matches a pattern and also matches a negative pattern defined later in the file, the file will not be included. | `hello.md`

_Does not match_

`README.md`

`docs/hello.md` | +| `*.md`

`!README.md`

`README*` | Patterns are checked sequentially. A pattern that negates a previous pattern will re-include file paths. | `hello.md`

`README.md`

`README.doc`| diff --git a/content/admin/authentication/using-saml.md b/content/admin/authentication/using-saml.md index f6fe021b1b..9ce7104c78 100644 --- a/content/admin/authentication/using-saml.md +++ b/content/admin/authentication/using-saml.md @@ -46,7 +46,7 @@ A mapping is created between the `NameID` and the {% data variables.product.prod ### SAML metadata -Your {% data variables.product.prodname_ghe_server %} instances's service provider metadata is available at `http(s)://[hostname]/saml/metadata`. +Your {% data variables.product.prodname_ghe_server %} instance's service provider metadata is available at `http(s)://[hostname]/saml/metadata`. To configure your identity provider manually, the Assertion Consumer Service (ACS) URL is `http(s)://[hostname]/saml/consume`. It uses the `urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST` binding. diff --git a/content/admin/configuration/configuring-an-outbound-web-proxy-server.md b/content/admin/configuration/configuring-an-outbound-web-proxy-server.md index e2922e8b46..8a398553fa 100644 --- a/content/admin/configuration/configuring-an-outbound-web-proxy-server.md +++ b/content/admin/configuration/configuring-an-outbound-web-proxy-server.md @@ -21,6 +21,8 @@ When a proxy server is enabled for {% data variables.product.product_location %} {% data reusables.enterprise_management_console.privacy %} 4. Under **HTTP Proxy Server**, type the URL of your proxy server. ![Field to type the HTTP Proxy Server URL](/assets/images/enterprise/management-console/http-proxy-field.png) -5. Optionally, under **HTTP Proxy Exclusion**, type any hosts that do not require proxy access, separating hosts with commas. + +5. Optionally, under **HTTP Proxy Exclusion**, type any hosts that do not require proxy access, separating hosts with commas. To exclude all hosts in a domain from requiring proxy access, you can use `.` as a wildcard prefix. For example: `.octo-org.tentacle` ![Field to type any HTTP Proxy Exclusions](/assets/images/enterprise/management-console/http-proxy-exclusion-field.png) + {% data reusables.enterprise_management_console.save-settings %} diff --git a/content/admin/overview/about-enterprise-accounts.md b/content/admin/overview/about-enterprise-accounts.md index 26731d2fac..4c37b9eed5 100644 --- a/content/admin/overview/about-enterprise-accounts.md +++ b/content/admin/overview/about-enterprise-accounts.md @@ -18,7 +18,11 @@ An enterprise account allows you to manage multiple organizations{% if enterpris - Security {% if enterpriseServerVersions contains currentVersion %}(single sign-on, two factor authentication) - Requests {% if enterpriseServerVersions contains currentVersion %}and support bundle sharing {% endif %}with {% data variables.contact.enterprise_support %}{% endif %} -{% if enterpriseServerVersions contains currentVersion %}{% data reusables.enterprise-accounts.enterprise-accounts-billing %} For more information about managing your {% data variables.product.prodname_ghe_cloud %} subscription, see "[Viewing the subscription and usage for your enterprise account](/articles/viewing-the-subscription-and-usage-for-your-enterprise-account)." {% endif %}For more information about managing your {% data variables.product.product_name %} billing settings, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)." +{% if enterpriseServerVersions contains currentVersion %}{% data reusables.enterprise-accounts.enterprise-accounts-billing %} For more information about the management of your {% data variables.product.prodname_ghe_cloud %} subscription, see "[Viewing the subscription and usage for your enterprise account](/articles/viewing-the-subscription-and-usage-for-your-enterprise-account)." {% endif %}For more information about managing your {% data variables.product.product_name %} billing settings, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)." + +For more information about the management of users, organizations, data, and policies for {% data variables.product.product_location %}, see "[Managing users, organizations, and repositories](/admin/user-management)" and "[Setting policies for your enterprise](/admin/policies)." + +For more information about the management of enterprise accounts using the GraphQL API, see "[Enterprise accounts](/graphql/guides/managing-enterprise-accounts)." {% if enterpriseServerVersions contains currentVersion %} diff --git a/content/developers/apps/authorizing-oauth-apps.md b/content/developers/apps/authorizing-oauth-apps.md index dfb7888112..7312620fbe 100644 --- a/content/developers/apps/authorizing-oauth-apps.md +++ b/content/developers/apps/authorizing-oauth-apps.md @@ -74,8 +74,8 @@ Exchange this `code` for an access token: Name | Type | Description -----|------|-------------- -`client_id` | `string` | **Required.** The client ID you received from {% data variables.product.product_name %} for your {% data variables.product.prodname_github_app %}. -`client_secret` | `string` | **Required.** The client secret you received from {% data variables.product.product_name %} for your {% data variables.product.prodname_github_app %}. +`client_id` | `string` | **Required.** The client ID you received from {% data variables.product.product_name %} for your {% data variables.product.prodname_oauth_app %}. +`client_secret` | `string` | **Required.** The client secret you received from {% data variables.product.product_name %} for your {% data variables.product.prodname_oauth_app %}. `code` | `string` | **Required.** The code you received as a response to Step 1. `redirect_uri` | `string` | The URL in your application where users are sent after authorization. `state` | `string` | The unguessable random string you provided in Step 1. diff --git a/content/developers/apps/differences-between-github-apps-and-oauth-apps.md b/content/developers/apps/differences-between-github-apps-and-oauth-apps.md index 88fd418cd5..091642a8f7 100644 --- a/content/developers/apps/differences-between-github-apps-and-oauth-apps.md +++ b/content/developers/apps/differences-between-github-apps-and-oauth-apps.md @@ -85,7 +85,7 @@ Unlike OAuth apps, GitHub Apps have targeted permissions that allow them to requ | GitHub Apps | OAuth Apps | | ----- | ----------- | -| By default, GitHub Apps have a single webhook that receives the events they are configured to receive for every repository they have access to. | OAuth Apps request the webhook scope to create a repository webhook for each repository they needs to receive events from. | +| By default, GitHub Apps have a single webhook that receives the events they are configured to receive for every repository they have access to. | OAuth Apps request the webhook scope to create a repository webhook for each repository they need to receive events from. | | GitHub Apps receive certain organization-level events with the organization member's permission. | OAuth Apps request the organization webhook scope to create an organization webhook for each organization they need to receive organization-level events from. | ### Git access diff --git a/content/developers/github-marketplace/receiving-payment-for-app-purchases.md b/content/developers/github-marketplace/receiving-payment-for-app-purchases.md index 3c8a760f58..0264e77e2e 100644 --- a/content/developers/github-marketplace/receiving-payment-for-app-purchases.md +++ b/content/developers/github-marketplace/receiving-payment-for-app-purchases.md @@ -13,8 +13,14 @@ versions: -After your {% data variables.product.prodname_marketplace %} listing is created and approved, you'll provide payment details to {% data variables.product.product_name %} as part of the onboarding process. +After your {% data variables.product.prodname_marketplace %} listing for an app with a paid plan is created and approved, you'll provide payment details to {% data variables.product.product_name %} as part of the financial onboarding process. -Once your revenue reaches a minimum of $500 U.S. Dollars for the month, you'll receive an electronic payment from {% data variables.product.product_name %} for 75% of the sales price. +Once your revenue reaches a minimum of $500 US dollars for the month, you'll receive an electronic payment from {% data variables.product.company_short %}. This will be the income from marketplace transactions minus the amount charged by {% data variables.product.company_short %} to cover their running costs. -{% data reusables.apps.marketplace_revenue_share %} +For transactions made before January 1, 2021, {% data variables.product.company_short %} retains 25% of transaction income. For transactions made after that date, only 5% is retained by {% data variables.product.company_short %}. This change will be reflected in payments received from the end of January 2021 onward. + +{% note %} + +**Note:** For details of the current pricing and payment terms, see "[{% data variables.product.prodname_marketplace %} developer agreement](/github/site-policy/github-marketplace-developer-agreement)." + +{% endnote %} diff --git a/content/developers/github-marketplace/viewing-transactions-for-your-listing.md b/content/developers/github-marketplace/viewing-transactions-for-your-listing.md index 9f477e0005..b0c801eaa0 100644 --- a/content/developers/github-marketplace/viewing-transactions-for-your-listing.md +++ b/content/developers/github-marketplace/viewing-transactions-for-your-listing.md @@ -1,6 +1,6 @@ --- title: Viewing transactions for your listing -intro: 'The {% data variables.product.prodname_marketplace %} transactions page allows you to download and view all transactions for your {% data variables.product.prodname_marketplace %} listing. You can view transations for the past day (24 hours), week, month, or for the entire duration of time that your {% data variables.product.prodname_github_app %} has been listed.' +intro: 'The {% data variables.product.prodname_marketplace %} transactions page allows you to download and view all transactions for your {% data variables.product.prodname_marketplace %} listing. You can view transactions for the past day (24 hours), week, month, or for the entire duration of time that your {% data variables.product.prodname_github_app %} has been listed.' redirect_from: - /marketplace/github-marketplace-transactions versions: diff --git a/content/education/manage-coursework-with-github-classroom/leave-feedback-with-pull-requests.md b/content/education/manage-coursework-with-github-classroom/leave-feedback-with-pull-requests.md index abf11843b4..fd9e915f83 100644 --- a/content/education/manage-coursework-with-github-classroom/leave-feedback-with-pull-requests.md +++ b/content/education/manage-coursework-with-github-classroom/leave-feedback-with-pull-requests.md @@ -30,4 +30,4 @@ To create and access the feedback pull request, you must enable the feedback pul ### Further reading -- "[Integrate {% data variables.product.prodname_classroom %} with an IDE](http://localhost:4000/en/free-pro-team@latest/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide)" +- "[Integrate {% data variables.product.prodname_classroom %} with an IDE](/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide)" diff --git a/content/education/manage-coursework-with-github-classroom/manage-classrooms.md b/content/education/manage-coursework-with-github-classroom/manage-classrooms.md index b4b129c006..5580bb4b01 100644 --- a/content/education/manage-coursework-with-github-classroom/manage-classrooms.md +++ b/content/education/manage-coursework-with-github-classroom/manage-classrooms.md @@ -116,6 +116,6 @@ You can archive a classroom that you no longer use on {% data variables.product. !["Delete repository" button](/assets/images/help/classroom/click-delete-classroom-button.png) 1. **Read the warnings**. 1. To verify that you're deleting the correct classroom, type the name of the classroom you want to delete. - ![Modal for deleting a classrom with warnings and text field for classroom name](/assets/images/help/classroom/delete-classroom-modal-with-warning.png) + ![Modal for deleting a classroom with warnings and text field for classroom name](/assets/images/help/classroom/delete-classroom-modal-with-warning.png) 1. Click **Delete classroom**. !["Delete classroom" button](/assets/images/help/classroom/delete-classroom-click-delete-classroom-button.png) diff --git a/content/github/administering-a-repository/configuring-secret-scanning-for-private-repositories.md b/content/github/administering-a-repository/configuring-secret-scanning-for-your-repositories.md similarity index 55% rename from content/github/administering-a-repository/configuring-secret-scanning-for-private-repositories.md rename to content/github/administering-a-repository/configuring-secret-scanning-for-your-repositories.md index 085767d24e..25f7892409 100644 --- a/content/github/administering-a-repository/configuring-secret-scanning-for-private-repositories.md +++ b/content/github/administering-a-repository/configuring-secret-scanning-for-your-repositories.md @@ -1,8 +1,10 @@ --- -title: Configuring secret scanning for private repositories +title: Configuring secret scanning for your repositories intro: 'You can configure how {% data variables.product.product_name %} scans your private repositories for secrets.' -product: '{% data reusables.gated-features.secret-scanning %}' permissions: 'People with admin permissions to a private repository can enable {% data variables.product.prodname_secret_scanning %} for the repository.' +redirect_from: + - /github/administering-a-repository/configuring-secret-scanning-for-private-repositories +product: '{% data reusables.gated-features.secret-scanning %}' versions: free-pro-team: '*' --- @@ -14,8 +16,19 @@ versions: {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-security-and-analysis %} -4. To the right of "Secret scanning", click **Enable**. -![Enable secret scanning for your repository](/assets/images/help/repository/enable-secret-scanning.png) + +{% if currentVersion == "free-pro-team@latest" %} +4. If "{% data variables.product.prodname_secret_scanning_caps %}" is not shown on the page, you need to enable {% data variables.product.prodname_GH_advanced_security %} first. To the right of "{% data variables.product.prodname_GH_advanced_security %}", click **Enable**. + ![Enable {% data variables.product.prodname_GH_advanced_security %} for your repository](/assets/images/help/repository/enable-ghas-dotcom.png) +5. Click **Enable {% data variables.product.prodname_GH_advanced_security %} for this repository** to confirm the action. + ![Confirm enabling {% data variables.product.prodname_GH_advanced_security %} for your repository](/assets/images/help/repository/enable-ghas-confirmation-dotcom.png) +6. When you enable {% data variables.product.prodname_GH_advanced_security %} this may automatically enable {% data variables.product.prodname_secret_scanning %} for the repository (this is controlled by the organization configuration). If "{% data variables.product.prodname_secret_scanning_caps %}" is shown with an **Enable** button, you still need to enable {% data variables.product.prodname_secret_scanning %} by clicking **Enable**. If you see a **Disable** button, {% data variables.product.prodname_secret_scanning %} is already enabled. + ![Enable {% data variables.product.prodname_secret_scanning %} for your repository](/assets/images/help/repository/enable-secret-scanning-dotcom.png){% endif %} + + {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} +4. To the right of "{% data variables.product.prodname_secret_scanning_caps %}", click **Enable**. + ![Enable {% data variables.product.prodname_secret_scanning %} for your repository](/assets/images/help/repository/enable-secret-scanning-ghe.png) + {% endif %} ### Excluding alerts from {% data variables.product.prodname_secret_scanning %} in private repositories diff --git a/content/github/administering-a-repository/index.md b/content/github/administering-a-repository/index.md index 1f27602bae..48a96e6206 100644 --- a/content/github/administering-a-repository/index.md +++ b/content/github/administering-a-repository/index.md @@ -66,7 +66,7 @@ versions: {% topic_link_in_list /securing-your-repository %} {% link_in_list /about-securing-your-repository %} {% link_in_list /about-secret-scanning %} - {% link_in_list /configuring-secret-scanning-for-private-repositories %} + {% link_in_list /configuring-secret-scanning-for-your-repositories %} {% link_in_list /managing-alerts-from-secret-scanning %} {% link_in_list /managing-security-and-analysis-settings-for-your-repository %} {% topic_link_in_list /keeping-your-dependencies-updated-automatically %} diff --git a/content/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository.md b/content/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository.md index c43877ac01..8cf3c3baed 100644 --- a/content/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository.md +++ b/content/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository.md @@ -11,17 +11,33 @@ versions: free-pro-team: '*' --- -### Enabling or disabling security and analysis features +{% if currentVersion == "free-pro-team@latest" %} +### Enabling or disabling security and analysis features for public repositories -{% data reusables.security.some-security-and-analysis-features-are-enabled-by-default %} +You can manage a subset of security and analysis features for public repositories. Other features are permanently enabled, including dependency graph and secret scanning. + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-settings %} +{% data reusables.repositories.navigate-to-security-and-analysis %} +4. Under "Configure security and analysis features", to the right of the feature, click **Disable** or **Enable**. + !["Enable" or "Disable" button for "Configure security and analysis" features in a public repository](/assets/images/help/repository/security-and-analysis-disable-or-enable-dotcom-public.png) +{% endif %} + +### Enabling or disabling security and analysis features{% if currentVersion == "free-pro-team@latest" %} for private repositories{% endif %} + +You can manage the security and analysis features for your {% if currentVersion == "free-pro-team@latest" %}private or internal {% endif %}repository. If your organization or enterprise has a license for {% data variables.product.prodname_GH_advanced_security %} then extra options are available. {% data reusables.advanced-security.more-info-ghas %} {% data reusables.security.security-and-analysis-features-enable-read-only %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-security-and-analysis %} -4. Under "Configure security and analysis features", to the right of the feature, click **Disable** or **Enable**. - !["Enable" or "Disable" button for "Configure security and analysis" features](/assets/images/help/repository/security-and-analysis-disable-or-enable.png) +4. Under "Configure security and analysis features", to the right of the feature, click **Disable** or **Enable**. {% if currentVersion == "free-pro-team@latest" %}If "{% data variables.product.prodname_secret_scanning_caps %}" is not displayed, you may need to enable {% data variables.product.prodname_GH_advanced_security %} first. + !["Enable" or "Disable" button for "Configure security and analysis" features](/assets/images/help/repository/security-and-analysis-disable-or-enable-dotcom-private.png) + {% endif %} + {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} + !["Enable" or "Disable" button for "Configure security and analysis" features](/assets/images/help/repository/security-and-analysis-disable-or-enable-ghe.png) + {% endif %} ### Granting access to security alerts diff --git a/content/github/administering-a-repository/setting-repository-visibility.md b/content/github/administering-a-repository/setting-repository-visibility.md index 0f422c3aff..7fd8db9d0c 100644 --- a/content/github/administering-a-repository/setting-repository-visibility.md +++ b/content/github/administering-a-repository/setting-repository-visibility.md @@ -24,7 +24,8 @@ We recommend reviewing the following caveats before you change the visibility of * If you change a repository's visibility from internal to private, {% data variables.product.prodname_dotcom %} will remove forks that belong to any user without access to the newly private repository. {% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %}The visibility of any forks will also change to private.{% elsif currentVersion == "github-ae@latest" %}If the internal repository has any forks, the visibility of the forks is already private.{% endif %} For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility)"{% if currentVersion == "free-pro-team@latest" %} * If you're using {% data variables.product.prodname_free_user %} for user accounts or organizations, some features won't be available in the repository after you change the visibility to private. {% data reusables.gated-features.more-info %}{% endif %} * Any published {% data variables.product.prodname_pages %} site will be automatically unpublished.{% if currentVersion == "free-pro-team@latest" %} If you added a custom domain to the {% data variables.product.prodname_pages %} site, you should remove or update your DNS records before making the repository private, to avoid the risk of a domain takeover. For more information, see "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)."{% endif %}{% if currentVersion == "free-pro-team@latest" %} -* {% data variables.product.prodname_dotcom %} will no longer included the repository in the {% data variables.product.prodname_archive %}. For more information, see "[About archiving content and data on {% data variables.product.prodname_dotcom %}](/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github#about-the-github-archive-program)."{% endif %}{% if enterpriseServerVersions contains currentVersion %} +* {% data variables.product.prodname_dotcom %} will no longer include the repository in the {% data variables.product.prodname_archive %}. For more information, see "[About archiving content and data on {% data variables.product.prodname_dotcom %}](/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github#about-the-github-archive-program)."{% endif %}{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} +* {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %}, will stop working unless the repository is owned by an organization that has a license for {% data variables.product.prodname_advanced_security %}. {% data reusables.advanced-security.more-info-ghas %}{% endif %}{% if enterpriseServerVersions contains currentVersion %} * Anonymous Git read access is no longer available. For more information, see "[Enabling anonymous Git read access for a repository](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)."{% endif %} {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} @@ -46,7 +47,10 @@ We recommend reviewing the following caveats before you change the visibility of #### Making a repository public * {% data variables.product.product_name %} will detach private forks and turn them into a standalone private repository. For more information, see "[What happens to forks when a repository is deleted or changes visibility?](/articles/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility#changing-a-private-repository-to-a-public-repository)"{% if currentVersion == "free-pro-team@latest" %} -* If you're converting your private repository to a public repository as part of a move toward creating an open source project, see the [Open Source Guides](http://opensource.guide) for helpful tips and guidelines. You can also take a free course on managing an open source project with [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}). Once your repository is public, you can also view your repository's community profile to see whether your project meets best practices for supporting contributors. For more information, see "[Viewing your community profile](/articles/viewing-your-community-profile)."{% endif %} +* If you're converting your private repository to a public repository as part of a move toward creating an open source project, see the [Open Source Guides](http://opensource.guide) for helpful tips and guidelines. You can also take a free course on managing an open source project with [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}). Once your repository is public, you can also view your repository's community profile to see whether your project meets best practices for supporting contributors. For more information, see "[Viewing your community profile](/articles/viewing-your-community-profile)." +* The repository will automatically gain access to {% data variables.product.prodname_GH_advanced_security %} features. + +For information about improving repository security, see "[About securing your repository](/github/administering-a-repository/about-securing-your-repository)."{% endif %} {% endif %} @@ -59,7 +63,7 @@ We recommend reviewing the following caveats before you change the visibility of 3. Under "Danger Zone", to the right of to "Change repository visibility", click **Change visibility**. ![Change visibility button](/assets/images/help/repository/repo-change-vis.png) 4. Select a visibility. - ![Dialog of options for repository visibility](/assets/images/help/repository/repo-change-select.png) + ![Dialog of options for repository visibility](/assets/images/help/repository/repo-change-select.png) 5. To verify that you're changing the correct repository's visibility, type the name of the repository you want to change the visibility of. 6. Click **I understand, change repository visibility**. ![Confirm change of repository visibility button](/assets/images/help/repository/repo-change-confirm.png) diff --git a/content/github/authenticating-to-github/about-commit-signature-verification.md b/content/github/authenticating-to-github/about-commit-signature-verification.md index 164e847748..4dad3a5919 100644 --- a/content/github/authenticating-to-github/about-commit-signature-verification.md +++ b/content/github/authenticating-to-github/about-commit-signature-verification.md @@ -23,7 +23,9 @@ Repository administrators can enforce required commit signing on a branch to blo You can check the verification status of your signed commits or tags on {% data variables.product.product_name %} and view why your commit signatures might be unverified. For more information, see "[Checking your commit and tag signature verification status](/articles/checking-your-commit-and-tag-signature-verification-status)." -{% if currentVersion == "free-pro-team@latest" %} {% data variables.product.product_name %} will automatically use GPG to sign commits you make using the {% data variables.product.product_name %} web interface, except for when you squash and merge a pull request that you are not the author of. Commits signed by {% data variables.product.product_name %} will have a verified status on {% data variables.product.product_name %}. You can verify the signature locally using the public key available at https://github.com/web-flow.gpg.{% endif %} +{% if currentVersion == "free-pro-team@latest" %} +{% data variables.product.product_name %} will automatically use GPG to sign commits you make using the {% data variables.product.product_name %} web interface, except for when you squash and merge a pull request that you are not the author of. You can optionally choose to have {% data variables.product.product_name %} sign commits you make in {% data variables.product.prodname_codespaces %}. Commits signed by {% data variables.product.product_name %} will have a verified status on {% data variables.product.product_name %}. You can verify the signature locally using the public key available at https://github.com/web-flow.gpg. For more information about enabling GPG verification for your codespaces, see "[Managing GPG verification for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)." +{% endif %} ### GPG commit signature verification diff --git a/content/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md b/content/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md index 5b7ea22b34..020d609a12 100644 --- a/content/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md +++ b/content/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md @@ -127,7 +127,7 @@ Before adding a new SSH key to the ssh-agent to manage your keys, you should hav 1. Ensure the ssh-agent is running. You can use the "Auto-launching the ssh-agent" instructions in "[Working with SSH key passphrases](/articles/working-with-ssh-key-passphrases)", or start it manually: ```shell # start the ssh-agent in the background - $ eval $(ssh-agent -s) + $ eval `ssh-agent -s` > Agent pid 59566 ``` diff --git a/content/github/authenticating-to-github/reviewing-your-security-log.md b/content/github/authenticating-to-github/reviewing-your-security-log.md index 7882fef915..ba5efe3de9 100644 --- a/content/github/authenticating-to-github/reviewing-your-security-log.md +++ b/content/github/authenticating-to-github/reviewing-your-security-log.md @@ -42,6 +42,7 @@ The events listed in your security log are triggered by your actions. Actions ar |------------------|-------------------{% if currentVersion == "free-pro-team@latest" %} | [`account_recovery_token`](#account_recovery_token-category-actions) | Contains all activities related to [adding a recovery token](/articles/configuring-two-factor-authentication-recovery-methods). | [`billing`](#billing-category-actions) | Contains all activities related to your billing information. +| [`codespaces`](#codespaces-category-actions) | Contains all activities related to {% data variables.product.prodname_codespaces %}. For more information, see "[About {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-codespaces)." | [`marketplace_agreement_signature`](#marketplace_agreement_signature-category-actions) | Contains all activities related to signing the {% data variables.product.prodname_marketplace %} Developer Agreement. | [`marketplace_listing`](#marketplace_listing-category-actions) | Contains all activities related to listing apps in {% data variables.product.prodname_marketplace %}.{% endif %} | [`oauth_access`](#oauth_access-category-actions) | Contains all activities related to [{% data variables.product.prodname_oauth_app %}s](/articles/authorizing-oauth-apps) you've connected with.{% if currentVersion == "free-pro-team@latest" %} @@ -85,6 +86,12 @@ An overview of some of the most common actions that are recorded as events in th | `change_billing_type` | Triggered when you [change how you pay](/articles/adding-or-editing-a-payment-method) for {% data variables.product.prodname_dotcom %}. | `change_email` | Triggered when you [change your email address](/articles/changing-your-primary-email-address). +#### `codespaces` category actions + +| Action | Description +|------------------|------------------- +| `trusted_repositories_access_update` | Triggered when you change your user account's [access and security setting for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces). + #### `marketplace_agreement_signature` category actions | Action | Description @@ -232,7 +239,9 @@ An overview of some of the most common actions that are recorded as events in th | Action | Description |--------------------|--------------------- -| `add_email` | Triggered when you {% if currentVersion != "github-ae@latest" %}[add a new email address](/articles/changing-your-primary-email-address){% else %}add a new email address{% endif %}. +| `add_email` | Triggered when you {% if currentVersion != "github-ae@latest" %}[add a new email address](/articles/changing-your-primary-email-address){% else %}add a new email address{% endif %}.{% if currentVersion == "free-pro-team@latest" %} +| `codespaces_trusted_repo_access_granted` | Triggered when you [allow the codespaces you create for a repository to access other repositories owned by your user account](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces. +| `codespaces_trusted_repo_access_revoked` | Triggered when you [disallow the codespaces you create for a repository to access other repositories owned by your user account](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces. {% endif %} | `create` | Triggered when you create a new user account.{% if currentVersion != "github-ae@latest" %} | `change_password` | Triggered when you change your password. | `forgot_password` | Triggered when you ask for [a password reset](/articles/how-can-i-reset-my-password).{% endif %} @@ -252,4 +261,3 @@ An overview of some of the most common actions that are recorded as events in th | `update` | Triggered when you set or change the status on your profile. For more information, see "[Setting a status](/articles/personalizing-your-profile/#setting-a-status)." | `destroy` | Triggered when you clear the status on your profile. - diff --git a/content/github/authenticating-to-github/testing-your-ssh-connection.md b/content/github/authenticating-to-github/testing-your-ssh-connection.md index 12b3e26732..1413718434 100644 --- a/content/github/authenticating-to-github/testing-your-ssh-connection.md +++ b/content/github/authenticating-to-github/testing-your-ssh-connection.md @@ -31,7 +31,7 @@ When you test your connection, you'll need to authenticate this action using you > Are you sure you want to continue connecting (yes/no)? ``` -3. Verify that the fingerprint in the message you see matches one of the messages in step 2, then type `yes`: +3. Verify that the fingerprint in the message you see matches {% if currentVersion == "free-pro-team@latest" %}[{% data variables.product.prodname_dotcom %}'s RSA public key fingerprint](/github/authenticating-to-github/githubs-ssh-key-fingerprints){% else %} your enterprise's public key fingerprint{% endif %}. If it does, then type `yes`: ```shell > Hi username! You've successfully authenticated, but GitHub does not > provide shell access. diff --git a/content/github/building-a-strong-community/adding-a-code-of-conduct-to-your-project.md b/content/github/building-a-strong-community/adding-a-code-of-conduct-to-your-project.md index c9e7c43908..aa7d99e071 100644 --- a/content/github/building-a-strong-community/adding-a-code-of-conduct-to-your-project.md +++ b/content/github/building-a-strong-community/adding-a-code-of-conduct-to-your-project.md @@ -47,7 +47,7 @@ If the code of conduct you want to use isn't available in the provided templates ![New code of conduct file name](/assets/images/help/repository/new-code-of-conduct-file-name.png) - To make your code of conduct visible in the repository's root directory, type *CODE_OF_CONDUCT* in the file name field. - To make your code of conduct visible in the repository's `docs` directory, type *docs/CODE_OF_CONDUCT*. - - To make your code of conduct visible in the respository's `.github` directory, type *.github/CODE_OF_CONDUCT*. + - To make your code of conduct visible in the repository's `.github` directory, type *.github/CODE_OF_CONDUCT*. 4. In the new file, add your custom code of conduct. {% data reusables.files.write_commit_message %} {% data reusables.files.choose_commit_branch %} diff --git a/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork.md b/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork.md index 273d30d6a3..0aebcf7f57 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork.md +++ b/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork.md @@ -3,7 +3,7 @@ title: Creating a pull request from a fork intro: You can create a pull request to propose changes you've made to a fork of an upstream repository. redirect_from: - /articles/creating-a-pull-request-from-a-fork -permissions: Anyone with write access to a repository can create a pull request from user-owned fork. +permissions: Anyone with write access to a repository can create a pull request from a user-owned fork. versions: free-pro-team: '*' enterprise-server: '*' diff --git a/content/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request.md index 364fc8048c..2f68164e62 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request.md @@ -36,7 +36,7 @@ Dependency review supports the same languages and package management ecosystems ![The file filter menu](/assets/images/help/pull_requests/file-filter-menu-json.png) -1. On the right of the header for a manifest or lock file, display the dependency review by clicking the rich diff button. +1. On the right of the header for a manifest or lock file, display the dependency review by clicking the **{% octicon "file" aria-label="The rich diff icon" %}** rich diff button. ![The rich diff button](/assets/images/help/pull_requests/dependency-review-rich-diff.png) @@ -69,6 +69,4 @@ Dependency review supports the same languages and package management ecosystems * The severity of the vulnerability. * The version of the dependency in which the vulnerability was fixed. If you are reviewing a pull request for someone, you might ask the contributor to update the dependency to the patched version, or a later release. -1. You can return to the original view of the file by clicking the source diff button. - - ![The source diff button](/assets/images/help/pull_requests/dependency-review-source-diff.png) +{% data reusables.repositories.return-to-source-diff %} diff --git a/content/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request.md index 883e41571f..577bdf67dc 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request.md @@ -37,9 +37,11 @@ If the pull request contains changes to dependencies you can use the dependency {% data reusables.repositories.changed-files %} -1. On the right of the header for a manifest or lock file, display the dependency review by clicking the rich diff button. +1. On the right of the header for a manifest or lock file, display the dependency review by clicking the **{% octicon "file" aria-label="The rich diff icon" %}** rich diff button. ![The rich diff button](/assets/images/help/pull_requests/dependency-review-rich-diff.png) + +{% data reusables.repositories.return-to-source-diff %} {% endif %} ### Marking a file as viewed diff --git a/content/github/developing-online-with-codespaces/about-codespaces.md b/content/github/developing-online-with-codespaces/about-codespaces.md index 6c0e0d29f1..2413aeac6d 100644 --- a/content/github/developing-online-with-codespaces/about-codespaces.md +++ b/content/github/developing-online-with-codespaces/about-codespaces.md @@ -38,6 +38,8 @@ Each developer can create one or more codespace for any public repository, or fo {% data reusables.codespaces.about-personalization %} For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account)." +You can configure settings to add encrypted secrets, enable GPG verification, and allow codespaces to access other repositories. For more information, see "[Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces)", "[Managing GPG verification for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)", and "[Managing access and security for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces)." + {% data reusables.codespaces.you-can-see-all-your-codespaces %} {% data reusables.codespaces.beta-functionality-limited %} diff --git a/content/github/developing-online-with-codespaces/index.md b/content/github/developing-online-with-codespaces/index.md index d53f3e92fb..1ec4ada121 100644 --- a/content/github/developing-online-with-codespaces/index.md +++ b/content/github/developing-online-with-codespaces/index.md @@ -19,6 +19,9 @@ versions: {% link_in_list /creating-a-codespace %} {% link_in_list /developing-in-a-codespace %} {% link_in_list /personalizing-codespaces-for-your-account %} +{% link_in_list /managing-encrypted-secrets-for-codespaces %} +{% link_in_list /managing-access-and-security-for-codespaces %} +{% link_in_list /managing-gpg-verification-for-codespaces %} {% link_in_list /deleting-a-codespace %} {% link_in_list /troubleshooting-your-codespace %} {% link_in_list /using-codespaces-in-visual-studio-code %} diff --git a/content/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces.md b/content/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces.md new file mode 100644 index 0000000000..a364ad3050 --- /dev/null +++ b/content/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces.md @@ -0,0 +1,41 @@ +--- +title: Managing access and security for Codespaces +intro: You can manage the repositories that codespaces can access. +product: '{% data reusables.gated-features.codespaces %}' +versions: + free-pro-team: '*' +--- + +{% note %} + +**Note:** Access and security for {% data variables.product.prodname_codespaces %} is currently in beta and subject to change. + +{% endnote %} + +### Managing security and access for your user account + +When you enable access and security for a repository owned by your user account, any codespaces you create for that repository will have read and write permissions to all other repositories you own. You can enable access and security for none of your repositories, all of your repositories, or specific repositories. You should only enable access and security for repositories you trust. + +{% data reusables.user_settings.access_settings %} +{% data reusables.user_settings.codespaces-tab %} +1. Under "Access and security", select the setting you want for your user account. + ![Radio buttons to manage trusted repositories](/assets/images/help/settings/codespaces-access-and-security-radio-buttons.png) +1. If you chose "Selected repositories", select the drop-down menu, then click a repository to allow the repository's codespaces to access other repositories you own. Repeat for all repositories whose codespaces you want to access other repositories you own. + !["Selected repositories" drop-down menu](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) + +### Managing security and access for your organization + +Organization owners can manage security and access for {% data variables.product.prodname_codespaces %}. + +When you enable access and security for a repository owned by your organization, any codespaces that are created for that repository will have read and write permissions to all other repositories the organization owns. You can enable access and security for none of your organization's repositories, all of your organization's repositories, or specific repositories. You should only enable access and security for repositories you trust. + +{% data reusables.profile.access_profile %} +{% data reusables.profile.access_org %} +{% data reusables.organizations.org_settings %} +{% data reusables.organizations.click-codespaces %} +5. To approve of the [pre-release program terms of service](/github/site-policy/github-pre-release-program) on behalf of your organization and enable {% data variables.product.prodname_codespaces %}, under "User permissions", select **Selected users**, then type the username for each person to grant access to. Repeat for all users who you want to have access to your organization's codespaces. + ![Radio button for "Selected users"](/assets/images/help/organizations/select-selected-users-radio-button.png) +1. Under "Access and security", select the setting you want for your organization. + ![Radio buttons to manage trusted repositories](/assets/images/help/settings/codespaces-access-and-security-radio-buttons.png) +1. If you chose "Selected repositories", select the drop-down menu, then click a repository to allow the repository's codespaces to access other repositories owned by your organization. Repeat for all repositories whose codespaces you want to access other repositories. + !["Selected repositories" drop-down menu](/assets/images/help/settings/codespaces-access-and-security-repository-drop-down.png) diff --git a/content/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces.md b/content/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces.md new file mode 100644 index 0000000000..82ab059334 --- /dev/null +++ b/content/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces.md @@ -0,0 +1,60 @@ +--- +title: Managing encrypted secrets for Codespaces +intro: You can store sensitive information, like tokens, that you want to access in your codespaces via environment variables. +product: '{% data reusables.gated-features.codespaces %}' +versions: + free-pro-team: '*' +--- + +{% note %} + +**Note:** Encrypted secrets for {% data variables.product.prodname_codespaces %} is currently in beta and subject to change. + +{% endnote %} + +### About encrypted secrets for {% data variables.product.prodname_codespaces %} + +You can add encrypted secrets to your user account that you want to use in your codespaces. For example, you may want to store and access the following sensitive information as encrypted secrets. + +- Personal access tokens to cloud services +- Service principals +- Subscription identifiers + +You can choose which repositories should have access to each secret. Then, you can use the secret in any codespace you create for a repository that has access to the secret. + +### Adding a secret + +{% data reusables.user_settings.access_settings %} +{% data reusables.user_settings.codespaces-tab %} +1. To the right of "Codespaces secrets", click **New secret**. + !["New secret" button](/assets/images/help/settings/codespaces-new-secret-button.png) +1. Under "Name", type a name for your secret. + !["Name" textbox](/assets/images/help/settings/codespaces-secret-name-field.png) +{% data reusables.user_settings.codespaces-secret-value %} +{% data reusables.user_settings.codespaces-secret-repository-access %} +1. Click **Add secret**. + +### Editing a secret + +You can update the value of an existing secret, and you can change which repositories can access a secret. + +{% data reusables.user_settings.access_settings %} +{% data reusables.user_settings.codespaces-tab %} +1. Under "Codespaces secrets", to the right of the secret you want to edit, click **Update**. + !["Update" button](/assets/images/help/settings/codespaces-secret-update-button.png) +1. Under "Value", click **enter a new value**. + !["enter a new value" link](/assets/images/help/settings/codespaces-secret-update-value-text.png) +{% data reusables.user_settings.codespaces-secret-value %} +{% data reusables.user_settings.codespaces-secret-repository-access %} +1. Optionally, to remove the secret's access to a repository, deselect the repository. + ![Checkboxes to remove access to repositories](/assets/images/help/settings/codespaces-secret-repository-checkboxes.png) +1. Click **Save changes**. + +### Deleting a secret + +{% data reusables.user_settings.access_settings %} +{% data reusables.user_settings.codespaces-tab %} +1. Under "Codespaces secrets", to the right of the secret you want to delete, click **Delete**. + !["Delete" button](/assets/images/help/settings/codespaces-secret-delete-button.png) +1. Read the warning, then click **OK**. + ![Confirmation to delete secret](/assets/images/help/settings/codespaces-secret-delete-warning.png) diff --git a/content/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces.md b/content/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces.md new file mode 100644 index 0000000000..41c3420829 --- /dev/null +++ b/content/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces.md @@ -0,0 +1,22 @@ +--- +title: Managing GPG verification for Codespaces +intro: You can allow {% data variables.product.company_short %} to automatically use GPG to sign commits you make in your codespaces, so other people can be confident that the changes come from a trusted source. +product: '{% data reusables.gated-features.codespaces %}' +versions: + free-pro-team: '*' +--- + +{% note %} + +**Note:** GPG verification for {% data variables.product.prodname_codespaces %} is currently in beta and subject to change. + +{% endnote %} + +After you enable GPG verification, {% data variables.product.company_short %} will automatically sign commits you make in {% data variables.product.prodname_codespaces %}, and the commits will have a verified status on {% data variables.product.product_name %}. By default, GPG verification is disabled for codespaces you create. You can choose to allow GPG verification for all repositories or specific repositories. Only enable GPG verification for repositories that you trust. For more information about {% data variables.product.product_name %}-signed commits, see "[About commit signature verification](/github/authenticating-to-github/about-commit-signature-verification)." + +{% data reusables.user_settings.access_settings %} +{% data reusables.user_settings.codespaces-tab %} +1. Under "GPG verification", select the setting you want for GPG verification. + ![Radio buttons to manage GPG verification](/assets/images/help/settings/codespaces-gpg-verification-radio-buttons.png) +1. If you chose "Selected repositories", select the drop-down menu, then click a repository you want enable GPG verification for. Repeat for all repositories you want to enable GPG verification for. + !["Selected repositories" drop-down menu](/assets/images/help/settings/codespaces-gpg-verification-repository-drop-down.png) diff --git a/content/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account.md b/content/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account.md index e157b686f5..2539fd6762 100644 --- a/content/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account.md +++ b/content/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account.md @@ -40,6 +40,7 @@ For more information, see [Personalizing](https://docs.microsoft.com/visualstudi {% endnote %} +You can also configure settings for your user account to add encrypted secrets, enable GPG verification, and allow your codespaces to access other repositories. For more information, see "[Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces)", "[Managing GPG verification for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)", and "[Managing access and security for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces)." ### Further reading diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-codeql-code-scanning-in-your-ci-system.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-codeql-code-scanning-in-your-ci-system.md index 9ea1c457d6..e53bd81edc 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-codeql-code-scanning-in-your-ci-system.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-codeql-code-scanning-in-your-ci-system.md @@ -12,6 +12,7 @@ versions: {% data reusables.code-scanning.beta-codeql-runner %} {% data reusables.code-scanning.beta %} +{% data reusables.code-scanning.not-available %} ### The `init` command takes too long diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md index e3c8e64523..f1c4d3e53a 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md @@ -11,6 +11,7 @@ versions: --- {% data reusables.code-scanning.beta %} +{% data reusables.code-scanning.not-available %} ### Automatic build for a compiled language fails @@ -83,16 +84,6 @@ For more information about specifying build steps, see "[Configuring the {% data The {% data variables.product.prodname_codeql %} `autobuild` feature uses heuristics to build the code in a repository, however, sometimes this approach results in incomplete analysis of a repository. For example, when multiple `build.sh` commands exist in a single repository, the analysis may not complete since the `autobuild` step will only execute one of the commands. The solution is to replace the `autobuild` step with build steps which build all of the source code which you wish to analyze. For more information, see "[Configuring the {% data variables.product.prodname_codeql %} workflow for compiled languages](/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)." -### Error: "Server error" - -If the run of a workflow for {% data variables.product.prodname_code_scanning %} fails due to a server error, try running the workflow again. If the problem persists, contact {% data variables.contact.contact_support %}. - -### Error: "Out of disk" or "Out of memory" - -On very large projects, {% data variables.product.prodname_codeql %} may run out of disk or memory on the runner. -{% if currentVersion == "free-pro-team@latest" %}If you encounter this issue on a hosted {% data variables.product.prodname_actions %} runner, contact {% data variables.contact.contact_support %} so that we can investigate the problem. -{% else %}If you encounter this issue, try increasing the memory on the runner.{% endif %} - ### The build takes too long If your build with {% data variables.product.prodname_codeql %} analysis takes too long to run, there are several approaches you can try to reduce the build time. @@ -127,3 +118,53 @@ If you are analyzing code written in Python, you may see different results depen On GitHub-hosted runners that use Linux, the {% data variables.product.prodname_codeql_workflow %} tries to install and analyze Python dependencies, which could lead to more results. To disable the auto-install, add `setup-python-dependencies: false` to the "Initialize CodeQL" step of the workflow. For more information about configuring the analysis of Python dependencies, see "[Analyzing Python dependencies](/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#analyzing-python-dependencies)." {% endif %} + +### Error: "Server error" + +If the run of a workflow for {% data variables.product.prodname_code_scanning %} fails due to a server error, try running the workflow again. If the problem persists, contact {% data variables.contact.contact_support %}. + +### Error: "Out of disk" or "Out of memory" + +On very large projects, {% data variables.product.prodname_codeql %} may run out of disk or memory on the runner. +{% if currentVersion == "free-pro-team@latest" %}If you encounter this issue on a hosted {% data variables.product.prodname_actions %} runner, contact {% data variables.contact.contact_support %} so that we can investigate the problem. +{% else %}If you encounter this issue, try increasing the memory on the runner.{% endif %} + +### Warning: "git checkout HEAD^2 is no longer necessary" + +If you're using an old {% data variables.product.prodname_codeql %} workflow you may get the following warning in the output from the "Initialize {% data variables.product.prodname_codeql %}" action: + +``` +Warning: 1 issue was detected with this workflow: git checkout HEAD^2 is no longer +necessary. Please remove this step as Code Scanning recommends analyzing the merge +commit for best results. +``` + +Fix this by removing the following lines from the {% data variables.product.prodname_codeql %} workflow. These lines were included in the `steps` section of the `Analyze` job in initial versions of the {% data variables.product.prodname_codeql %} workflow. + +```yaml + with: + # We must fetch at least the immediate parents so that if this is + # a pull request then we can checkout the head. + fetch-depth: 2 + + # If this run was triggered by a pull request event, then checkout + # the head of the pull request instead of the merge commit. + - run: git checkout HEAD^2 + if: {% raw %}${{ github.event_name == 'pull_request' }}{% endraw %} +``` + +The revised `steps` section of the workflow will look like this: + +```yaml + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + # Initializes the {% data variables.product.prodname_codeql %} tools for scanning. + - name: Initialize {% data variables.product.prodname_codeql %} + uses: github/codeql-action/init@v1 + + ... +``` + +For more information about editing the {% data variables.product.prodname_codeql %} workflow file, see "[Configuring {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#editing-a-code-scanning-workflow)." \ No newline at end of file diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github.md index 4b900eaf08..32aa381f4e 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github.md @@ -27,6 +27,8 @@ You can upload the results using {% data variables.product.prodname_actions %}{% - The {% data variables.product.prodname_codeql_runner %}, to run {% data variables.product.prodname_code_scanning %} in your CI system, by default the runner automatically uploads results to {% data variables.product.prodname_dotcom %} on completion. If you block the automatic upload, when you are ready to upload results you can use the `upload` command (for more information, see "[Running {% data variables.product.prodname_code_scanning %} in your CI system](/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system)"). - A tool that generates results as an artifact outside of your repository, you can use the {% data variables.product.prodname_code_scanning %} API to upload the file (for more information, see "[Upload a SARIF file](/rest/reference/code-scanning#upload-a-sarif-file)"). +{% data reusables.code-scanning.not-available %} + ### Uploading a {% data variables.product.prodname_code_scanning %} analysis with {% data variables.product.prodname_actions %} To use {% data variables.product.prodname_actions %} to upload a third-party SARIF file to a repository, you'll need a workflow. For more information, see "[Learn {% data variables.product.prodname_actions %}](/actions/getting-started-with-github-actions/about-github-actions)" and "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)." diff --git a/content/github/getting-started-with-github/about-github-advanced-security.md b/content/github/getting-started-with-github/about-github-advanced-security.md new file mode 100644 index 0000000000..34a1caaf08 --- /dev/null +++ b/content/github/getting-started-with-github/about-github-advanced-security.md @@ -0,0 +1,46 @@ +--- +title: About GitHub Advanced Security +intro: '{% data variables.product.prodname_dotcom %} makes extra security features available to customers under an {% data variables.product.prodname_advanced_security %} license. These features are also enabled for public repositories on {% data variables.product.prodname_dotcom_the_website %}.' +versions: + free-pro-team: '*' + enterprise-server: '>=3.0' +--- + +### About {% data variables.product.prodname_GH_advanced_security %} + +{% data variables.product.prodname_dotcom %} has many features that help you improve and maintain the quality of your code. Some of these are included in all plans, for example: dependency graph and {% data variables.product.prodname_dependabot_alerts %}. Other security features require a license for {% data variables.product.prodname_GH_advanced_security %} to run on repositories apart from public repositories on {% data variables.product.prodname_dotcom_the_website %}. (That is, private and internal repositories on {% data variables.product.prodname_dotcom_the_website %}, and all repositories on {% data variables.product.prodname_ghe_server %}.) + +For an overview of all security features, see "[About securing your repository](/github/administering-a-repository/about-securing-your-repository#setting-up-your-repository-securely)." + +### About {% data variables.product.prodname_advanced_security %} features + +A {% data variables.product.prodname_GH_advanced_security %} license provides the following additional features: + +- **{% data variables.product.prodname_code_scanning_capc %}** - Search for potential security vulnerabilities and coding errors in your code. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)." + +- **{% data variables.product.prodname_secret_scanning_caps %}** - Detect secrets, for example keys and tokens, that have been checked into the repository. For more information, see "[About {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/about-secret-scanning)." + +{% if currentVersion == "free-pro-team@latest" %} +- **Dependency review** - Show the full impact of changes to dependencies and see details of any vulnerable versions before you merge a pull request. For more information, see "[Reviewing dependency changes in a pull request](/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request)." +{% endif %} + +For information about {% data variables.product.prodname_advanced_security %} features that are in development, see "[{% data variables.product.prodname_dotcom %} public roadmap](https://github.com/github/roadmap)." + +{% if currentVersion ver_gt "enterprise-server@2.22" %} +### Enabling {% data variables.product.prodname_advanced_security %} features on {% data variables.product.prodname_ghe_server %} + +The site administrator must enable {% data variables.product.prodname_advanced_security %} for {% data variables.product.product_location %} before you can use these features. For more information, see "[Configuring Advanced Security features](/admin/configuration/configuring-advanced-security-features)." + +Once your system is set up, you can enable and disable these features at the organization or repository level. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)." + +For information about purchasing a license for {% data variables.product.prodname_GH_advanced_security %}, contact {% data variables.contact.contact_enterprise_sales %}. +{% endif %} + +### Enabling {% data variables.product.prodname_advanced_security %} features on {% data variables.product.prodname_dotcom_the_website %} + +For public repositories on {% data variables.product.prodname_dotcom_the_website %}, these features are permanently on and are only disabled if you change the visibility of the project so that the code is no longer public. + +For all other repositories, once you have a license, you can enable and disable these features at the organization or repository level. {% if currentVersion == "free-pro-team@latest" %}For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)." + +For information about purchasing a license for {% data variables.product.prodname_GH_advanced_security %}, contact {% data variables.contact.contact_enterprise_sales %}. +{% endif %} \ No newline at end of file diff --git a/content/github/getting-started-with-github/github-for-mobile.md b/content/github/getting-started-with-github/github-for-mobile.md index a3735d1678..320357ccde 100644 --- a/content/github/getting-started-with-github/github-for-mobile.md +++ b/content/github/getting-started-with-github/github-for-mobile.md @@ -27,6 +27,7 @@ To install {% data variables.product.prodname_mobile %} for Android or iOS, see {% data variables.product.prodname_mobile %} is available in the following languages. +- English - Japanese - Brazilian Portuguese - Spanish diff --git a/content/github/getting-started-with-github/githubs-products.md b/content/github/getting-started-with-github/githubs-products.md index 3735db6d81..dfe5f0a4bf 100644 --- a/content/github/getting-started-with-github/githubs-products.md +++ b/content/github/getting-started-with-github/githubs-products.md @@ -97,7 +97,7 @@ For more information about hosting your own instance of [{% data variables.produ - {% data variables.contact.github_support %} {% data variables.product.premium_plus_support_plan %} - {% data variables.product.prodname_insights %} -- {% data variables.product.prodname_advanced_security %}{% if currentVersion == "free-pro-team@latest" %}. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)" and "[About {% data variables.product.prodname_secret_scanning %}](/github/administering-a-repository/about-secret-scanning) (beta)."{% endif %}{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %}. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning) (beta)."{% endif %} +- {% data variables.product.prodname_GH_advanced_security %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}. For more information, see "[About {% data variables.product.prodname_GH_advanced_security %}](/github/getting-started-with-github/about-github-advanced-security)."{% endif %}{% if enterpriseServerVersions contains currentVersion and currentVersion == "enterprise-server@2.22" %}. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)" (beta).{% endif %} - [{% data variables.product.prodname_learning %} for organizations](https://lab.github.com/organizations) For more information about signing up for {% data variables.product.prodname_ghe_one %}, contact [{% data variables.product.product_name %}'s Sales team](https://enterprise.github.com/contact). diff --git a/content/github/getting-started-with-github/index.md b/content/github/getting-started-with-github/index.md index c8b857b90e..d5970dd910 100644 --- a/content/github/getting-started-with-github/index.md +++ b/content/github/getting-started-with-github/index.md @@ -28,6 +28,7 @@ versions: {% link_in_list /be-social %} {% topic_link_in_list /learning-about-github %} {% link_in_list /githubs-products %} + {% link_in_list /about-github-advanced-security %} {% link_in_list /exploring-early-access-releases-with-feature-preview %} {% link_in_list /types-of-github-accounts %} {% link_in_list /faq-about-changes-to-githubs-plans %} diff --git a/content/github/managing-files-in-a-repository/rendering-csv-and-tsv-data.md b/content/github/managing-files-in-a-repository/rendering-csv-and-tsv-data.md index 15f545ecfb..216d9abe4f 100644 --- a/content/github/managing-files-in-a-repository/rendering-csv-and-tsv-data.md +++ b/content/github/managing-files-in-a-repository/rendering-csv-and-tsv-data.md @@ -17,7 +17,7 @@ You can link to a particular row by clicking the row number, or select multiple ### Searching data -If you want to find a certain value in your dataset, you can start typing in the search bar directly above the file. The rows will filter automagically: +If you want to find a certain value in your dataset, you can start typing in the search bar directly above the file. The rows will filter automatically: ![Searching for values](/assets/images/help/repository/searching_csvs.gif) diff --git a/content/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors.md b/content/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors.md index dd179ef0df..5d9f2b85c4 100644 --- a/content/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors.md +++ b/content/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors.md @@ -78,13 +78,15 @@ The best way to resolve this error is to merge or close some of the existing pul #### {% data variables.product.prodname_dependabot %} can't resolve your dependency files -**Version updates only.** If {% data variables.product.prodname_dependabot %} attempts to check whether dependency references need to be updated in a repository, but can't access one or more of the referenced files, you will see the error message "{% data variables.product.prodname_dependabot %} can't resolve your LANGUAGE dependency files". +If {% data variables.product.prodname_dependabot %} attempts to check whether dependency references need to be updated in a repository, but can't access one or more of the referenced files, the operation will fail with the error message "{% data variables.product.prodname_dependabot %} can't resolve your LANGUAGE dependency files." The API error type is `git_dependencies_not_reachable`. -{% data reusables.dependabot.private-dependencies-note %} Additionally, {% data variables.product.prodname_dependabot %} doesn't support private {% data variables.product.prodname_dotcom %} dependencies for all package managers. For more information, see "[About Dependabot version updates](/github/administering-a-repository/about-dependabot-version-updates#supported-repositories-and-ecosystems)." +To allow {% data variables.product.prodname_dependabot %} to update the dependency references successfully, make sure that all of the referenced dependencies are hosted at accessible locations. + +**Version updates only.** {% data reusables.dependabot.private-dependencies-note %} Additionally, {% data variables.product.prodname_dependabot %} doesn't support private {% data variables.product.prodname_dotcom %} dependencies for all package managers. For more information, see "[About Dependabot version updates](/github/administering-a-repository/about-dependabot-version-updates#supported-repositories-and-ecosystems)." ### Triggering a {% data variables.product.prodname_dependabot %} pull request manually If you unblock {% data variables.product.prodname_dependabot %}, you can manually trigger a fresh attempt to create a pull request. - **Security updates**—display the {% data variables.product.prodname_dependabot %} alert that shows the error you have fixed and click **Create {% data variables.product.prodname_dependabot %} security update**. -- **Version updates**—display the log file for the manifest that shows the error that you have fixed and click **Check for updates**. +- **Version updates**—on the **Insights** tab for the repository click **Dependency graph**, and then click the **Dependabot** tab. Click **Last checked *TIME* ago** to see the log file that {% data variables.product.prodname_dependabot %} generated during the last check for version updates. Click **Check for updates**. diff --git a/content/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions.md b/content/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions.md index a0a9f79168..d947f274cb 100644 --- a/content/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions.md +++ b/content/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions.md @@ -40,7 +40,7 @@ When you unsubscribe from notifications in your inbox, they will automatically d {% data reusables.notifications.access_notifications %} 1. From the notifications inbox, select the notifications you want to unsubscribe to. 2. Use the **selected** {% octicon "triangle-down" aria-label="The down triangle icon" %} drop-down to click **Unsubscribe.** - ![Unsubcribe option from main inbox](/assets/images/help/notifications-v2/unsubscribe-from-main-inbox.png) + ![Unsubscribe option from main inbox](/assets/images/help/notifications-v2/unsubscribe-from-main-inbox.png) ### Unsubscribing from notifications on the subscriptions page @@ -68,4 +68,4 @@ When you unwatch a repository, you unsubscribe from future updates from that rep - unwatch a repository - ignore all notifications for a repository - customize the types of event you receive notifications for (issues, pull requests, releases or discussions, if enabled) -{% endif %} \ No newline at end of file +{% endif %} diff --git a/content/github/managing-your-work-on-github/managing-labels.md b/content/github/managing-your-work-on-github/managing-labels.md index 305bb5a45e..d9329e202e 100644 --- a/content/github/managing-your-work-on-github/managing-labels.md +++ b/content/github/managing-your-work-on-github/managing-labels.md @@ -92,7 +92,6 @@ Deleting a label will remove the label from issues and pull requests. {% data reusables.project-management.delete-label %} ### Further reading -- "[About labels](/articles/about-labels)" - "[Filtering issues and pull requests by labels](/articles/filtering-issues-and-pull-requests-by-labels)"{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %} - "[Managing default labels for repositories in your organization](/articles/managing-default-labels-for-repositories-in-your-organization)"{% endif %}{% if currentVersion == "free-pro-team@latest" %} - "[Encouraging helpful contributions to your project with labels](/github/building-a-strong-community/encouraging-helpful-contributions-to-your-project-with-labels)"{% endif %} diff --git a/content/github/searching-for-information-on-github/searching-commits.md b/content/github/searching-for-information-on-github/searching-commits.md index de85f13c09..a2fe749c4b 100644 --- a/content/github/searching-for-information-on-github/searching-commits.md +++ b/content/github/searching-for-information-on-github/searching-commits.md @@ -51,7 +51,7 @@ Use the `author-date` and `committer-date` qualifiers to match commits authored | Qualifier | Example | ------------- | ------------- | author-date:YYYY-MM-DD | [**author-date:<2016-01-01**](https://github.com/search?q=author-date%3A<2016-01-01&type=Commits) matches commits authored before 2016-01-01. -| committer-date:YYYY-MM-DD | [**committer-date:>2016-01-01**](https://github.com/search?q=committer-date%3A<2016-01-01&type=Commits) matches commits committed after 2016-01-01. +| committer-date:YYYY-MM-DD | [**committer-date:>2016-01-01**](https://github.com/search?q=committer-date%3A>2016-01-01&type=Commits) matches commits committed after 2016-01-01. ### Filter merge commits diff --git a/content/github/setting-up-and-managing-organizations-and-teams/canceling-an-invitation-to-become-an-outside-collaborator-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/canceling-an-invitation-to-become-an-outside-collaborator-in-your-organization.md index 1e00613e67..0725241ec2 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/canceling-an-invitation-to-become-an-outside-collaborator-in-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/canceling-an-invitation-to-become-an-outside-collaborator-in-your-organization.md @@ -19,4 +19,4 @@ For each pending collaborator, you can cancel all invitations to join organizati 6. To the right of the person you want to cancel invitations for, click **Cancel invitations**. !["Cancel invitation" button](/assets/images/help/organizations/cancel-pending-collaborators.png) 7. Click **Cancel invitations for pending collaborators**. - ![Button to confirm cancelation](/assets/images/help/organizations/confirm-cancelation-of-pending-collaborators.png) + ![Button to confirm cancellation](/assets/images/help/organizations/confirm-cancelation-of-pending-collaborators.png) diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-secret-scanning-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-secret-scanning-for-your-organization.md index abeb2eece6..17141c5148 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-secret-scanning-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-secret-scanning-for-your-organization.md @@ -6,7 +6,7 @@ permissions: 'Organization owners can manage {% data variables.product.prodname_ versions: free-pro-team: '*' --- - + {% data reusables.secret-scanning.beta %} ### About management of {% data variables.product.prodname_secret_scanning %} @@ -43,4 +43,4 @@ You can manage how {% data variables.product.prodname_dotcom %} scans for secret {% data reusables.organizations.org_settings %} {% data reusables.organizations.security-and-analysis %} 5. To the right of "Secret scanning", enable or disable the feature by default for new private repositories in your organization. - ![Checkbox for enabling or disabling a feature for new repositoris](/assets/images/help/organizations/security-and-analysis-enable-or-disable-secret-scanning-checkbox.png) + ![Checkbox for enabling or disabling a feature for new repositories](/assets/images/help/organizations/security-and-analysis-enable-or-disable-secret-scanning-checkbox.png) diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization.md index 60ab0b137c..7fcb1ff573 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization.md @@ -8,7 +8,8 @@ versions: ### About management of security and analysis settings -{% data variables.product.prodname_dotcom %} can help secure the repositories in your organization. You can manage the security and analysis features for all existing or new repositories that members create in your organization. +{% data variables.product.prodname_dotcom %} can help secure the repositories in your organization. You can manage the security and analysis features for all existing or new repositories that members create in your organization. {% if currentVersion == "free-pro-team@latest" %}If you have a license for {% data variables.product.prodname_GH_advanced_security %} then you can also manage access to these features. {% data reusables.advanced-security.more-info-ghas %}{% endif %} + {% data reusables.security.some-security-and-analysis-features-are-enabled-by-default %} {% data reusables.security.security-and-analysis-features-enable-read-only %} @@ -19,27 +20,61 @@ versions: {% data reusables.organizations.org_settings %} {% data reusables.organizations.security-and-analysis %} -The page that's displayed allows you to enable or disable security and analysis features for the repositories in your organization. +The page that's displayed allows you to enable or disable all security and analysis features for the repositories in your organization. {% if currentVersion == "free-pro-team@latest" %}If your organization, or the enterprise that owns it, has a license for {% data variables.product.prodname_GH_advanced_security %}, the page will also contain options to enable and disable {% data variables.product.prodname_advanced_security %} features. + +![{% data variables.product.prodname_GH_advanced_security %} features](/assets/images/help/organizations/security-and-analysis-highlight-ghas.png) +{% endif %} ### Enabling or disabling a feature for all existing repositories +You can enable or disable features for all repositories. {% if currentVersion == "free-pro-team@latest" %}The impact of your changes on repositories in your organization is determined by their visibility: + +- **Dependency graph** - Your changes affect only private repositories because the feature is always enabled for public repositories. +- **{% data variables.product.prodname_dependabot_alerts %}** - Your changes affect all repositories. +- **{% data variables.product.prodname_dependabot_security_updates %}** - Your changes affect all repositories. +- **{% data variables.product.prodname_GH_advanced_security %}** - Your changes affect only private repositories because {% data variables.product.prodname_GH_advanced_security %} and the related features are always enabled for public repositories. +- **{% data variables.product.prodname_secret_scanning_caps %}** - Your changes affect only private repositories where {% data variables.product.prodname_GH_advanced_security %} is also enabled. {% data variables.product.prodname_secret_scanning_caps %} is always enabled for public repositories.{% endif %} + +{% data reusables.advanced-security.note-org-enable-uses-seats %} + 1. Go to the security and analysis settings for your organization. For more information, see "[Displaying the security and analysis settings](#displaying-the-security-and-analysis-settings)." 1. Under "Configure security and analysis features", to the right of the feature, click **Disable all** or **Enable all**. - !["Enable all" or "Disable all" button for "Configure security and analysis" features](/assets/images/help/organizations/security-and-analysis-disable-or-enable-all.png) -1. Optionally, enable the feature by default for new repositories in your organization. - !["Enable by default" option for new repositories](/assets/images/help/organizations/security-and-analysis-enable-by-default-in-modal.png) + {% if currentVersion == "free-pro-team@latest" %} + !["Enable all" or "Disable all" button for "Configure security and analysis" features](/assets/images/help/organizations/security-and-analysis-disable-or-enable-all-ghas-dotcom.png) + {% endif %} + {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} + !["Enable all" or "Disable all" button for "Configure security and analysis" features](/assets/images/help/organizations/security-and-analysis-disable-or-enable-all-ghe.png) + {% endif %} +2. Optionally, enable the feature by default for new repositories in your organization. + {% if currentVersion == "free-pro-team@latest" %} + !["Enable by default" option for new repositories](/assets/images/help/organizations/security-and-analysis-enable-by-default-in-modal.png) + {% endif %} + {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} + !["Enable by default" option for new repositories](/assets/images/help/organizations/security-and-analysis-secret-scanning-enable-by-default-ghe.png) + {% endif %} 1. Click **Disable FEATURE** or **Enable FEATURE** to disable or enable the feature for all the repositories in your organization. ![Button to disable or enable feature](/assets/images/help/organizations/security-and-analysis-enable-dependency-graph.png) -### Enabling or disabling a feature for all new repositories when they are added +### Enabling or disabling a feature automatically when new repositories are added 1. Go to the security and analysis settings for your organization. For more information, see "[Displaying the security and analysis settings](#displaying-the-security-and-analysis-settings)." -1. Under "Configure security and analysis features", to the right of the feature, enable or disable the feature by default for new repositories in your organization. - ![Checkbox for enabling or disabling a feature for new repositories](/assets/images/help/organizations/security-and-analysis-enable-or-disable-feature-checkbox.png) +1. Under "Configure security and analysis features", to the right of the feature, enable or disable the feature by default for new repositories{% if currentVersion == "free-pro-team@latest" %}, or all new private repositories,{% endif %} in your organization. + {% if currentVersion == "free-pro-team@latest" %} + ![Checkbox for enabling or disabling a feature for new repositories](/assets/images/help/organizations/security-and-analysis-enable-or-disable-feature-checkbox-dotcom.png) + {% endif %} + {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} + ![Checkbox for enabling or disabling a feature for new repositories](/assets/images/help/organizations/security-and-analysis-enable-or-disable-secret-scanning-checkbox-ghe.png) + {% endif %} + + {% data reusables.advanced-security.note-org-enable-uses-seats %} ### Allowing Dependabot to access private repositories -{% data variables.product.prodname_dependabot %} can check for outdated dependency references in a project and automatically generate a pull request to update them. To do this, {% data variables.product.prodname_dependabot %} must have access to the targeted dependency files. By default, {% data variables.product.prodname_dependabot %} can't update dependencies that are located in private repositories. However, if a dependency is in a private {% data variables.product.prodname_dotcom %} repository within the same organization as the project that uses that dependency, you can allow {% data variables.product.prodname_dependabot %} to update the version successfully by giving it access to the host repository. For more information, including details of limitations to private dependency support, see "[About Dependabot version updates](/github/administering-a-repository/about-dependabot-version-updates)." +{% data reusables.dependabot.beta-note %} + +{% data variables.product.prodname_dependabot %} can check for outdated dependency references in a project and automatically generate a pull request to update them. To do this, {% data variables.product.prodname_dependabot %} must have access to all of the targeted dependency files. Typically, version updates will fail if one or more dependencies are inaccessible. + +By default, {% data variables.product.prodname_dependabot %} can't update dependencies that are located in private repositories. However, if a dependency is in a private {% data variables.product.prodname_dotcom %} repository within the same organization as the project that uses that dependency, you can allow {% data variables.product.prodname_dependabot %} to update the version successfully by giving it access to the host repository. For more information, including details of limitations to private dependency support, see "[About Dependabot version updates](/github/administering-a-repository/about-dependabot-version-updates)." 1. Go to the security and analysis settings for your organization. For more information, see "[Displaying the security and analysis settings](#displaying-the-security-and-analysis-settings)." 1. In the "{% data variables.product.prodname_dependabot %} repository access" section, click the settings button **{% octicon "gear" aria-label="The Gear icon" %}**. diff --git a/content/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization.md index 2e21db1c13..bd5e816583 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization.md @@ -107,7 +107,8 @@ In addition to managing organization-level settings, organization owners have ad | [Dismiss {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository) | | | | | **X** | | [Designate additional people or teams to receive {% data variables.product.prodname_dependabot_alerts %}](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository) for vulnerable dependencies | | | | | **X** | | [Manage data use settings for your private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository) | | | | | **X** | -| Create [security advisories](/github/managing-security-vulnerabilities/about-github-security-advisories) | | | | | **X** | {% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +| Create [security advisories](/github/managing-security-vulnerabilities/about-github-security-advisories) | | | | | **X** | +| Manage access to {% data variables.product.prodname_GH_advanced_security %} features (see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)") | | | | | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} | [View {% data variables.product.prodname_code_scanning %} alerts on pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests) | **X** | **X** | **X** | **X** | **X** | | [List, dismiss, and delete {% data variables.product.prodname_code_scanning %} alerts](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository) | | | **X** | **X** | **X** |{% endif %} | [Manage the forking policy for a repository](/github/administering-a-repository/managing-the-forking-policy-for-your-repository) | | | | | **X** | @@ -115,8 +116,7 @@ In addition to managing organization-level settings, organization owners have ad | [Delete or transfer repositories out of the organization](/articles/setting-permissions-for-deleting-or-transferring-repositories) | | | | | **X** | | [Archive repositories](/articles/about-archiving-repositories) | | | | | **X** |{% if currentVersion == "free-pro-team@latest" %} | Display a sponsor button (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)") | | | | | **X** |{% endif %} -| Create autolink references to external resources, like JIRA or Zendesk (see "[Configuring autolinks to reference external resources](/articles/configuring-autolinks-to-reference-external-resources)") | | | | | **X** |{% if currentVersion == "free-pro-team@latest" %} -| Create [security advisories](/github/managing-security-vulnerabilities/about-github-security-advisories) | | | | | **X** | {% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +| Create autolink references to external resources, like JIRA or Zendesk (see "[Configuring autolinks to reference external resources](/articles/configuring-autolinks-to-reference-external-resources)") | | | | | **X** |{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} | [View {% data variables.product.prodname_code_scanning %} alerts on pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests) | **X** | **X** | **X** | **X** | **X** | | [List, dismiss, and delete {% data variables.product.prodname_code_scanning %} alerts](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository) | | | **X** | **X** | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" %} | [Enable {% data variables.product.prodname_discussions %}](/github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository) in a repository | | | | **X** | **X** | diff --git a/content/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization.md index fcb5bd5ba7..c59633f47f 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization.md @@ -197,7 +197,7 @@ An overview of some of the most common actions that are recorded as events in th | Action | Description |------------------|------------------- | `disable` | Triggered when an organization owner disables {% data variables.product.prodname_dependabot_alerts %} for all new {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repositories. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)." -| `enable` | Triggered when an organization owner enbles {% data variables.product.prodname_dependabot_alerts %} for all new {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repositories. +| `enable` | Triggered when an organization owner enables {% data variables.product.prodname_dependabot_alerts %} for all new {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repositories. #### `dependabot_security_updates` category actions @@ -218,14 +218,14 @@ An overview of some of the most common actions that are recorded as events in th | Action | Description |------------------|------------------- | `disable` | Triggered when an organization owner disables the dependency graph for all existing repositories. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)." -| `enable` | Triggered when an organization owner enables the dependency graph for all existing repositories. +| `enable` | Triggered when an organization owner enables the dependency graph for all existing repositories. #### `dependency_graph_new_repos` category actions | Action | Description |------------------|------------------- | `disable` | Triggered when an organization owner disables the dependency graph for all new repositories. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)." -| `enable` | Triggered when an organization owner enables the dependency graph for all new repositories. +| `enable` | Triggered when an organization owner enables the dependency graph for all new repositories. {% endif %} @@ -324,10 +324,12 @@ For more information, see "[Restricting publication of {% data variables.product | Action | Description |------------------|-------------------{% if currentVersion == "free-pro-team@latest"%} +| `advanced_security_disabled` | Triggered when an organization admin disables {% data variables.product.prodname_GH_advanced_security %} for all existing private and internal repositories. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)." +| `advanced_security_enabled` | Triggered when an organization admin enables {% data variables.product.prodname_GH_advanced_security %} for all existing private and internal repositories. | `audit_log_export` | Triggered when an organization admin [creates an export of the organization audit log](#exporting-the-audit-log). If the export included a query, the log will list the query used and the number of audit log entries matching that query. | `block_user` | Triggered when an organization owner [blocks a user from accessing the organization's repositories](/articles/blocking-a-user-from-your-organization). | `cancel_invitation` | Triggered when an organization invitation has been revoked. {% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} -| `create_actions_secret` | Triggered when a organization admin [creates a {% data variables.product.prodname_actions %} secret](/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-an-organization).{% endif %} {% if currentVersion == "free-pro-team@latest"%} +| `create_actions_secret` | Triggered when a organization admin [creates a {% data variables.product.prodname_actions %} secret](/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-an-organization).{% endif %} {% if currentVersion == "free-pro-team@latest"%} | `disable_oauth_app_restrictions` | Triggered when an owner [disables {% data variables.product.prodname_oauth_app %} access restrictions](/articles/disabling-oauth-app-access-restrictions-for-your-organization) for your organization. | `disable_saml` | Triggered when an organization admin disables SAML single sign-on for an organization.{% endif %} | `disable_member_team_creation_permission` | Triggered when an organization owner limits team creation to owners. For more information, see "[Setting team creation permissions in your organization](/articles/setting-team-creation-permissions-in-your-organization)." |{% if currentVersion != "github-ae@latest" %} @@ -451,7 +453,9 @@ For more information, see "[Restricting publication of {% data variables.product |------------------|------------------- | `access` | Triggered when a user [changes the visibility](/github/administering-a-repository/setting-repository-visibility) of a repository in the organization. | `add_member` | Triggered when a user accepts an [invitation to have collaboration access to a repository](/articles/inviting-collaborators-to-a-personal-repository). -| `add_topic` | Triggered when a repository admin [adds a topic](/articles/classifying-your-repository-with-topics) to a repository. +| `add_topic` | Triggered when a repository admin [adds a topic](/articles/classifying-your-repository-with-topics) to a repository.{% if currentVersion == "free-pro-team@latest" %} +| `advanced_security_disabled` | Triggered when a repository owner disables {% data variables.product.prodname_GH_advanced_security %}. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)." +| `advanced_security_enabled` | Triggered when a repository owner enables {% data variables.product.prodname_GH_advanced_security %}.{% endif %} | `archived` | Triggered when a repository admin [archives a repository](/articles/about-archiving-repositories).{% if enterpriseServerVersions contains currentVersion %} | `config.disable_anonymous_git_access` | Triggered when [anonymous Git read access is disabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository. | `config.enable_anonymous_git_access` | Triggered when [anonymous Git read access is enabled](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository) in a public repository. @@ -527,7 +531,7 @@ For more information, see "[Restricting publication of {% data variables.product | Action | Description |------------------|------------------- | `authorized_users_teams` | Triggered when an organization owner or a person with admin permissions to the repository updates the list of people or teams authorized to receive {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies in the repository. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." -| `disable` | Triggered when a repository owner or person with admin access to the repository disables {% data variables.product.prodname_dependabot_alerts %}. +| `disable` | Triggered when a repository owner or person with admin access to the repository disables {% data variables.product.prodname_dependabot_alerts %}. | `enable` | Triggered when a repository owner or person with admin access to the repository enables {% data variables.product.prodname_dependabot_alerts %}. {% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} @@ -536,7 +540,7 @@ For more information, see "[Restricting publication of {% data variables.product | Action | Description |------------------|------------------- | `disable` | Triggered when an organization owner disables secret scanning for all existing{% if currentVersion == "free-pro-team@latest" %}, private{% endif %} repositories. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." -| `enable` | Triggered when an organization owner enables secret scanning for all existing{% if currentVersion == "free-pro-team@latest" %}, private{% endif %} repositories. +| `enable` | Triggered when an organization owner enables secret scanning for all existing{% if currentVersion == "free-pro-team@latest" %}, private{% endif %} repositories. #### `secret_scanning_new_repos` category actions @@ -559,7 +563,7 @@ For more information, see "[Restricting publication of {% data variables.product | `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored account (see "[Managing your sponsorship](/articles/managing-your-sponsorship)") | `sponsor_sponsorship_tier_change` | Triggered when you upgrade or downgrade your sponsorship (see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)") | `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)") -| `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your organizaion](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)") +| `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)") | `sponsored_developer_profile_update` | Triggered when you edit your sponsored organization profile (see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors)") | `sponsored_developer_request_approval` | Triggered when you submit your application for {% data variables.product.prodname_sponsors %} for approval (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)") | `sponsored_developer_tier_description_update` | Triggered when you change the description for a sponsorship tier (see "[Changing your sponsorship tiers](/articles/changing-your-sponsorship-tiers)") diff --git a/content/github/setting-up-and-managing-your-github-profile/why-are-my-contributions-not-showing-up-on-my-profile.md b/content/github/setting-up-and-managing-your-github-profile/why-are-my-contributions-not-showing-up-on-my-profile.md index 4c8132ffa5..b03f183b73 100644 --- a/content/github/setting-up-and-managing-your-github-profile/why-are-my-contributions-not-showing-up-on-my-profile.md +++ b/content/github/setting-up-and-managing-your-github-profile/why-are-my-contributions-not-showing-up-on-my-profile.md @@ -11,9 +11,9 @@ versions: ### Contributions that are counted -#### Issues and pull requests +#### Issues, pull requests and discussions -Issues and pull requests will appear on your contribution graph if they were opened in a standalone repository, not a fork. +Issues, pull requests and discussions will appear on your contribution graph if they were opened in a standalone repository, not a fork. #### Commits Commits will appear on your contributions graph if they meet **all** of the following conditions: diff --git a/content/github/setting-up-and-managing-your-github-user-account/managing-your-theme-settings.md b/content/github/setting-up-and-managing-your-github-user-account/managing-your-theme-settings.md index 37f6c58643..93091a6db3 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/managing-your-theme-settings.md +++ b/content/github/setting-up-and-managing-your-github-user-account/managing-your-theme-settings.md @@ -15,7 +15,7 @@ For choice and flexibility in how and when you use {% data variables.product.pro {% data reusables.user_settings.access_settings %} 1. In the user settings sidebar, click **Appearance**. - !["Apperance" tab in user settings sidebar](/assets/images/help/settings/appearance-tab.png) + !["Appearance" tab in user settings sidebar](/assets/images/help/settings/appearance-tab.png) 1. Under "Theme", select a theme preference. ![Radio buttons for theme settings](/assets/images/help/settings/theme-settings-radio-buttons.png) diff --git a/content/github/site-policy/amendment-to-github-terms-of-service-applicable-to-us-federal-government-users.md b/content/github/site-policy/amendment-to-github-terms-of-service-applicable-to-us-federal-government-users.md index 6d69ad58e5..fd5e3d54d3 100644 --- a/content/github/site-policy/amendment-to-github-terms-of-service-applicable-to-us-federal-government-users.md +++ b/content/github/site-policy/amendment-to-github-terms-of-service-applicable-to-us-federal-government-users.md @@ -1,5 +1,6 @@ --- title: Amendment to GitHub Terms of Service Applicable to U.S. Federal Government Users +hidden: true redirect_from: - /articles/amendment-to-github-terms-of-service-applicable-to-government-users/ - /articles/proposed-amendment-to-github-terms-of-service-applicable-to-u-s-federal-government-users/ @@ -9,6 +10,8 @@ versions: free-pro-team: '*' --- +_These terms apply to Customers who licensed the Products prior to January 4, 2021._ + {% tip %} This Amendment to GitHub's [Terms of Service](/articles/github-terms-of-service) applies only to users that are using GitHub on behalf of the United States federal government. If you are not using GitHub on behalf of the U.S. federal government, the standard [GitHub Terms of Service](/articles/github-terms-of-service) apply to you. diff --git a/content/github/site-policy/github-ae-data-protection-agreement.md b/content/github/site-policy/github-ae-data-protection-agreement.md index b73651630d..e00f06d287 100644 --- a/content/github/site-policy/github-ae-data-protection-agreement.md +++ b/content/github/site-policy/github-ae-data-protection-agreement.md @@ -1,12 +1,13 @@ --- title: GitHub AE Data Protection Agreement +hidden: true versions: free-pro-team: '*' redirect_from: - /github/site-policy/ghem-data-protection-addendum --- -Version Effective Date: November 1, 2020 +_These terms apply to Customers who licensed the Products prior to January 4, 2021._ ## INTRODUCTION diff --git a/content/github/site-policy/github-ae-product-specific-terms.md b/content/github/site-policy/github-ae-product-specific-terms.md index 52d39d2e38..22a6c51843 100644 --- a/content/github/site-policy/github-ae-product-specific-terms.md +++ b/content/github/site-policy/github-ae-product-specific-terms.md @@ -1,12 +1,13 @@ --- title: GitHub AE Product Specific Terms +hidden: true versions: free-pro-team: '*' redirect_from: - /github/site-policy/ghem-supplemental-terms-for-microsoft-volume-licensing --- -Version Effective Date: November 1, 2020 +_These terms apply to Customers who licensed the Products prior to January 4, 2021._ The Agreement consists of these GitHub AE Product Specific Terms, the General Terms that Customer accepted, and any additional terms GitHub or its Affiliates present when an order is placed. diff --git a/content/github/site-policy/github-and-trade-controls.md b/content/github/site-policy/github-and-trade-controls.md index 659d453f5c..4fabee13f5 100644 --- a/content/github/site-policy/github-and-trade-controls.md +++ b/content/github/site-policy/github-and-trade-controls.md @@ -11,9 +11,9 @@ versions: GitHub.com, GitHub Enterprise Server, and the information you upload to either product may be subject to trade control regulations, including under the U.S. Export Administration Regulations (the EAR). -GitHub’s vision is to be the global platform for developer collaboration, no matter where developers reside. We take seriously our responsibility to examine government mandates thoroughly to be certain that users and customers are not impacted beyond what is required by law. This includes keeping public repositories services, including those for open source projects, available and accessible to support personal communications involving developers in sanctioned regions. +GitHub’s vision is to be the global platform for developer collaboration, no matter where developers reside. We take seriously our responsibility to examine government mandates thoroughly to be certain that users and customers are not impacted beyond what is required by law. This includes keeping public repository services, including those for open source projects, available and accessible to support personal communications involving developers in sanctioned regions. This also means GitHub will advocate for developers in sanctioned regions to enjoy greater access to the platform and full access to the global open source community. -To comply with U.S. trade control laws, GitHub made some required changes to the way we conduct our services. As U.S. trade controls laws evolve, we will continue to work with U.S. regulators about the extent to which we can offer free code collaboration services to developers in sanctioned markets. We believe that offering those free services supports U.S. foreign policy of encouraging the free flow of information and free speech in those markets. For more insight on our approach and how sanctions affect global software collaboration, read our [blog on sanctions](https://github.blog/2019-09-12-global-software-collaboration-in-the-face-of-sanctions/). +As a result of our advocacy and hard work with U.S. regulators, GitHub has secured a license from the U.S. Treasury Department’s Office of Foreign Assets Control (OFAC) to restore our cloud services to developers in Iran. And we will continue to work with U.S. regulators to secure similar licenses to offer collaboration services to developers in Syria and Crimea. We are committed to advocating for the broadest possible developer access, as we believe offering code collaboration services for developers in sanctioned regions makes the global developer community stronger, advances human progress, and supports the enduring U.S. foreign policy of promoting free speech and the free flow of information. For information about the license we secured for developers in Iran, read [the blog post](https://github.blog/2021-01-05-advancing-developer-freedom-github-is-fully-available-in-iran). Although we've provided the following information below for your convenience, it is ultimately your responsibility to ensure that your use of GitHub's products and services complies with all applicable laws and regulations, including U.S. export control laws. @@ -25,9 +25,9 @@ Under our [Terms of Service](/articles/github-terms-of-service), users may only Users are responsible for ensuring that the content they develop and share on GitHub.com complies with the U.S. export control laws, including the EAR and the U.S. International Traffic in Arms Regulations (ITAR). The cloud-hosted service offering available at [GitHub.com](https://github.com) has not been designed to host data subject to the ITAR and does not currently offer the ability to restrict repository access by country. If you are looking to collaborate on ITAR- or other export-controlled data, we recommend you consider [GitHub Enterprise Server](https://enterprise.github.com), GitHub's on-premises offering. -U.S. trade control laws restrict what GitHub.com services can be made available to users in certain countries and territories. GitHub may allow users in or ordinarily resident in countries and territories subject to U.S. sanctions to access certain free GitHub.com services for personal communications in accordance to authorizations issued by the U.S. Treasury Department’s Office of Foreign Assets Controls (OFAC). Persons in or ordinarily resident in these countries and territories are prohibited from using IP proxies, VPNs, or other methods to disguise their location when accessing GitHub.com services, and may only use GitHub.com for non-commercial, personal communications. +GitHub now has a license from OFAC to provide cloud services to developers located or otherwise resident in Iran. This includes all public and private services for individuals and organizations, both free and paid. -Specially Designated Nationals (SDNs) and other denied or blocked parties under U.S. and other applicable law are prohibited from accessing or using GitHub.com. Additionally, users may not use GitHub.com for or on behalf of such parties, including the Governments of sanctioned countries. Furthermore, GitHub.com may not be used for purposes prohibited under applicable export control laws, including prohibited end uses described in [17 CFR 744](https://www.ecfr.gov/cgi-bin/text-idx?SID=ad384e1f1e017076f8c0136f322f0a4c&mc=true&node=pt15.2.744&rgn=div5). +Specially Designated Nationals (SDNs), other denied or blocked parties under U.S. and other applicable law, and certain government officials, may be restricted from accessing or using GitHub.com. Additionally, users may not use GitHub.com for or on behalf of such parties, including the Governments of sanctioned countries. Furthermore, GitHub.com may not be used for purposes prohibited under applicable export control laws, including prohibited end uses described in [17 CFR 744](https://www.ecfr.gov/cgi-bin/text-idx?SID=ad384e1f1e017076f8c0136f322f0a4c&mc=true&node=pt15.2.744&rgn=div5). #### GitHub Enterprise Server @@ -41,7 +41,7 @@ GitHub Enterprise Server may not be sold to, exported, or re-exported to any cou #### On which countries and territories are U.S. government sanctions applied? -Crimea, Cuba, Iran, North Korea, and Syria. +Crimea, Cuba, Iran, North Korea, and Syria. With respect to Iran, however, GitHub now has a license from the U.S. Treasury Department's Office of Foreign Assets Control (OFAC) to provide cloud services to developers located or otherwise resident in that country. #### How is GitHub ensuring that folks not living in and/or having professional links to the sanctioned countries and territories still have access or ability to appeal? @@ -55,23 +55,23 @@ Travel in these regions may impact your account status, but availability may be #### What is available and not available? +GitHub now has a license from OFAC to provide cloud services to developers located or otherwise resident in the U.S.-sanctioned country of Iran. The license includes all public and private services for individuals and organizations, both free and paid. However, Specially Designated Nationals (SDNs), other denied or blocked parties under U.S. and other applicable law, and certain government officials may be restricted from accessing or using GitHub. + GitHub is committed to continuing to offer free public repository services to developers with individual and organizational accounts in U.S.-sanctioned regions. This includes limited access to free services, such as public repositories for open source projects (and associated public Pages), public gists, and allotted free Action minutes, for personal communications only, and not for commercial purposes. - -However, due to U.S. trade controls law restrictions, GitHub is unable to provide private repository services and paid services to accounts in U.S. sanctioned regions like North Korea, Iran, Syria, and Crimea. The restriction suspends access to private repository services and paid services, such as availability of free or paid private repositories, secret gists, paid Action minutes, Sponsors, and GitHub Marketplace services. -For paid organizational accounts in sanctioned regions, users may have limited access to their public repositories, which have been downgraded to archived read-only repositories. For free organizational accounts in sanctioned regions, however, users will continue to have full access to free public repositories for open source projects (and associated public Pages), public gists, and allotted free Action minutes. +For paid organizational accounts in these sanctioned regions, users may have limited access to their public repositories, which have been downgraded to archived read-only repositories. For free organizational accounts in these sanctioned regions, however, users will continue to have full access to free public repositories for open source projects (and associated public Pages), public gists, and allotted free Action minutes. -GitHub will continue advocating with U.S. regulators for the greatest possible access to free code collaboration services to developers in sanctioned regions, including free private repositories. We believe that offering those free services supports U.S. foreign policy of encouraging the free flow of information and free speech in those regions. +GitHub will continue advocating with U.S. regulators for the greatest possible access to code collaboration services to developers in sanctioned regions, such as Syria and Crimea, including private repositories. We believe that offering those services advances human progress, international communication, and the enduring U.S. foreign policy of promoting free speech and the free flow of information. #### How do you define these specific users? -If GitHub determines that a user or customer is located in a region that is subject to U.S. trade control restrictions, or a user is otherwise restricted under U.S. economic sanctions, then the affiliated account has been restricted to comply with those legal requirements. The determination of user and customer location to implement these legal restrictions are derived from a number of sources, including IP addresses and payment history. Nationality and ethnicity are not used to flag users for sanctions restrictions. +If GitHub determines that a user or customer is located in a region that is subject to U.S. trade control restrictions for which GitHub does not yet have a license from the U.S. government, or a user is otherwise restricted under U.S. economic sanctions, then the affiliated account will be restricted to comply with those legal requirements. The determination of user and customer location to implement these legal restrictions are derived from a number of sources, including IP addresses and payment history. Nationality and ethnicity are not used to flag users for sanctions restrictions. #### How are organization accounts impacted? -If an organization is based out of, or the key individuals or membership of an organization shows sufficient ties to, a sanctioned territory or country, or if the organization otherwise appears to be subject to U.S. economic sanctions, then the organization account and the affiliated owner account will be restricted. +If an organization is based out of, or the key individuals or membership of an organization shows sufficient ties to, a sanctioned territory or country for which GitHub does not yet have a license from the U.S. government, or if the organization otherwise appears to be subject to U.S. economic sanctions, then the organization account and the affiliated owner account will be restricted. -The restriction suspends access to private repository services and paid services, such as availability of free or paid private repositories, secret gists, paid Action minutes, Sponsors, and GitHub Marketplace services. For paid organizational accounts associated with sanctioned regions, users may have limited access to their public repositories, which have been downgraded to archived read-only repositories. For free organizational accounts associated with sanctioned regions, users will continue to have full access to free public repositories for open source projects (and associated public Pages), public gists, and allotted free Action minutes. +The restriction suspends access to private repository services and paid services, such as availability of free or paid private repositories, secret gists, paid Action minutes, Sponsors, and GitHub Marketplace services. For paid organizational accounts associated with such sanctioned regions, users may have limited access to their public repositories, which have been downgraded to archived read-only repositories. For free organizational accounts associated with such sanctioned regions, users will continue to have full access to free public repositories for open source projects (and associated public Pages), public gists, and allotted free Action minutes. #### Can trade-restricted users’ private repositories be made public? @@ -81,3 +81,16 @@ Free individual account users can make restricted private repositories public, f Unfortunately, our understanding of the law does not give us the option to allow downloads or deletion of private repository content, until otherwise authorized by the U.S. government. We will strongly advocate, with U.S. regulators, for the right of trade-restricted users to secure the contents of their private repositories. We will also advocate for more availability of GitHub services for developers in sanctioned markets, and further underscore the importance of code collaboration in supporting personal communications for developers globally. +#### Under the license GitHub has received from OFAC, which types of accounts will be available in Iran? + +The license we have secured includes all public and private services, for individuals and organizations, both free and paid. + +For example, a developer in Iran may sign up for a Free or Pro plan for their individual use, and an Iranian university may set up an organization account to collaborate with students. + +Specially Designated Nationals (SDNs), other denied or blocked parties under U.S. and other applicable law, and certain government officials may be restricted from accessing or using GitHub. + +If GitHub determines that an individual falls into a restricted category (SDNs, other blocked parties, or certain government officials), their account will be flagged and they will not be able to use any GitHub features. If they believe that they have been flagged in error, then they have the opportunity to appeal the flag by providing verification information to GitHub using our [individual account appeals request form](https://airtable.com/shrGBcceazKIoz6pY). If GitHub receives sufficient information to verify that the individual is not in a category restricted by U.S. economic sanctions, then the flag will be removed. + +#### Will Iranian GitHub users be able to use paid services under the license? + +Pursuant to the license we have received from OFAC, we are restoring all cloud services to Iranian users, including paid services. We accept all major credit cards, but third parties process payments for us, so payments are subject to the terms and conditions of our payment processors. Those third parties may include restrictions that block payments from Iran. diff --git a/content/github/site-policy/github-bug-bounty-program-legal-safe-harbor.md b/content/github/site-policy/github-bug-bounty-program-legal-safe-harbor.md index 5ea4f4e319..97bff67a75 100644 --- a/content/github/site-policy/github-bug-bounty-program-legal-safe-harbor.md +++ b/content/github/site-policy/github-bug-bounty-program-legal-safe-harbor.md @@ -31,4 +31,4 @@ That said, if legal action is initiated by a third party, including law enforcem ### 3. Limited Waiver of Other Site Polices -To the extent your security research activities are inconsistent with certain restrictions in our [relevant site policies](/categories/site-policy/) but are consistent with the terms of our bug bounty program, we waive those restrictions for the sole and limited purpose of permitting your security research under this bug bounty program. Just like above, if in doubt, ask us first! +To the extent that your security research activities are inconsistent with certain restrictions in our [relevant site policies](/categories/site-policy/) but consistent with the terms of our bug bounty program, we waive those restrictions for the sole and limited purpose of permitting your security research under this bug bounty program. Just like above, if in doubt, ask us first! diff --git a/content/github/site-policy/github-connect-addendum-to-the-github-enterprise-license-agreement.md b/content/github/site-policy/github-connect-addendum-to-the-github-enterprise-license-agreement.md index db5e07aacf..97132a8cb5 100644 --- a/content/github/site-policy/github-connect-addendum-to-the-github-enterprise-license-agreement.md +++ b/content/github/site-policy/github-connect-addendum-to-the-github-enterprise-license-agreement.md @@ -1,11 +1,15 @@ --- title: GitHub Connect Addendum to the GitHub Enterprise License Agreement +hidden: true redirect_from: - /articles/github-com-connection-addendum-to-the-github-enterprise-license-agreement/ - /articles/github-connect-addendum-to-the-github-enterprise-license-agreement versions: free-pro-team: '*' --- + +_These terms apply to Customers who licensed the Products prior to January 4, 2021._ + PLEASE READ THIS ADDENDUM CAREFULLY AS IT AMENDS THE TERMS OF YOUR ENTERPRISE LICENSE AGREEMENT WITH US AND SPECIFICALLY GOVERNS YOUR USE OF GITHUB CONNECT (AS DEFINED BELOW), UNLESS GITHUB (“WE” OR “US”) HAS EXECUTED A SEPARATE WRITTEN ADDENDUM WITH YOU FOR THAT PURPOSE. BY ACCESSING GITHUB CONNECT, YOU ACCEPT ALL THE TERMS AND CONDITIONS OF THIS ADDENDUM. IF YOU ARE ENTERING INTO THIS ADDENDUM ON BEHALF OF A COMPANY OR OTHER LEGAL ENTITY (“CUSTOMER”), YOU REPRESENT THAT YOU HAVE THE LEGAL AUTHORITY TO BIND CUSTOMER TO THIS AGREEMENT. diff --git a/content/github/site-policy/github-data-protection-addendum.md b/content/github/site-policy/github-data-protection-addendum.md index aaae911d02..3f5ac90943 100644 --- a/content/github/site-policy/github-data-protection-addendum.md +++ b/content/github/site-policy/github-data-protection-addendum.md @@ -1,10 +1,11 @@ --- title: GitHub Data Protection Addendum +hidden: true versions: free-pro-team: '*' --- -Version Effective Date: September 9, 2020 +_These terms apply to Customers who licensed the Products prior to January 4, 2021._ ## INTRODUCTION diff --git a/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md b/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md index 7a9f7a4208..cb84c3c697 100644 --- a/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md +++ b/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md @@ -1,11 +1,14 @@ --- title: GitHub Enterprise Cloud Evaluation Agreement +hidden: true redirect_from: - /articles/github-enterprise-cloud-evaluation-agreement versions: free-pro-team: '*' --- +_These terms apply to Customers who licensed the Products prior to January 4, 2021._ + THANK YOU FOR CHOOSING GITHUB FOR YOUR COMPANY'S BUSINESS NEEDS. PLEASE READ THESE TERMS CAREFULLY AS IT GOVERNS YOUR EVALUATION USE OF THE SERVICE, UNLESS GITHUB HAS EXECUTED A SEPARATE WRITTEN AGREEMENT WITH YOU FOR THAT PURPOSE. BY CLICKING ON THE "I AGREE" OR SIMILAR BUTTON OR BY ACCESSING THE SERVICE ON A TRIAL BASIS, YOU ACCEPT ALL THE TERMS AND CONDITIONS OF THIS EVALUATION AGREEMENT. IF YOU ARE ENTERING INTO THIS EVALUATION AGREEMENT ON BEHALF OF A COMPANY OR OTHER LEGAL ENTITY (HEREINAFTER REFERRED TO AS "**CUSTOMER**"), CUSTOMER REPRESENTS THAT IT HAS THE LEGAL AUTHORITY TO BIND THE COMPANY OR OTHER LEGAL ENTITY TO THIS EVALUATION AGREEMENT. ALSO, BY ACCEPTING THESE TERMS, CUSTOMER AGREES THAT IT HAS READ GITHUB'S PRIVACY STATEMENT. ### 1. Corporate Terms of Service diff --git a/content/github/site-policy/github-enterprise-server-license-agreement.md b/content/github/site-policy/github-enterprise-server-license-agreement.md index 994d0cb179..b790395cb5 100644 --- a/content/github/site-policy/github-enterprise-server-license-agreement.md +++ b/content/github/site-policy/github-enterprise-server-license-agreement.md @@ -1,12 +1,13 @@ --- title: GitHub Enterprise Server License Agreement +hidden: true redirect_from: - /articles/github-enterprise-server-license-agreement versions: free-pro-team: '*' --- -Effective Date: April 1, 2020 +_These terms apply to Customers who licensed the Products prior to January 4, 2021._ PLEASE READ THIS AGREEMENT CAREFULLY AS IT GOVERNS YOUR USE OF THE PRODUCTS (AS DEFINED BELOW), UNLESS WE HAVE EXECUTED A SEPARATE WRITTEN AGREEMENT WITH YOU FOR THAT PURPOSE. diff --git a/content/github/site-policy/github-enterprise-service-level-agreement.md b/content/github/site-policy/github-enterprise-service-level-agreement.md index 463d5eccec..d2f6da48d3 100644 --- a/content/github/site-policy/github-enterprise-service-level-agreement.md +++ b/content/github/site-policy/github-enterprise-service-level-agreement.md @@ -1,5 +1,6 @@ --- title: GitHub Enterprise Service Level Agreement +hidden: true redirect_from: - /github-enterprise-cloud-addendum/ - /github-business-cloud-addendum/ @@ -7,6 +8,9 @@ redirect_from: versions: free-pro-team: '*' --- + +_These terms apply to Customers who licensed the Products prior to January 4, 2021._ + **Short version:** GitHub guarantees a 99.9% quarterly uptime commitment for the applicable GitHub service (the “**Service Level**” or “**SLA**”). If GitHub does not meet the SLA, then Customer will be entitled to a service credit to Customer’s account (“**Service Credits**”). For definitions of each Service feature (“**Service Feature**”) and to review historical and current Uptime, visit the [GitHub Status Page](https://www.githubstatus.com/). Capitalized terms used but not defined in this SLA have the meaning assigned in Customer’s applicable agreement. @@ -17,7 +21,7 @@ For definitions of each Service feature (“**Service Feature**”) and to revie | **Service Feature** | **Uptime Calculation** | **Definitions** | **Service Credits Calculation** | |---|---|---|---| -| **Issues**,
**Pull Requests**,
**Git Operations**,
**API Requests**,
**Webhooks**,
**Pages** | (total minutes in a calendar quarter - Downtime) / total minutes in a calendar quarter | “**Downtime**” is a period of time where either (a) the error rate exceeds five percent (5%) in a given minute for any Service Feature or (b) the Service was unavailable as determined by a combination of GitHub's internal and external monitoring systems. | A Service Credits claim may be based on either (not both) of the following calculations: | | +| **Issues**,
**Pull Requests**,
**Git Operations**,
**API Requests (for Service Features only)**,
**Webhooks**,
**Pages** | (total minutes in a calendar quarter - Downtime) / total minutes in a calendar quarter | “**Downtime**” is a period of time where either (a) the error rate exceeds five percent (5%) in a given minute for any Service Feature or (b) the Service was unavailable as determined by a combination of GitHub's internal and external monitoring systems. | A Service Credits claim may be based on either (not both) of the following calculations: | | | **Actions** | (Total Triggered Executions – Unavailable Executions) / (Total Triggered Executions) x 100 | “**Total Triggered Executions**” is the total number of all Actions executions triggered by Customer in a calendar quarter.

“**Unavailable Executions**” is the total number of executions within Total Triggered Executions which failed to run in a calendar quarter. An execution failed to run when the Actions history log did not capture any output five (5) minutes after the trigger was successfully fired. | Same as above | | **Packages** | Transfers Uptime = same as Actions

Storage Uptime = 100% - Average Error Rate*

*The Uptime Calculation excludes public usage and storage transactions that do not count toward either Total Storage Transactions or Failed Storage Transactions (including pre-authentication failures; authentication failures; attempted transactions for storage accounts over their prescribed quotas). | “**Error Rate**” is the total number of Failed Storage Transactions divided by the Total Storage Transactions during a set time interval (currently set at one hour). If the Total Storage Transactions in a given one-hour interval is zero, the error rate for that interval is 0%.

“**Average Error Rate**” is the sum of Error Rates for each hour in a calendar quarter divided by the total number of hours in a calendar quarter. | Same as above | diff --git a/content/github/site-policy/github-enterprise-subscription-agreement.md b/content/github/site-policy/github-enterprise-subscription-agreement.md index 18a526e52a..5d76608780 100644 --- a/content/github/site-policy/github-enterprise-subscription-agreement.md +++ b/content/github/site-policy/github-enterprise-subscription-agreement.md @@ -1,5 +1,6 @@ --- title: GitHub Enterprise Subscription Agreement +hidden: true redirect_from: - /articles/github-enterprise-agreement/ - /articles/github-enterprise-subscription-agreement @@ -7,7 +8,7 @@ versions: free-pro-team: '*' --- -Version Effective Date: November 16, 2020 +_These terms apply to Customers who licensed the Products prior to January 4, 2021._ BY CLICKING THE "I AGREE" OR SIMILAR BUTTON OR BY USING ANY OF THE PRODUCTS (DEFINED BELOW), CUSTOMER ACCEPTS THE TERMS AND CONDITIONS OF THIS AGREEMENT. IF CUSTOMER IS ENTERING INTO THIS AGREEMENT ON BEHALF OF A LEGAL ENTITY, CUSTOMER REPRESENTS THAT IT HAS THE LEGAL AUTHORITY TO BIND THE LEGAL ENTITY TO THIS AGREEMENT. diff --git a/content/github/site-policy/github-marketplace-developer-agreement.md b/content/github/site-policy/github-marketplace-developer-agreement.md index 76b87042b2..d92ec43248 100644 --- a/content/github/site-policy/github-marketplace-developer-agreement.md +++ b/content/github/site-policy/github-marketplace-developer-agreement.md @@ -8,7 +8,7 @@ versions: **THESE TERMS AND CONDITIONS (THE "AGREEMENT") GOVERN YOUR PARTICIPATION IN GITHUB’S MARKETPLACE PROGRAM. BY ENROLLING TO PARTICIPATE IN THE MARKETPLACE PROGRAM OR BY CLICKING “I ACCEPT” BELOW, YOU ARE CONFIRMING THAT YOU UNDERSTAND THIS AGREEMENT, AND THAT YOU ACCEPT ALL OF ITS TERMS AND CONDITIONS. IF YOU ARE ENTERING INTO THIS AGREEMENT ON BEHALF OF A COMPANY OR OTHER LEGAL ENTITY, YOU REPRESENT THAT YOU HAVE THE LEGAL AUTHORITY TO BIND THE ENTITY TO THIS AGREEMENT, IN WHICH CASE “YOU” WILL MEAN THE ENTITY YOU REPRESENT.** -Effective Date: July 21, 2020 +Effective Date: January 1, 2021 ### 1. DEFINITIONS @@ -143,7 +143,7 @@ In the event that your Listing is involuntarily removed because it is defective, **6.1** GitHub will be the merchant of record for Developer Products purchased by End Users via Marketplace. -**6.2** Prices for Marketplace Listings of Developer Applications will be set in US Dollars (USD). Developer has complete control over setting pricing for each Listing, and once set, such pricing cannot be changed. You may retire a pricing plan for an existing Listing and add a new pricing plan for such Listing, provided that such new pricing plan shall not negatively impact existing End Users. The prices you set for Developer Products will determine the amount of payment you will receive. GitHub will remit 75% of the sale price in USD without reduction for Taxes except for any withholding taxes that are required under applicable law. The remaining 25% of the sales price will be allotted to and retained by GitHub. At the end of each month and upon reaching a minimum value of $500 USD, GitHub will remit your share of payments. +**6.2** Prices for Marketplace Listings of Developer Applications will be set in US Dollars (USD). Developer has complete control over setting pricing for each Listing, and once set, such pricing cannot be changed. You may retire a pricing plan for an existing Listing and add a new pricing plan for such Listing, provided that such new pricing plan shall not negatively impact existing End Users. The prices you set for Developer Products will determine the amount of payment you will receive. GitHub will remit 95% of the sale price in USD without reduction for Taxes except for any withholding taxes that are required under applicable law. The remaining 5% of the sales price will be allotted to and retained by GitHub. At the end of each month and upon reaching a minimum value of $500 USD, GitHub will remit your share of payments. **6.3** Refund Requirements. You will be responsible for specifying the terms and conditions regarding refunds to your End Users. In no event shall GitHub be responsible for providing any support for refunds, nor shall GitHub be liable for payment of any refund. diff --git a/content/github/site-policy/github-privacy-statement.md b/content/github/site-policy/github-privacy-statement.md index e54c05734d..7dbbaa9dc1 100644 --- a/content/github/site-policy/github-privacy-statement.md +++ b/content/github/site-policy/github-privacy-statement.md @@ -11,7 +11,7 @@ versions: free-pro-team: '*' --- -Effective date: November 16, 2020 +Effective date: December 19, 2020 Thanks for entrusting GitHub Inc. (“GitHub”, “we”) with your source code, your projects, and your personal information. Holding on to your private information is a serious responsibility, and we want you to know how we're handling it. @@ -28,14 +28,14 @@ Of course, the short version and the Summary below don't tell you everything, so | Section | What can you find there? | |---|---| -| [What information GitHub collects](#what-information-github-collects) | GitHub collects information directly from you for your registration, payment, transactions, and user profile. We also automatically collect from you your usage information, cookies and similar technologies, and device information, subject, where necessary, to your consent. GitHub may also collect User Personal Information from third parties. We only collect the minimum amount of personal information necessary from you, unless you choose to provide more. | +| [What information GitHub collects](#what-information-github-collects) | GitHub collects information directly from you for your registration, payment, transactions, and user profile. We also automatically collect from you your usage information, cookies, and device information, subject, where necessary, to your consent. GitHub may also collect User Personal Information from third parties. We only collect the minimum amount of personal information necessary from you, unless you choose to provide more. | | [What information GitHub does _not_ collect](#what-information-github-does-not-collect) | We don’t knowingly collect information from children under 13, and we don’t collect [Sensitive Personal Information](https://gdpr-info.eu/art-9-gdpr/). | | [How GitHub uses your information](#how-github-uses-your-information) | In this section, we describe the ways in which we use your information, including to provide you the Service, to communicate with you, for security and compliance purposes, and to improve our Service. We also describe the legal basis upon which we process your information, where legally required. | | [How we share the information we collect](#how-we-share-the-information-we-collect) | We may share your information with third parties under one of the following circumstances: with your consent, with our service providers, for security purposes, to comply with our legal obligations, or when there is a change of control or sale of corporate entities or business units. We do not sell your personal information and we do not host advertising on GitHub. You can see a list of the service providers that access your information. | | [Other important information](#other-important-information) | We provide additional information specific to repository contents, public information, and Organizations on GitHub. | | [Additional services](#additional-services) | We provide information about additional service offerings, including third-party applications, GitHub Pages, and GitHub applications. | | [How you can access and control the information we collect](#how-you-can-access-and-control-the-information-we-collect) | We provide ways for you to access, alter, or delete your personal information. | -| [Our use of cookies and tracking](#our-use-of-cookies-and-tracking) | We use cookies for the overall functionality of our Website, and we use a small number of tracking and analytics services on a few parts of our site. We offer a page that makes this very transparent. Please see this section for more information. | +| [Our use of cookies and tracking](#our-use-of-cookies-and-tracking) | We only use strictly necessary cookies to provide, secure and improve our service. We offer a page that makes this very transparent. Please see this section for more information. | | [How GitHub secures your information](#how-github-secures-your-information) | We take all measures reasonably necessary to protect the confidentiality, integrity, and availability of your personal information on GitHub and to protect the resilience of our servers. | | [GitHub's global privacy practices](#githubs-global-privacy-practices) | We provide the same high standard of privacy protection to all our users around the world. | | [How we communicate with you](#how-we-communicate-with-you) | We communicate with you by email. You can control the way we contact you in your account settings, or by contacting us. | @@ -74,8 +74,8 @@ If you have a paid Account with us, sell an application listed on [GitHub Market ##### Usage information If you're accessing our Service or Website, we automatically collect the same basic information that most services collect, subject, where necessary, to your consent. This includes information about how you use the Service, such as the pages you view, the referring site, your IP address and session information, and the date and time of each request. This is information we collect from every visitor to the Website, whether they have an Account or not. This information may include User Personal information. -##### Cookies and similar technologies information -As further described below, and subject, where applicable, to your consent, we automatically collect information from cookies and similar technologies (such as cookie ID and settings) to keep you logged in, to remember your preferences, and to identify you and your device. +##### Cookies +As further described below, we automatically collect information from cookies (such as cookie ID and settings) to keep you logged in, to remember your preferences, to identify you and your device and to analyze your use of our service. ##### Device information We may collect certain information about your device, such as its IP address, browser or client application information, language preference, operating system and application version, device type and ID, and device model and manufacturer. This information may include User Personal information. @@ -235,15 +235,17 @@ That said, the email address you have supplied [via your Git commit settings](/g #### Cookies -GitHub uses cookies and similar technologies (e.g., HTML5 localStorage) to make interactions with our service easy and meaningful. Cookies are small text files that websites often store on computer hard drives or mobile devices of visitors. We use cookies and similar technologies (hereafter collectively "cookies") to provide you our services, for example, to keep you logged in, remember your preferences, identify your device for security purposes, and provide information for future development of GitHub. By using our Website, you agree that we can place these types of cookies on your computer or device. If you disable your browser or device’s ability to accept these cookies, you will not be able to log in or use GitHub’s services. +GitHub only uses strictly necessary cookies. Cookies are small text files that websites often store on computer hard drives or mobile devices of visitors. -We provide more information about [cookies on GitHub](/github/site-policy/github-subprocessors-and-cookies#cookies-on-github) on our [GitHub Subprocessors and Cookies](/github/site-policy/github-subprocessors-and-cookies) page that describes the cookies we set, the needs we have for those cookies, and the expiration of such cookies. It also lists our third-party analytics providers and how you can control your cookie preference settings for such cookies. +We use cookies solely to provide, secure, and improve our service. For example, we use them to keep you logged in, remember your preferences, identify your device for security purposes, analyze your use of our service, compile statistical reports, and provide information for future development of GitHub. We use our own cookies for analytics purposes, but do not use any third-party analytics service providers. -#### Tracking and analytics +By using our service, you agree that we can place these types of cookies on your computer or device. If you disable your browser or device’s ability to accept these cookies, you will not be able to log in or use our service. -We use a number of third-party analytics and service providers to help us evaluate our Users' use of GitHub, compile statistical reports on activity, and improve our content and Website performance. We only use these third-party analytics providers on certain areas of our Website, and all of them have signed data protection agreements with us that limit the type of User Personal Information they can collect and the purpose for which they can process the information. In addition, we use our own internal analytics software to provide features and improve our content and performance. +We provide more information about [cookies on GitHub](/github/site-policy/github-subprocessors-and-cookies#cookies-on-github) on our [GitHub Subprocessors and Cookies](/github/site-policy/github-subprocessors-and-cookies) page that describes the cookies we set, the needs we have for those cookies, and the expiration of such cookies. -Some browsers have incorporated "Do Not Track" (DNT) features that can send a signal to the websites you visit indicating you do not wish to be tracked. GitHub responds to browser DNT signals and follows the [W3C standard for responding to DNT signals](https://www.w3.org/TR/tracking-dnt/). If you have not enabled DNT on a browser that supports it, cookies on some parts of our Website will track your online browsing activity on other online services over time, though we do not permit third parties other than our analytics and service providers to track GitHub Users' activity over time on GitHub. You can read more about DNT in our [Tracking on GitHub](/github/site-policy/github-subprocessors-and-cookies#tracking-on-github) section of our [GitHub Subprocessors and Cookies](/github/site-policy/github-subprocessors-and-cookies) page. +#### DNT + +"[Do Not Track](https://www.eff.org/issues/do-not-track)" (DNT) is a privacy preference you can set in your browser if you do not want online services to collect and share certain kinds of information about your online activity from third party tracking services. GitHub responds to browser DNT signals and follows the [W3C standard for responding to DNT signals](https://www.w3.org/TR/tracking-dnt/). If you would like to set your browser to signal that you would not like to be tracked, please check your browser's documentation for how to enable that signal. There are also good applications that block online tracking, such as [Privacy Badger](https://privacybadger.org/). ### How GitHub secures your information diff --git a/content/github/site-policy/github-subprocessors-and-cookies.md b/content/github/site-policy/github-subprocessors-and-cookies.md index d796bcf723..ab7352efb4 100644 --- a/content/github/site-policy/github-subprocessors-and-cookies.md +++ b/content/github/site-policy/github-subprocessors-and-cookies.md @@ -10,9 +10,9 @@ versions: free-pro-team: '*' --- -Effective date: **October 2, 2020** +Effective date: **January 6, 2021** -GitHub provides a great deal of transparency regarding how we use your data, how we collect your data, and with whom we share your data. To that end, we provide this page, which details [our subprocessors](#github-subprocessors), how we use [cookies](#cookies-on-github), and where and how we perform any [tracking on GitHub](#tracking-on-github). +GitHub provides a great deal of transparency regarding how we use your data, how we collect your data, and with whom we share your data. To that end, we provide this page, which details [our subprocessors](#github-subprocessors), and how we use [cookies](#cookies-on-github). ### GitHub Subprocessors @@ -25,18 +25,14 @@ When we share your information with third party subprocessors, such as our vendo | Braintree (PayPal) | Subscription credit card payment processor | United States | United States | | Clearbit | Marketing data enrichment service | United States | United States | | Discourse | Community forum software provider | United States | United States | -| DiscoverOrg | Marketing data enrichment service | United States | United States | | Eloqua | Marketing campaign automation | United States | United States | | Google Apps | Internal company infrastructure | United States | United States | | Google Analytics | Analytics and performance | United States | United States | -| LinkedIn Navigator | Marketing data enrichment service | United States | United States | -| Magic Robot | Campaign reporting (Salesforce Add-on) | United States | United States | | MailChimp | Customer ticketing mail services provider | United States | United States | | Mailgun | Transactional mail services provider | United States | United States | | Microsoft | Microsoft Services | United States | United States | | Monday.com | Team collaboration and project management platform | United States | Israel | | Nexmo | SMS notification provider | United States | United States | -| Oracle | Corporate financial system | United States | United States | | Salesforce.com | Customer relations management | United States | United States | | Sendgrid | Transactional mail services provider | United States | United States | | Sentry.io | Application monitoring provider | United States | United States | @@ -49,15 +45,14 @@ When we bring on a new subprocessor who handles our Users' Personal Information, ### Cookies on GitHub -GitHub uses cookies and similar technologies (collectively, “cookies”) to provide and secure our websites, as well as to analyze the usage of our websites, in order to offer you a great user experience. Please take a look at our [Privacy Statement](/github/site-policy/github-privacy-statement#our-use-of-cookies-and-tracking) if you’d like more information about cookies, and on how and why we use them. +GitHub uses cookies to provide and secure our websites, as well as to analyze the usage of our websites, in order to offer you a great user experience. Please take a look at our [Privacy Statement](/github/site-policy/github-privacy-statement#our-use-of-cookies-and-tracking) if you’d like more information about cookies, and on how and why we use them. Since the number and names of cookies may change,the table below may be updated from time to time. | Service Provider | Cookie Name | Description | Expiration* | |:---|:---|:---|:---| | GitHub | `app_manifest_token` | This cookie is used during the App Manifest flow to maintain the state of the flow during the redirect to fetch a user session. | five minutes | -| GitHub | `cookie-preferences` | This cookie is used to track user cookie preferences. | one year | -| GitHub | `_device_id` | This cookie is used to track recognized devices. | one year | +| GitHub | `_device_id` | This cookie is used to track recognized devices for security purposes. | one year | | GitHub | `dotcom_user` | This cookie is used to signal to us that the user is already logged in. | one year | | GitHub | `_gh_ent` | This cookie is used for temporary application and framework state between pages like what step the customer is on in a multiple step form. | two weeks | | GitHub | `_gh_sess` | This cookie is used for temporary application and framework state between pages like what step the user is on in a multiple step form. | session | @@ -69,29 +64,16 @@ Since the number and names of cookies may change,the table below may be updated | GitHub | `logged_in` | This cookie is used to signal to us that the user is already logged in. | one year | | GitHub | `marketplace_repository_ids` | This cookie is used for the marketplace installation flow. | one hour | | GitHub | `marketplace_suggested_target_id` | This cookie is used for the marketplace installation flow. | one hour | -| GitHub | `_octo` | This cookie is used by our internal analytics service to distinguish unique users and clients. | one year | +| GitHub | `_octo` | This cookie is used for session management including caching of dynamic content, conditional feature access, support request metadata, and first party analytics. | one year | | GitHub | `org_transform_notice` | This cookie is used to provide notice during organization transforms. | one hour | | GitHub | `private_mode_user_session` | This cookie is used for Enterprise authentication requests. | two weeks | | GitHub | `saml_csrf_token` | This cookie is set by SAML auth path method to associate a token with the client. | until user closes browser or completes authentication request | | GitHub | `saml_csrf_token_legacy` | This cookie is set by SAML auth path method to associate a token with the client. | until user closes browser or completes authentication request | | GitHub | `saml_return_to` | This cookie is set by the SAML auth path method to maintain state during the SAML authentication loop. | until user closes browser or completes authentication request | | GitHub | `saml_return_to_legacy` | This cookie is set by the SAML auth path method to maintain state during the SAML authentication loop. | until user closes browser or completes authentication request | -| GitHub | `tz` | This cookie allows your browser to tell us what time zone you're in. | session | +| GitHub | `tz` | This cookie allows us to customize timestamps to your time zone. | session | | GitHub | `user_session` | This cookie is used to log you in. | two weeks | -| Google Analytics** | `_ga` | This cookie is used by Google Analytics. | two years | -| Google Analytics** | `_gat` | This cookie is used by Google Analytics. | one minute | -| Google Analytics** | `_gid` | This cookie is used by Google Analytics. | one day | _*_ The **expiration** dates for the cookies listed below generally apply on a rolling basis. -_**_ We use **Google Analytics** as a third party analytics service to collect information about how our website performs and how our users, in general, navigate through and use GitHub. This helps us evaluate our users' use of GitHub, compile statistical reports on activity, and improve our content and website performance. - -You can control your Google Analytics cookie preferences through our cookie preference link located at the footer of our website. In addition, Google provides further information about its own privacy practices and [offers a browser add-on to opt out of Google Analytics tracking](https://tools.google.com/dlpage/gaoptout). - -(!) Please note certain pages on our website may set other third party cookies. For example, we may embed content, such as videos, from another site that sets a cookie. While we try to minimize these third party cookies, we can’t always control what cookies this third party content sets. - -### Tracking on GitHub - -"[Do Not Track](https://www.eff.org/issues/do-not-track)" (DNT) is a privacy preference you can set in your browser if you do not want online services to collect and share certain kinds of information about your online activity from third party tracking services. GitHub responds to browser DNT signals and follows the [W3C standard for responding to DNT signals](https://www.w3.org/TR/tracking-dnt/). If you would like to set your browser to signal that you would not like to be tracked, please check your browser's documentation for how to enable that signal. There are also good applications that block online tracking, such as [Privacy Badger](https://www.eff.org/privacybadger). - -If you have not enabled DNT on a browser that supports it, cookies on some parts of our website will track your online browsing activity on other online services over time, though we do not permit third parties other than our analytics and service providers to track GitHub users' activity over time on GitHub. We have agreements with certain vendors, such as analytics providers, who help us track visitors' movements on certain pages on our website. Only our vendors, who are collecting personal information on our behalf, may collect data on our pages, and we have signed data protection agreements with every vendor who collects this data on our behalf. We use the data we receive from these vendors to better understand our visitors' interests, to understand our website's performance, and to improve our content. Any analytics vendor will be listed in our [subprocessor list](#github-subprocessors), and you may see a list of every page where we collect this kind of data below. +(!) Please note while we limit our use of third party cookies to those necessary to provide external functionality when rendering external content, certain pages on our website may set other third party cookies. For example, we may embed content, such as videos, from another site that sets a cookie. While we try to minimize these third party cookies, we can’t always control what cookies this third party content sets. diff --git a/content/github/site-policy/github-supplemental-terms-for-microsoft-volume-licensing.md b/content/github/site-policy/github-supplemental-terms-for-microsoft-volume-licensing.md index 523adeb925..340bc3de72 100644 --- a/content/github/site-policy/github-supplemental-terms-for-microsoft-volume-licensing.md +++ b/content/github/site-policy/github-supplemental-terms-for-microsoft-volume-licensing.md @@ -1,5 +1,6 @@ --- title: GitHub Supplemental Terms for Microsoft Volume Licensing +hidden: true redirect_from: - /articles/GitHub-Supplemental-Terms-for-Microsoft-Volume-Licensing/ - /articles/github-supplemental-terms-for-microsoft-volume-licensing @@ -7,7 +8,7 @@ versions: free-pro-team: '*' --- -Version Effective Date: July 20, 2020 +_These terms apply to Customers who licensed the Products prior to January 4, 2021._ The following GitHub Supplemental Terms (including any applicable Order Forms) supplement Customer's Microsoft volume licensing agreement ("**Microsoft Customer Agreement**") and, together with the Microsoft Customer Agreement, govern Customer's use of the Products (as defined below). The Microsoft Customer Agreement is incorporated herein by this reference. Capitalized terms used but not defined in these supplemental terms have the meanings assigned to them in the Microsoft Customer Agreement. diff --git a/content/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository.md b/content/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository.md index dc1c7cecd5..75069e955c 100644 --- a/content/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository.md +++ b/content/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository.md @@ -22,7 +22,7 @@ When you enable data use for your private repository, you'll be able to access t {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-security-and-analysis %} 4. Under "Configure security and analysis features", to the right of the feature, click **Disable** or **Enable**. - !["Enable" or "Disable" button for "Configure security and analysis" features](/assets/images/help/repository/security-and-analysis-disable-or-enable.png) + !["Enable" or "Disable" button for "Configure security and analysis" features](/assets/images/help/repository/security-and-analysis-disable-or-enable-dotcom-private.png) ### Further reading diff --git a/content/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository.md b/content/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository.md index e06ac92e9a..c78fdbcd3f 100644 --- a/content/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository.md +++ b/content/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository.md @@ -38,12 +38,6 @@ If vulnerabilities have been detected in the repository, these are shown at the {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %} Any direct and indirect dependencies that are specified in the repository's manifest or lock files are listed, grouped by ecosystem. If vulnerabilities have been detected in the repository, these are shown at the top of the view for users with access to {% data variables.product.prodname_dependabot_alerts %}. -{% note %} - -**Note:** {% data variables.product.prodname_ghe_server %} does not populate the **Dependents** view. - -{% endnote %} - ![Dependencies graph](/assets/images/help/graphs/dependencies_graph_server.png) {% note %} @@ -57,12 +51,6 @@ Any direct and indirect dependencies that are specified in the repository's mani {% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %} Any direct and indirect dependencies that are specified in the repository's manifest or lock files are listed, grouped by ecosystem. If vulnerabilities have been detected in the repository, these are shown at the top of the view for users with access to security alerts. -{% note %} - -**Note:** {% data variables.product.prodname_ghe_server %} does not populate the **Dependents** view. - -{% endnote %} - ![Dependencies graph](/assets/images/help/graphs/dependencies_graph_server.png) {% note %} @@ -93,6 +81,25 @@ You can also enable or disable the dependency graph for all repositories owned b !["Enable" button for the dependency graph](/assets/images/help/repository/dependency-graph-enable-button.png) You can disable the dependency graph at any time by clicking **Disable** next to "Dependency Graph" on the Security & analysis tab. + +### Changing the "Used by" package + +If the dependency graph is enabled, and your repository contains a package that's published on a supported package ecosystem, {% data variables.product.prodname_dotcom %} displays a "Used by" section in the sidebar of the **Code** tab of your repository. For more information about the supported package ecosystems, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)." + +The "Used by" section shows the number of public references to the package that were found, and displays the avatars of some of the owners of the dependent projects. + +!["Used by" sidebar section](/assets/images/help/repository/used-by-section.png) + +Clicking any item in this section takes you to the **Dependents** tab of the dependency graph. + +The "Used by" section represents a single package from the repository. If you have admin permissions to a repository that contains multiple packages, you can choose which package the "Used by" section represents. + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-settings %} +{% data reusables.repositories.navigate-to-security-and-analysis %} +4. Under "Configure security and analysis features", click the drop-down menu in the "Used by counter" section and choose a package. + ![Choose a "Used by" package](/assets/images/help/repository/choose-used-by-package.png) + {% endif %} ### Troubleshooting the dependency graph diff --git a/content/github/writing-on-github/basic-writing-and-formatting-syntax.md b/content/github/writing-on-github/basic-writing-and-formatting-syntax.md index 4c0e060889..cc409e010f 100644 --- a/content/github/writing-on-github/basic-writing-and-formatting-syntax.md +++ b/content/github/writing-on-github/basic-writing-and-formatting-syntax.md @@ -215,7 +215,7 @@ You can add emoji to your writing by typing `:EMOJICODE:`. Typing `:` will bring up a list of suggested emoji. The list will filter as you type, so once you find the emoji you're looking for, press **Tab** or **Enter** to complete the highlighted result. -For a full list of available emoji and codes, check out [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com). +For a full list of available emoji and codes, check out [the Emoji-Cheat-Sheet](https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md). ### Paragraphs diff --git a/content/packages/guides/configuring-npm-for-use-with-github-packages.md b/content/packages/guides/configuring-npm-for-use-with-github-packages.md index f96a8d68c6..125058a137 100644 --- a/content/packages/guides/configuring-npm-for-use-with-github-packages.md +++ b/content/packages/guides/configuring-npm-for-use-with-github-packages.md @@ -16,6 +16,17 @@ versions: {% data reusables.package_registry.admins-can-configure-package-types %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +### Limits for published npm versions + +If you publish over 1,000 npm package versions to {% data variables.product.prodname_registry %}, you may see performance issues and timeouts occur during usage. + +To reduce the number of versions you have published for your npm package, consider deleting package versions. For more information, see "[Deleting a package](/packages/manage-packages/deleting-a-package)." + +In the future, {% data variables.product.company_short %} will enforce a hard limit on publishing more than 1,000 versions of an npm package. When we start enforcing the 1,000 versions limit for each npm package hosted on {% data variables.product.prodname_registry %}, we will offer more guidance on how to manage your package versions. + +{% endif %} + ### Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} diff --git a/content/packages/guides/connecting-a-repository-to-a-container-image.md b/content/packages/guides/connecting-a-repository-to-a-container-image.md index 051f92283a..826a9327af 100644 --- a/content/packages/guides/connecting-a-repository-to-a-container-image.md +++ b/content/packages/guides/connecting-a-repository-to-a-container-image.md @@ -33,11 +33,11 @@ https://github.com/monalisa/hello_docker 1. In your Dockerfile, add this line, replacing `OWNER` and `REPO` with your details: ```shell - LABEL org.opencontainers.image.source https://github.com/OWNER/REPO + LABEL org.opencontainers.image.source=https://github.com/OWNER/REPO ``` For example, if you're the user `monalisa` and own `my-repo`, you would add this line to your Dockerfile: ```shell - LABEL org.opencontainers.image.source https://github.com/monalisa/my-repo + LABEL org.opencontainers.image.source=https://github.com/monalisa/my-repo ``` For more information, see "[LABEL](https://docs.docker.com/engine/reference/builder/#label)" in the official Docker documentation and "[Pre-defined Annotation Keys](https://github.com/opencontainers/image-spec/blob/master/annotations.md#pre-defined-annotation-keys)" in the `opencontainers/image-spec` repository. diff --git a/content/packages/guides/deleting-a-container-image.md b/content/packages/guides/deleting-a-container-image.md index 11c6cabf81..25c8007801 100644 --- a/content/packages/guides/deleting-a-container-image.md +++ b/content/packages/guides/deleting-a-container-image.md @@ -1,9 +1,9 @@ --- title: Deleting a container image -intro: 'You can delete a version of a private container image using GraphQL or on {% data variables.product.prodname_dotcom %}.' +intro: 'You can delete a specific version or all versions of a private or public container image on {% data variables.product.prodname_dotcom %}.' product: '{% data reusables.gated-features.packages %}' -redirect_from: - - /packages/managing-container-images-with-github-container-registry/deleting-a-container-image +redirect_from: + - /packages/managing-container-images-with-github-container-registry/deleting-a-container-image versions: free-pro-team: '*' --- @@ -20,18 +20,46 @@ When deleting public packages, be aware that you may break projects that depend ### Deleting a version of a user-owned container image on {% data variables.product.prodname_dotcom %} +To only delete specific versions of a container image, you can use these steps. To delete an entire package, see "[Deleting all versions of a user-owned container image on {% data variables.product.prodname_dotcom %}](#deleting-all-versions-of-a-user-owned-container-image-on-github)." + {% data reusables.package_registry.package-settings-from-user-level %} 5. On the left, click **Manage versions**. -5. To the right of the version you want to delete, click **Delete**. - ![Delete package button](/assets/images/help/package-registry/delete-package-button.png) +6. Optionally, to ensure you're seeing all of your package versions, use the "Type" drop down menu and select **All**. + ![Package version type drop down menu showing option to list all versions](/assets/images/help/package-registry/make-all-container-versions-visible.png) +5. To the right of the version you want to delete, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} and select **Delete version**. + ![Delete package version button](/assets/images/help/package-registry/delete-container-package-version.png) 6. To confirm deletion, type the package name and click **I understand the consequences, delete this version**. - ![Confirm package deletion button](/assets/images/help/package-registry/confirm-package-deletion.png) + ![Confirm package deletion button](/assets/images/help/package-registry/confirm-container-package-version-deletion.png) ### Deleting a version of an organization-owned container image on {% data variables.product.prodname_dotcom %} +To only delete specific versions of a container image that you have admin , you can use these steps. To delete an entire package, see "[Deleting all versions of an organization-owned container image on {% data variables.product.prodname_dotcom %}](#deleting-all-versions-of-an-organization-owned-container-image-on-github)." + {% data reusables.package_registry.package-settings-from-org-level %} 5. On the left, click **Manage versions**. -5. To the right of the version you want to delete, click **Delete**. - ![Delete package button](/assets/images/help/package-registry/delete-package-button.png) +6. Optionally, to ensure you're seeing all of your package versions, use the "Type" drop down menu and select **All**. + ![Package version type drop down menu showing option to list all versions](/assets/images/help/package-registry/make-all-container-versions-visible.png) +5. To the right of the version you want to delete, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} and select **Delete version**. + ![Delete package version button](/assets/images/help/package-registry/delete-container-package-version.png) 6. To confirm deletion, type the package name and click **I understand the consequences, delete this version**. - ![Confirm package deletion button](/assets/images/help/package-registry/confirm-package-deletion.png) + ![Confirm package version deletion button](/assets/images/help/package-registry/confirm-container-package-version-deletion.png) + +### Deleting all versions of a user-owned container image on {% data variables.product.prodname_dotcom %} + +{% data reusables.package_registry.package-settings-from-user-level %} +5. On the left, click **Options**. + !["Options" menu option](/assets/images/help/package-registry/options-for-container-settings.png) +6. Under "Danger zone", click **Delete this package**. + ![Delete package version button](/assets/images/help/package-registry/delete-container-package-button.png) +6. To confirm deletion, type the package name and click **I understand the consequences, delete this package**. + ![Confirm package version deletion button](/assets/images/help/package-registry/confirm-container-package-deletion.png) + +### Deleting all versions of an organization-owned container image on {% data variables.product.prodname_dotcom %} + +{% data reusables.package_registry.package-settings-from-org-level %} +5. On the left, click **Options**. + !["Options" menu option](/assets/images/help/package-registry/options-for-container-settings.png) +6. Under "Danger zone", click **Delete this package**. + ![Delete package button](/assets/images/help/package-registry/delete-container-package-button.png) +6. To confirm deletion, type the package name and click **I understand the consequences, delete this package**. + ![Confirm package deletion button](/assets/images/help/package-registry/confirm-container-package-deletion.png) diff --git a/content/rest/overview/api-previews.md b/content/rest/overview/api-previews.md index 6ddbdbf669..e4f5ef4da8 100644 --- a/content/rest/overview/api-previews.md +++ b/content/rest/overview/api-previews.md @@ -80,17 +80,6 @@ Manage [projects](/rest/reference/projects). **Custom media type:** `cloak-preview` **Announced:** [2017-01-05](https://developer.github.com/changes/2017-01-05-commit-search-api/) -{% if currentVersion == "free-pro-team@latest" %} -### User blocking - -Users can [block other users](/rest/reference/users#blocking). Organizations can [block users](/rest/reference/orgs#blocking), too. - -**Custom media type:** `giant-sentry-fist-preview` -**Announced:** [2011-05-31](https://github.com/blog/862-block-the-bullies) -**Update 1:** [2016-04-04](https://github.com/blog/2146-organizations-can-now-block-abusive-users) -**Update 2:** [2016-08-17](https://github.com/blog/2229-see-the-users-you-ve-blocked-on-your-settings-page) -{% endif %} - ### Repository topics View a list of [repository topics](/articles/about-topics/) in [calls](/rest/reference/repos) that return repository results. diff --git a/content/rest/overview/libraries.md b/content/rest/overview/libraries.md index 68c9ab862b..58fbc8b43d 100644 --- a/content/rest/overview/libraries.md +++ b/content/rest/overview/libraries.md @@ -112,6 +112,7 @@ Library name | Repository Library name | Repository |---|---| +**gidgethub**|[brettcannon/gidgethub](https://github.com/brettcannon/gidgethub) **ghapi**|[fastai/ghapi](https://github.com/fastai/ghapi) **PyGithub**|[PyGithub/PyGithub](https://github.com/PyGithub/PyGithub) **libsaas**|[duckboard/libsaas](https://github.com/ducksboard/libsaas) diff --git a/content/rest/overview/resources-in-the-rest-api.md b/content/rest/overview/resources-in-the-rest-api.md index 0dce111619..062ccc1e80 100644 --- a/content/rest/overview/resources-in-the-rest-api.md +++ b/content/rest/overview/resources-in-the-rest-api.md @@ -42,8 +42,9 @@ $ curl -i {% data variables.product.api_url_pre %}/users/octocat/orgs > X-GitHub-Media-Type: github.v3 > X-RateLimit-Limit: 5000 > X-RateLimit-Remaining: 4987 -> X-RateLimit-Reset: 1350085394{% if currentVersion == "github-ae@latest" or enterpriseServerVersions contains currentVersion %} -> X-GitHub-Enterprise-Version: {{ currentVersion }}.0{% endif %} +> X-RateLimit-Reset: 1350085394{% if enterpriseServerVersions contains currentVersion %} +> X-GitHub-Enterprise-Version: {{ currentVersion | remove: "enterprise-server@" }}.0{% elsif currentVersion == "github-ae@latest" %} +> X-GitHub-Enterprise-Version: GitHub AE{% endif %} > Content-Length: 5 > Cache-Control: max-age=0, private, must-revalidate > X-Content-Type-Options: nosniff @@ -239,7 +240,7 @@ Error code name | Description -----------|-----------| `missing` | A resource does not exist. `missing_field` | A required field on a resource has not been set. -`invalid` | The formatting of a field is invalid. Review the documentation for the for more specific information. +`invalid` | The formatting of a field is invalid. Review the documentation for more specific information. `already_exists` | Another resource has the same value as this field. This can happen in resources that must have some unique key (such as label names). `unprocessable` | The inputs provided were invalid. @@ -270,7 +271,7 @@ Verb | Description `HEAD` | Can be issued against any resource to get just the HTTP header info. `GET` | Used for retrieving resources. `POST` | Used for creating resources. -`PATCH` | Used for updating resources with partial JSON data. For instance, an Issue resource has `title` and `body` attributes. A PATCH request may accept one or more of the attributes to update the resource. PATCH is a relatively new and uncommon HTTP verb, so resource endpoints also accept `POST` requests. +`PATCH` | Used for updating resources with partial JSON data. For instance, an Issue resource has `title` and `body` attributes. A `PATCH` request may accept one or more of the attributes to update the resource. `PUT` | Used for replacing resources or collections. For `PUT` requests with no `body` attribute, be sure to set the `Content-Length` header to zero. `DELETE` |Used for deleting resources. diff --git a/content/rest/reference/permissions-required-for-github-apps.md b/content/rest/reference/permissions-required-for-github-apps.md index 7712d9aea1..58461369ab 100644 --- a/content/rest/reference/permissions-required-for-github-apps.md +++ b/content/rest/reference/permissions-required-for-github-apps.md @@ -135,12 +135,12 @@ _Search_ - [`PATCH /repos/:owner/:repo`](/rest/reference/repos#update-a-repository) (:write) - [`DELETE /repos/:owner/:repo`](/rest/reference/repos#delete-a-repository) (:write) {% if currentVersion == "free-pro-team@latest" %} -- [`Get GET /repos/:owner/:repo/actions/runners/downloads`](/rest/reference/actions#list-runner-applications-for-a-repository) (:read) +- [`GET /repos/:owner/:repo/actions/runners/downloads`](/rest/reference/actions#list-runner-applications-for-a-repository) (:read) - [`GET /repos/:owner/:repo/actions/runners`](/rest/reference/actions#list-self-hosted-runners-for-a-repository) (:read) - [`GET /repos/:owner/:repo/actions/runners/:runner_id`](/rest/reference/actions#get-a-self-hosted-runner-for-a-repository) (:read) - [`DELETE /repos/:owner/:repo/actions/runners/:runner_id`](/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository) (:write) - [`POST /repos/:owner/:repo/actions/runners/registration-token`](/rest/reference/actions#create-a-registration-token-for-a-repository) (:write) -- [`POST /repos/:owner/:repo/actions/runners/remove-token`](/rest/reference/actions#create-a-remove-token-for-a-repository) (:write)git +- [`POST /repos/:owner/:repo/actions/runners/remove-token`](/rest/reference/actions#create-a-remove-token-for-a-repository) (:write) {% endif %} {% if currentVersion == "free-pro-team@latest" %} - [`PUT /repos/:owner/:repo/automated-security-fixes`](/rest/reference/repos#enable-automated-security-fixes) (:write) @@ -472,7 +472,7 @@ _Assignees_ _Events_ - [`GET /repos/:owner/:repo/issues/:issue_number/events`](/rest/reference/issues#list-issue-events) (:read) -- [Get an issue event](/rest/reference/issues#get-an-issue-event) (:read) +- [`GET /repos/:owner/:repo/issues/events/:event_id`](/rest/reference/issues#get-an-issue-event) (:read) _Labels_ - [`GET /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#list-labels-for-an-issue) (:read) diff --git a/contributing/content-markup-reference.md b/contributing/content-markup-reference.md index ed376df1a3..7e33130350 100644 --- a/contributing/content-markup-reference.md +++ b/contributing/content-markup-reference.md @@ -38,10 +38,10 @@ For information on when to use callout tags, see the [style guide](content-style To render syntax highlighting in command line instructions, we use triple backticks followed by the term `shell`. -### Usage - - ```shell - git init YOUR_REPO +### Usage + + ```shell + git init YOUR_REPO ``` This syntax highlighting renders light text on a dark background, and should be reserved for command line instructions. @@ -62,9 +62,11 @@ Octicons are icons used across GitHub’s interface. We reference Octicons when ### Usage -`{% octicon "" %}` -`{% octicon "plus" %}` -`{% octicon "plus" aria-label="The plus icon" %}` +``` +{% octicon "" %} +{% octicon "plus" %} +{% octicon "plus" aria-label="The plus icon" %} +``` ## Operating system tags @@ -79,6 +81,7 @@ These instructions are pertinent to Mac users. {% endmac %} ``` + ``` {% windows %} @@ -86,6 +89,7 @@ These instructions are pertinent to Windows users. {% endwindows %} ``` + ``` {% linux %} @@ -93,13 +97,8 @@ These instructions are pertinent to Windows users. {% endlinux %} ``` -``` -{% all %} -Though rare, these instructions are pertinent to any other operating system. - -{% endall %} -``` +You can define a default platform in the frontmatter, see the [content README](../content/README.md#defaultplatform). ## Reusable and variable strings of text diff --git a/contributing/troubleshooting.md b/contributing/troubleshooting.md index 41ffd6e5c0..e73eebb6e5 100644 --- a/contributing/troubleshooting.md +++ b/contributing/troubleshooting.md @@ -27,14 +27,14 @@ If a staging deployment is pending for more than 5-10min, try the following: 2. If that doesn't work, trigger a new staging deployment by pushing an empty commit on the command line: ``` -$ git commit --allow-empty -m'empty commit to redeploy staging' +$ git commit --allow-empty -m 'empty commit to redeploy staging' ``` ### CI stalled or stuck :yellow_heart: If tests are stuck yellow for more than an hour, rerun CI by pushing an empty commit on the command line: ``` -$ git commit --allow-empty -m'empty commit to rerun CI' +$ git commit --allow-empty -m 'empty commit to rerun CI' ``` ## Troubleshooting failed deployments and CI diff --git a/crowdin.yml b/crowdin.yml index abbc79bf19..df3cee19ae 100644 --- a/crowdin.yml +++ b/crowdin.yml @@ -4,6 +4,16 @@ files: ignore: - '/content/README.md' - '/content/early-access' + - '/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md' + - '/content/github/site-policy/github-enterprise-service-level-agreement.md' + - '/content/github/site-policy/github-enterprise-server-license-agreement.md' + - '/content/github/site-policy/github-supplemental-terms-for-microsoft-volume-licensing.md' + - '/content/github/site-policy/github-ae-product-specific-terms.md' + - '/content/github/site-policy/amendment-to-github-terms-of-service-applicable-to-us-federal-government-users.md' + - '/content/github/site-policy/github-enterprise-subscription-agreement.md' + - '/content/github/site-policy/github-data-protection-addendum.md' + - '/content/github/site-policy/github-connect-addendum-to-the-github-enterprise-license-agreement.md' + - '/content/github/site-policy/github-ae-data-protection-agreement.md' - source: /data/**/*.yml translation: /translations/%locale%/%original_path%/%original_file_name% - source: /data/**/*.md diff --git a/data/glossaries/external.yml b/data/glossaries/external.yml index 6819f8cce0..61afbe225e 100644 --- a/data/glossaries/external.yml +++ b/data/glossaries/external.yml @@ -128,7 +128,7 @@ - term: commit description: >- A commit, or "revision", is an individual change to a file (or set of - files). When you make a commit to save your work, Git creates a unique ID (a.k.a. the "SHA" or "hash") that allows you to keep record of the specific changes commited along with who made them and when. Commits usually contain a + files). When you make a commit to save your work, Git creates a unique ID (a.k.a. the "SHA" or "hash") that allows you to keep record of the specific changes committed along with who made them and when. Commits usually contain a commit message which is a brief description of what changes were made. - term: commit author description: The user who makes the commit. @@ -140,7 +140,7 @@ description: Also known as SHA. A 40-character checksum hash that identifies the commit. - term: commit message description: >- - Short, descriptive text that accompanys a commit and communicates the change + Short, descriptive text that accompanies a commit and communicates the change the commit is introducing. - term: compare branch description: >- @@ -406,9 +406,9 @@ convention and is not required. - term: master description: >- - The default branch in many Git repositories. By default, when you create - a new Git repository on the command line a branch called `master` is created. - Many tools now use an alternative name for the default branch. For example, + The default branch in many Git repositories. By default, when you create + a new Git repository on the command line a branch called `master` is created. + Many tools now use an alternative name for the default branch. For example, when you create a new repository on GitHub the default branch is called `main`. - term: Members graph description: A repository graph that shows all the forks of a repository. @@ -458,7 +458,7 @@ - term: notification description: >- Updates, delivered by either the web or email depending on your settings, - that give you information about the activites you're interested in. + that give you information about the activities you're interested in. - term: OAuth App description: >- A third-party application that uses access tokens rather than passwords to diff --git a/data/glossaries/internal.yml b/data/glossaries/internal.yml index dbf8272946..f62d72cec4 100644 --- a/data/glossaries/internal.yml +++ b/data/glossaries/internal.yml @@ -101,7 +101,7 @@ - term: CPU description: Central processing unit. - term: credential helper - description: A program that stores and fets Git credentials. + description: A program that stores and fetches Git credentials. - term: creole description: >- A lightweight markup language, aimed at being a common markup language for @@ -683,7 +683,7 @@ made but not yet committed. - term: WYSIWYG description: >- - What You See Is What You Get. An acryonym meaning the text on the screen + What You See Is What You Get. An acronym meaning the text on the screen looks exactly as it will when it's rendered. - term: XenServer description: A virtualization platform. diff --git a/data/release-notes/2-20/23.yml b/data/release-notes/2-20/23.yml new file mode 100644 index 0000000000..9fd06b50f7 --- /dev/null +++ b/data/release-notes/2-20/23.yml @@ -0,0 +1,12 @@ +date: '2020-12-17' +sections: + security_fixes: + - '**LOW:** High CPU usage could be triggered by a specially crafted request to the SVN bridge resulting in Denial of Service (DoS). {% comment %} https://github.com/github/slumlord/pull/1020, https://github.com/github/slumlord/pull/1017 {% endcomment %}' + - 'Packages have been updated to the latest security versions. {% comment %} https://github.com/github/enterprise2/pull/24351, https://github.com/github/enterprise2/pull/23866 {% endcomment %}' + known_issues: + - 'On a freshly set up GitHub Enterprise Server without any users, an attacker could create the first admin user. {% comment %} https://github.com/github/enterprise2/issues/1889 {% endcomment %}' + - 'Custom firewall rules are not maintained during an upgrade. {% comment %} https://github.com/github/enterprise2/issues/2823 {% endcomment %}' + - 'Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository. {% comment %} https://github.com/github/github/issues/54684 {% endcomment %}' + - 'Issues cannot be closed if they contain a permalink to a blob in the same repository where the file path is longer than 255 characters. {% comment %} https://github.com/github/github/issues/107731 {% endcomment %}' + - 'When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. {% comment %} https://github.com/github/admin-experience/issues/571 {% endcomment %}' + - 'Security alerts are not reported when pushing to a repository on the command line. {% comment %} https://github.com/github/github/issues/143190 {% endcomment %}' diff --git a/data/release-notes/2-21/14.yml b/data/release-notes/2-21/14.yml new file mode 100644 index 0000000000..c3c392375e --- /dev/null +++ b/data/release-notes/2-21/14.yml @@ -0,0 +1,12 @@ +date: '2020-12-17' +sections: + security_fixes: + - '**LOW:** High CPU usage could be triggered by a specially crafted request to the SVN bridge resulting in Denial of Service (DoS). {% comment %} https://github.com/github/slumlord/pull/1021, https://github.com/github/slumlord/pull/1017 {% endcomment %}' + - 'Packages have been updated to the latest security versions. {% comment %} https://github.com/github/enterprise2/pull/24352, https://github.com/github/enterprise2/pull/23866 {% endcomment %}' + known_issues: + - 'On a freshly set up GitHub Enterprise Server without any users, an attacker could create the first admin user. {% comment %} https://github.com/github/enterprise2/issues/1889 {% endcomment %}' + - 'Custom firewall rules are not maintained during an upgrade. {% comment %} https://github.com/github/enterprise2/issues/2823 {% endcomment %}' + - 'Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository. {% comment %} https://github.com/github/github/issues/54684 {% endcomment %}' + - 'Issues cannot be closed if they contain a permalink to a blob in the same repository where the file path is longer than 255 characters. {% comment %} https://github.com/github/github/issues/107731 {% endcomment %}' + - 'When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. {% comment %} https://github.com/github/admin-experience/issues/571 {% endcomment %}' + - 'Security alerts are not reported when pushing to a repository on the command line. {% comment %} https://github.com/github/github/issues/143190 {% endcomment %}' diff --git a/data/release-notes/2-22/0.yml b/data/release-notes/2-22/0.yml index 9fc838cbe5..97b50038a4 100644 --- a/data/release-notes/2-22/0.yml +++ b/data/release-notes/2-22/0.yml @@ -5,7 +5,7 @@ sections: - heading: GitHub Actions Beta notes: - | - [GitHub Actions](https://github.com/features/actions) is a powerful, flexible solution for CI/CD and workflow automation. GitHub Actions on Enteprise Server includes tools to help you manage the service, including key metrics in the Management Console, audit logs and access controls to help you control the roll out. + [GitHub Actions](https://github.com/features/actions) is a powerful, flexible solution for CI/CD and workflow automation. GitHub Actions on Enterprise Server includes tools to help you manage the service, including key metrics in the Management Console, audit logs and access controls to help you control the roll out. You will need to provide your own [storage](https://docs.github.com/en/enterprise/2.22/admin/github-actions/enabling-github-actions-and-configuring-storage) and runners for GitHub Actions. AWS S3, Azure Blob Storage and MinIO are supported. Please review the [updated minimum requirements for your platform](https://docs.github.com/en/enterprise/2.22/admin/installation/setting-up-a-github-enterprise-server-instance) before you turn on GitHub Actions. To learn more, contact the GitHub Sales team or [sign up for the beta](https://resources.github.com/beta-signup/). {% comment %} https://github.com/github/releases/issues/775 {% endcomment %} diff --git a/data/release-notes/2-22/6.yml b/data/release-notes/2-22/6.yml new file mode 100644 index 0000000000..82016efbf8 --- /dev/null +++ b/data/release-notes/2-22/6.yml @@ -0,0 +1,17 @@ +date: '2020-12-17' +sections: + security_fixes: + - '**LOW:** High CPU usage could be triggered by a specially crafted request to the SVN bridge resulting in Denial of Service (DoS). {% comment %} https://github.com/github/slumlord/pull/1022, https://github.com/github/slumlord/pull/1017 {% endcomment %}' + - 'Packages have been updated to the latest security versions. {% comment %} https://github.com/github/enterprise2/pull/24353, https://github.com/github/enterprise2/pull/23866 {% endcomment %}' + bugs: + - 'Requests for some file resources like a zip archive or raw file could enter a redirection loop. {% comment %} https://github.com/github/enterprise2/pull/24193, https://github.com/github/enterprise2/pull/24075 {% endcomment %}' + - 'A timeout could prevent some Issues and Pull Requests searches from providing complete search results. {% comment %} https://github.com/github/github/pull/164155, https://github.com/github/github/pull/163845 {% endcomment %}' + - 'Custom tabs with non-alphabetic characters in small screens did not render correctly. {% comment %} https://github.com/github/github/pull/164310, https://github.com/github/github/pull/164159 {% endcomment %}' + - 'An underlying behavior was causing failures when pushing content to a Git LFS-enabled repository. {% comment %} https://github.com/github/github/pull/164663, https://github.com/github/github/pull/150179 {% endcomment %}' + - 'In some rare cases issues could cause a 500 error when accessed via the web interface. {% comment %} https://github.com/github/github/pull/165298, https://github.com/github/github/pull/159674 {% endcomment %}' + known_issues: + - 'On a freshly set up GitHub Enterprise Server without any users, an attacker could create the first admin user. {% comment %} https://github.com/github/enterprise2/issues/1889 {% endcomment %}' + - 'Custom firewall rules are not maintained during an upgrade. {% comment %} https://github.com/github/enterprise2/issues/2823 {% endcomment %}' + - 'Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository. {% comment %} https://github.com/github/github/issues/54684 {% endcomment %}' + - 'Issues cannot be closed if they contain a permalink to a blob in the same repository where the file path is longer than 255 characters. {% comment %} https://github.com/github/github/issues/107731 {% endcomment %}' + - 'When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. {% comment %} https://github.com/github/admin-experience/issues/571 {% endcomment %}' diff --git a/data/reusables/actions/forked-secrets.md b/data/reusables/actions/forked-secrets.md new file mode 100644 index 0000000000..600bc85a95 --- /dev/null +++ b/data/reusables/actions/forked-secrets.md @@ -0,0 +1 @@ +With the exception of `GITHUB_TOKEN`, secrets are not passed to the runner when a workflow is triggered from a forked repository. diff --git a/data/reusables/advanced-security/more-info-ghas.md b/data/reusables/advanced-security/more-info-ghas.md new file mode 100644 index 0000000000..4a510456e9 --- /dev/null +++ b/data/reusables/advanced-security/more-info-ghas.md @@ -0,0 +1,3 @@ +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +For more information, see "[About {% data variables.product.prodname_GH_advanced_security %}](/github/getting-started-with-github/about-github-advanced-security)." +{% endif %} diff --git a/data/reusables/advanced-security/note-org-enable-uses-seats.md b/data/reusables/advanced-security/note-org-enable-uses-seats.md new file mode 100644 index 0000000000..48f3c5a99a --- /dev/null +++ b/data/reusables/advanced-security/note-org-enable-uses-seats.md @@ -0,0 +1,7 @@ +{% if currentVersion == "free-pro-team@latest" %} +{% note %} + +**Note:** If you enable {% data variables.product.prodname_GH_advanced_security %}, committers to these repositories will use seats on your {% data variables.product.prodname_GH_advanced_security %} license. + +{% endnote %} +{% endif %} \ No newline at end of file diff --git a/data/reusables/apps/marketplace_revenue_share.md b/data/reusables/apps/marketplace_revenue_share.md deleted file mode 100644 index 31b9cd8696..0000000000 --- a/data/reusables/apps/marketplace_revenue_share.md +++ /dev/null @@ -1,5 +0,0 @@ -{% note %} - -**Note:** As part of the [Marketplace Developer Agreement](/articles/github-marketplace-developer-agreement/), {% data variables.product.prodname_dotcom %} receives a 25% revenue share from {% data variables.product.prodname_marketplace %} listings. - -{% endnote %} diff --git a/data/reusables/code-scanning/codeql-runner-license.md b/data/reusables/code-scanning/codeql-runner-license.md index 689b46e679..c60abccd58 100644 --- a/data/reusables/code-scanning/codeql-runner-license.md +++ b/data/reusables/code-scanning/codeql-runner-license.md @@ -4,7 +4,7 @@ **Note:** The {% data variables.product.prodname_codeql_runner %} uses the {% data variables.product.prodname_codeql %} CLI to analyze code and therefore has the same license conditions. It's free to use on public repositories that are maintained on {% data variables.product.prodname_dotcom_the_website %}, and available to use on private repositories that are owned by customers with an {% data variables.product.prodname_advanced_security %} license. For information, see "[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} Terms and Conditions](https://securitylab.github.com/tools/codeql/license)" and "[{% data variables.product.prodname_codeql %} CLI](https://help.semmle.com/codeql/codeql-cli.html)." {% else %} -**Note:** The {% data variables.product.prodname_codeql_runner %} is available to customers with an {% data variables.product.prodname_advanced_security %} license. +**Note:** The {% data variables.product.prodname_codeql_runner %} is available to customers with an {% data variables.product.prodname_advanced_security %} license. {% if currentVersion ver_gt "enterprise-server@2.22" %}For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/about-github-advanced-security)."{% endif %} {% endif %} {% endnote %} diff --git a/data/reusables/code-scanning/not-available.md b/data/reusables/code-scanning/not-available.md new file mode 100644 index 0000000000..6531f5e1d0 --- /dev/null +++ b/data/reusables/code-scanning/not-available.md @@ -0,0 +1,7 @@ +{% if currentVersion == "free-pro-team@latest" %} +{% note %} + +**Note:** For private and internal repositories, {% data variables.product.prodname_code_scanning %} is available when {% data variables.product.prodname_GH_advanced_security %} features are enabled for the repository. If you see the error `Advanced Security must be enabled for this repository to use code scanning.` check that {% data variables.product.prodname_GH_advanced_security %} is enabled. For more information, see "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)." + +{% endnote %} +{% endif %} diff --git a/data/reusables/dependabot/private-dependencies-note.md b/data/reusables/dependabot/private-dependencies-note.md index b8d2b78cbc..18554c0ce1 100644 --- a/data/reusables/dependabot/private-dependencies-note.md +++ b/data/reusables/dependabot/private-dependencies-note.md @@ -1,3 +1,3 @@ -When running version updates, {% data variables.product.prodname_dependabot %} must be able to resolve all dependencies from their source to verify that version updates have been successful. If your manifest or lock files contain any dependencies hosted in private {% data variables.product.prodname_dotcom %} repositories within your organization, {% data variables.product.prodname_dependabot %} must be able to access those repositories. Organization owners can configure this. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private-repositories)." +When running security or version updates, some ecosystems must be able to resolve all dependencies from their source to verify that updates have been successful. If your manifest or lock files contain any private dependencies, {% data variables.product.prodname_dependabot %} must be able to access the location at which those dependencies are hosted. Organization owners can grant {% data variables.product.prodname_dependabot %} access to private repositories containing dependencies for a project within the same organization. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private-repositories)." -Currently, {% data variables.product.prodname_dependabot %} version updates doesn't support manifest or lock files that contain any dependencies hosted in private registries, or in private {% data variables.product.prodname_dotcom %} repositories that belong to a different organization than the dependent project. \ No newline at end of file +Currently, {% data variables.product.prodname_dependabot %} version updates doesn't support manifest or lock files that contain any dependencies hosted in private registries, or in private {% data variables.product.prodname_dotcom %} repositories that belong to a different organization than the dependent project. diff --git a/data/reusables/dependabot/supported-package-managers.md b/data/reusables/dependabot/supported-package-managers.md index 1e1b077d71..7ad0bf0e8e 100644 --- a/data/reusables/dependabot/supported-package-managers.md +++ b/data/reusables/dependabot/supported-package-managers.md @@ -25,7 +25,7 @@ Terraform: `terraform` | **✓** | | -`yarn` (v1 only) (specify `npm`) --`.gradle.tks` files, for Kotlin projects (specify `gradle`) +-`.gradle.kts` files, for Kotlin projects (specify `gradle`) -`pipenv`, `pip-compile`, and `poetry` (specify `pip`) diff --git a/data/reusables/developer-site/pull_request_forked_repos_link.md b/data/reusables/developer-site/pull_request_forked_repos_link.md index fe27ee7924..144420eb2f 100644 --- a/data/reusables/developer-site/pull_request_forked_repos_link.md +++ b/data/reusables/developer-site/pull_request_forked_repos_link.md @@ -10,4 +10,4 @@ When you create a pull request from a forked repository to the base repository, Workflows don't run on forked repositories by default. You must enable GitHub Actions in the **Actions** tab of the forked repository. -The permissions for the `GITHUB_TOKEN` in forked repositories is read-only. For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)." +{% data reusables.actions.forked-secrets %} The permissions for the `GITHUB_TOKEN` in forked repositories is read-only. For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)." diff --git a/data/reusables/gated-features/code-scanning.md b/data/reusables/gated-features/code-scanning.md index 2bcd80c1d4..69e6abf27f 100644 --- a/data/reusables/gated-features/code-scanning.md +++ b/data/reusables/gated-features/code-scanning.md @@ -1 +1 @@ -{% data variables.product.prodname_code_scanning_capc %} is available {% if currentVersion == "free-pro-team@latest" %}in public repositories, and in private repositories owned by organizations with {% else %}if you have {% endif %}an {% data variables.product.prodname_advanced_security %} license. {% data reusables.gated-features.more-info %} +{% if currentVersion == "free-pro-team@latest" %}{% data variables.product.prodname_code_scanning_capc %} is available for all public repositories and for private repositories owned by organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled.{% else %}{% data variables.product.prodname_code_scanning_capc %} is available if you have a license for {% data variables.product.prodname_GH_advanced_security %}.{% endif %} {% data reusables.advanced-security.more-info-ghas %} diff --git a/data/reusables/gated-features/environments.md b/data/reusables/gated-features/environments.md index 77cd45f6aa..916fe9c1d3 100644 --- a/data/reusables/gated-features/environments.md +++ b/data/reusables/gated-features/environments.md @@ -1 +1 @@ -{% data reusables.gated-features.actions-shared %} Environments, environment protection rules, and environment secrets are available in public repositories for all products and in private repositories for {% data variables.product.prodname_ghe_server %}. {% if currentVersion == "free-pro-team@latest" %}{% data reusables.gated-features.more-info %}{% endif %} +{% data reusables.gated-features.actions-shared %} Environments, environment protection rules, and environment secrets are available in public repositories for all products and in private repositories for {% data variables.product.prodname_enterprise %}. {% if currentVersion == "free-pro-team@latest" %}{% data reusables.gated-features.more-info %}{% endif %} diff --git a/data/reusables/gated-features/secret-scanning.md b/data/reusables/gated-features/secret-scanning.md index bd279034ee..7396ad8e24 100644 --- a/data/reusables/gated-features/secret-scanning.md +++ b/data/reusables/gated-features/secret-scanning.md @@ -1 +1 @@ -{% data variables.product.prodname_secret_scanning_caps %} is available in public repositories, and in private repositories owned by organizations with an {% data variables.product.prodname_advanced_security %} license. {% data reusables.gated-features.more-info %} +{% data variables.product.prodname_secret_scanning_caps %} is available {% if currentVersion == "free-pro-team@latest" %}in public repositories, and in private repositories owned by organizations with {% else %}if you have {% endif %}an {% data variables.product.prodname_advanced_security %} license. {% data reusables.advanced-security.more-info-ghas %} diff --git a/data/reusables/organizations/can-require-ssh-cert.md b/data/reusables/organizations/can-require-ssh-cert.md index 6da3776323..1ed5f3afb9 100644 --- a/data/reusables/organizations/can-require-ssh-cert.md +++ b/data/reusables/organizations/can-require-ssh-cert.md @@ -1 +1 @@ -You can require that members use SSH certificates to access organization resources,, unless SSH is disabled in your repository. +You can require that members use SSH certificates to access organization resources, unless SSH is disabled in your repository. diff --git a/data/reusables/organizations/click-codespaces.md b/data/reusables/organizations/click-codespaces.md new file mode 100644 index 0000000000..6e5dcf3e41 --- /dev/null +++ b/data/reusables/organizations/click-codespaces.md @@ -0,0 +1,2 @@ +1. In the left sidebar, click **Codespaces**. +!["Codespaces" tab in left sidebar](/assets/images/help/organizations/codespaces-sidebar-tab.png) diff --git a/data/reusables/repositories/return-to-source-diff.md b/data/reusables/repositories/return-to-source-diff.md new file mode 100644 index 0000000000..c918830348 --- /dev/null +++ b/data/reusables/repositories/return-to-source-diff.md @@ -0,0 +1,5 @@ +1. You may also want to review the source diff, because there could be changes to the manifest or lock file that don't change dependencies, or there could be dependencies that {% data variables.product.prodname_dotcom %} can't parse and which, as a result, don't appear in the dependency review. + + To return to the source diff view, click the **{% octicon "code" aria-label="The source diff icon" %}** button. + + ![The source diff button](/assets/images/help/pull_requests/dependency-review-source-diff.png) diff --git a/data/reusables/support/ghae-priorities.md b/data/reusables/support/ghae-priorities.md index 028e6d1858..ea6cd23bc6 100644 --- a/data/reusables/support/ghae-priorities.md +++ b/data/reusables/support/ghae-priorities.md @@ -1,6 +1,6 @@ | Priority | Description | Examples | | :---: | --- | --- | | {% data variables.product.support_ticket_priority_urgent %} - Sev A | {% data variables.product.product_name %} is inaccessible or failing entirely, and the failure directly impacts the operation of your business.

_After you file a support ticket, reach out to {% data variables.contact.github_support %} via phone._ |
  • Errors or outages that affect core Git or web application functionality for all users
  • Severe network or performance degradation for majority of users
  • Full or rapidly filling storage
  • Known security incidents or a breach of access
| -| {% data variables.product.support_ticket_priority_high %} - Sev B | {% data variables.product.product_name %} is failing in a production environment, with limited impact to your business processes, or only affecting certain customers. |
  • Performance degradation that reduces productivity for many users
  • Reduced redundancy concerns from failures or service degradation
  • Production-impacting bugs or errors
  • {% data variables.product.product_name %} configuraton security concerns
| +| {% data variables.product.support_ticket_priority_high %} - Sev B | {% data variables.product.product_name %} is failing in a production environment, with limited impact to your business processes, or only affecting certain customers. |
  • Performance degradation that reduces productivity for many users
  • Reduced redundancy concerns from failures or service degradation
  • Production-impacting bugs or errors
  • {% data variables.product.product_name %} configuration security concerns
| | {% data variables.product.support_ticket_priority_normal %} - Sev C | {% data variables.product.product_name %} is experiencing limited or moderate issues and errors with {% data variables.product.product_name %}, or you have general concerns or questions about the operation of {% data variables.product.product_name %}. |
  • Advice on using {% data variables.product.prodname_dotcom %} APIs and features, or questions about integrating business workflows
  • Issues with user tools and data collection methods
  • Upgrades
  • Bug reports, general security questions, or other feature related questions
    • | | {% data variables.product.support_ticket_priority_low %} - Sev D| {% data variables.product.product_name %} is functioning as expected, however, you have a question or suggestion about {% data variables.product.product_name %} that is not time-sensitive, or does not otherwise block the productivity of your team. |
    • Feature requests and product feedback
    • General questions on overall configuration or use of {% data variables.product.product_name %}
    • Notifying {% data variables.contact.github_support %} of any planned changes
    | diff --git a/data/reusables/user_settings/codespaces-secret-repository-access.md b/data/reusables/user_settings/codespaces-secret-repository-access.md new file mode 100644 index 0000000000..5fb6bc49ee --- /dev/null +++ b/data/reusables/user_settings/codespaces-secret-repository-access.md @@ -0,0 +1,2 @@ +1. Select the "Repository access" drop-down menu, then click a repository you want to have access to the secret. Repeat for every repository you want to have access to the secret. + !["Repository access" drop-down menu](/assets/images/help/settings/codespaces-secret-repository-access-drop-down.png) \ No newline at end of file diff --git a/data/reusables/user_settings/codespaces-secret-value.md b/data/reusables/user_settings/codespaces-secret-value.md new file mode 100644 index 0000000000..9f19b0d20c --- /dev/null +++ b/data/reusables/user_settings/codespaces-secret-value.md @@ -0,0 +1,2 @@ +1. Under "Value", type the value of your secret. + !["Value" textbox](/assets/images/help/settings/codespaces-secret-value-field.png) \ No newline at end of file diff --git a/data/reusables/user_settings/codespaces-tab.md b/data/reusables/user_settings/codespaces-tab.md new file mode 100644 index 0000000000..631477d1d7 --- /dev/null +++ b/data/reusables/user_settings/codespaces-tab.md @@ -0,0 +1,2 @@ +1. In the left sidebar, click **Codespaces**. +![Codespaces tab in the user settings sidebar](/assets/images/help/settings/codespaces-tab.png) \ No newline at end of file diff --git a/data/variables/action_code_examples.yml b/data/variables/action_code_examples.yml index aca1b38b79..ddce4d8684 100644 --- a/data/variables/action_code_examples.yml +++ b/data/variables/action_code_examples.yml @@ -256,7 +256,7 @@ - automation - title: Distribute funding in free and open source projects description: Continuous Distribution of funding to project contributors and dependencies - languages: 'Python, Docerfile, Shell, Ruby' + languages: 'Python, Dockerfile, Shell, Ruby' href: protontypes/libreselery tags: - sponsors @@ -273,7 +273,7 @@ - pull request - title: Codeowner validator description: Ensures the correctness of your GitHub CODEOWNERS file, supports public and private GitHub repositories and also GitHub Enterprise installations - languages: 'Go, Shell, Makefile, Docerfile' + languages: 'Go, Shell, Makefile, Dockerfile' href: mszostok/codeowners-validator tags: - codeowners diff --git a/data/variables/product.yml b/data/variables/product.yml index 16ef0bcf1e..211d5f32b1 100644 --- a/data/variables/product.yml +++ b/data/variables/product.yml @@ -110,6 +110,7 @@ prodname_sponsors: 'GitHub Sponsors' prodname_matching_fund: 'GitHub Sponsors Matching Fund' # GitHub Advanced Security +prodname_GH_advanced_security: 'GitHub Advanced Security' prodname_advanced_security: 'Advanced Security' # Codespaces diff --git a/includes/all-articles.html b/includes/all-articles.html index d0cfe2054c..49074536ed 100644 --- a/includes/all-articles.html +++ b/includes/all-articles.html @@ -8,7 +8,7 @@ {% for category in product.categories %} {% unless category[1].standalone %}
    -

    {{ category[1].title }}

    +

    {{ category[1].title }}

    {% if category[1].maptopics %}
      @@ -16,7 +16,7 @@ {% unless maptopic[1].hidden %} {% assign numArticles = category[1].maptopics | obj_size %}
    • - + {{ maptopic[1].title }}
      • @@ -30,7 +30,7 @@ {% if numArticles > maxArticles %} diff --git a/includes/article.html b/includes/article.html index 3920419c6b..1d8d315b3f 100644 --- a/includes/article.html +++ b/includes/article.html @@ -2,7 +2,7 @@
      {% include article-version-switcher %}
      -
      +
      {% include breadcrumbs %}
      {% include article-version-switcher %}
      @@ -29,12 +29,12 @@ {% endif %} {% if page.includesPlatformSpecificContent %} -
      ` - // Santize the link's href attribute using the DOM API to prevent XSS + // Sanitize the link's href attribute using the DOM API to prevent XSS const fragment = document.createRange().createContextualFragment(html) fragment.querySelector('a').setAttribute('href', item.modifiedURL) const div = document.createElement('div') @@ -69,7 +69,7 @@ export default function () { const opts = { // https://www.algolia.com/apps/ZI5KPY1HBE/dashboard - // This API key is public. There's also a private API key for writing to the Aloglia API + // This API key is public. There's also a private API key for writing to the Algolia API searchClient: algoliasearch('ZI5KPY1HBE', '685df617246c3a10abba589b4599288f'), // There's an index for every version/language combination diff --git a/layouts/graphql-explorer.html b/layouts/graphql-explorer.html index 23fe4cc7eb..7f61637049 100644 --- a/layouts/graphql-explorer.html +++ b/layouts/graphql-explorer.html @@ -11,13 +11,13 @@
      -
      +
      {% include breadcrumbs %}

      {{ page.title }}

      - +