diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index f501ff8f19..4d69dce013 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -31,6 +31,7 @@ "bierner.markdown-preview-github-styles", "streetsidesoftware.code-spell-checker", "alistairchristie.open-reusables", + "AlistairChristie.version-identifier", "GitHub.copilot", "GitHub.copilot-chat" ] diff --git a/.devcontainer/library-scripts/github-debian.sh b/.devcontainer/library-scripts/github-debian.sh index 2d474fdefa..1a7a177c18 100644 --- a/.devcontainer/library-scripts/github-debian.sh +++ b/.devcontainer/library-scripts/github-debian.sh @@ -4,7 +4,7 @@ # Licensed under the MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license information. #------------------------------------------------------------------------------------------------------------- # -# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/github.md +# Docs: https://github.com/microsoft/vscode-dev-containers/blob/main/script-library/docs/github-cli.md # # Syntax: ./github-debian.sh [version] diff --git a/.devcontainer/test-custom-devcontainer/devcontainer.json b/.devcontainer/test-custom-devcontainer/devcontainer.json deleted file mode 100644 index 587805e006..0000000000 --- a/.devcontainer/test-custom-devcontainer/devcontainer.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "name": "Test postCreateCommand", - "image": "mcr.microsoft.com/devcontainers/universal:linux", - - "settings": { - "terminal.integrated.shell.linux": "/bin/zsh", - }, - - // Visual Studio Code extensions which help authoring for docs.github.com. - "extensions": [ - "dbaeumer.vscode-eslint", - "sissel.shopify-liquid" - ], - - "hostRequirements": { - "cpus": 8, - "memory": "8gb", - "storage": "32gb" - }, - - // Use 'forwardPorts' to make a list of ports inside the container available locally. - "forwardPorts": [5000], - - // Use 'postCreateCommand' to run commands after the container is created. - "postCreateCommand": "echo Added: `date` > aaa-TEST.txt" - -} diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c881233bec..d551eb19e1 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -13,8 +13,8 @@ Use the table of contents icon > $GITHUB_ENV - - - uses: ./.github/actions/node-npm-setup - - - name: Create translation health report - env: - POPULAR_PAGES_JSON: popular-pages/records/popular-pages.json - run: | - npm run create-translation-health-report -- \ - --language ${{ matrix.language }} \ - --gitref ${{ env.gitref }} \ - >> $GITHUB_WORKSPACE/translation-health-report.json - - - name: View report in workflow - run: cat $GITHUB_WORKSPACE/translation-health-report.json - - - name: Log in to Azure - uses: azure/login@92a5484dfaf04ca78a94597f4f19fea633851fa2 # pin @v1.4.6 - with: - creds: ${{ secrets.PROD_AZURE_CREDENTIALS }} - - # https://learn.microsoft.com/en-us/cli/azure/storage/blob?view=azure-cli-latest#az-storage-blob-upload - # https://github.com/marketplace/actions/azure-cli-action - - name: Upload latest to Azure blob storage - uses: azure/CLI@b0e31ae20280d899279f14c36e877b4c6916e2d3 # pin @v1.0.8 - with: - inlineScript: | - az storage blob upload \ - --name "${{ matrix.language }}-latest.json" \ - --file $GITHUB_WORKSPACE/translation-health-report.json \ - --account-name githubdocs \ - --account-key ${{ secrets.AZURE_GITHUBDOCS_STORAGE_KEY }} \ - --container-name translation-health-reports \ - --overwrite true - - - name: Upload date formatted to Azure blob storage - uses: azure/CLI@b0e31ae20280d899279f14c36e877b4c6916e2d3 # pin @v1.0.8 - with: - inlineScript: | - # Write a date formatted for historical reference - az storage blob upload \ - --name "${{ matrix.language }}-$(date +%Y-%m-%d).json" \ - --file $GITHUB_WORKSPACE/translation-health-report.json \ - --account-name githubdocs \ - --account-key ${{ secrets.AZURE_GITHUBDOCS_STORAGE_KEY }} \ - --container-name translation-health-reports \ - --overwrite true - - - name: Log out from Azure - if: always() - run: | - az logout - - - uses: ./.github/actions/slack-alert - if: ${{ failure() && github.event_name != 'workflow_dispatch' }} - with: - slack_channel_id: ${{ secrets.DOCS_ALERTS_SLACK_CHANNEL_ID }} - slack_token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }} diff --git a/assets/images/help/actions/overview-actions-using-concurrency-expressions-and-a-test-matrix.png b/assets/images/help/actions/overview-actions-using-concurrency-expressions-and-a-test-matrix.png index d520037202..0edabd7269 100644 Binary files a/assets/images/help/actions/overview-actions-using-concurrency-expressions-and-a-test-matrix.png and b/assets/images/help/actions/overview-actions-using-concurrency-expressions-and-a-test-matrix.png differ diff --git a/content/account-and-profile/index.md b/content/account-and-profile/index.md index 0176d5c715..dee404770f 100644 --- a/content/account-and-profile/index.md +++ b/content/account-and-profile/index.md @@ -7,9 +7,7 @@ introLinks: featuredLinks: startHere: - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/changing-your-github-username - - '{% ifversion ghae %}/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/about-your-personal-dashboard{% endif %}' - /account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme - - '{% ifversion ghae %}/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile{% endif %}' - /account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications popular: - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address @@ -19,7 +17,7 @@ featuredLinks: - /account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile - /account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address - - '{% ifversion ghes or ghae %}/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories{% endif %}' + - '{% ifversion ghes %}/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories{% endif %}' changelog: label: 'profiles, github-themes, notifications' versions: @@ -40,4 +38,3 @@ children: - /setting-up-and-managing-your-github-profile - /managing-subscriptions-and-notifications-on-github --- - diff --git a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md b/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md index c1fb800ce1..d36eba2310 100644 --- a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md +++ b/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md @@ -18,7 +18,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Notifications @@ -68,11 +67,6 @@ When you watch a repository, you're subscribing to updates for activity in that To see repositories that you're watching, go to your [watching page](https://github.com/watching). For more information, see "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github)." -{% ifversion ghae %} - -### Configuring notifications - -{% endif %} You can configure notifications for a repository on the repository page, or on your watching page. ### About custom notifications @@ -138,7 +132,7 @@ Email notifications from {% data variables.location.product_location %} contain | Header | Information | | --- | --- | | `From` address | This address will always be {% ifversion fpt or ghec %}'`notifications@github.com`'{% else %}'the no-reply email address configured by your site administrator'{% endif %}. | -| `To` field | This field connects directly to the thread.{% ifversion not ghae %} If you reply to the email, you'll add a new comment to the conversation.{% endif %} | +| `To` field | This field connects directly to the thread. If you reply to the email, you'll add a new comment to the conversation. | | `Cc` address | {% data variables.product.product_name %} will `Cc` you if you're subscribed to a conversation. The second `Cc` email address matches the notification reason. The suffix for these notification reasons is {% data variables.notifications.cc_address %}. The possible notification reasons are: | | `List-Id` field | This field identifies the name of the repository and its owner. The format of this address is always `OWNER/REPOSITORY `, e.g. `List-Id: grain-lang/grain `. | | `X-GitHub-Severity` field | {% data reusables.repositories.security-alerts-x-github-severity %} The possible severity levels are:For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." | @@ -187,7 +181,7 @@ If you belong to an organization, you can choose the email account you want noti {% data reusables.notifications.access_notifications %} {% data reusables.notifications-v2.manage-notifications %} 1. Under "Default notifications email", select the email address you'd like notifications sent to. -{% ifversion ghes or ghae %} +{% ifversion ghes %} 1. Click **Save**.{% endif %} ### Customizing email routes per organization diff --git a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md b/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md index aca931dd54..ee58f920d1 100644 --- a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md +++ b/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md @@ -9,7 +9,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Notifications @@ -97,7 +96,7 @@ To add a `repo:` filter, you must include the owner of the repository in the que ### Supported `is:` queries -To filter notifications for specific activity on {% data variables.location.product_location %}, you can use the `is` query. For example, to only see repository invitation updates, use `is:repository-invitation`{% ifversion not ghae %}, and to only see {% data variables.product.prodname_dependabot_alerts %}, use `is:repository-vulnerability-alert`{% endif %}. +To filter notifications for specific activity on {% data variables.location.product_location %}, you can use the `is` query. For example, to only see repository invitation updates, use `is:repository-invitation`, and to only see {% data variables.product.prodname_dependabot_alerts %}, use `is:repository-vulnerability-alert`. - `is:check-suite` - `is:commit` @@ -162,12 +161,3 @@ If you use {% data variables.product.prodname_dependabot %} to keep your depende For more information about {% data variables.product.prodname_dependabot %}, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." {% endif %} - -{% ifversion ghae %} - -If you use {% data variables.product.prodname_dependabot %} to tell you about insecure dependencies, you can use and save these custom filters to show notifications for {% data variables.product.prodname_dependabot_alerts %}: -- `is:repository_vulnerability_alert` -- `reason:security_alert` - -For more information about {% data variables.product.prodname_dependabot %}, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." -{% endif %} diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile.md b/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile.md index b266b55095..cb3705d628 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile.md @@ -13,7 +13,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Profiles @@ -59,7 +58,7 @@ If you use Gravatar, and your Gravatar image is associated with the email you us {% data reusables.user-settings.access_settings %} 1. Under "Profile Picture", select {% octicon "pencil" aria-hidden="true" %} **Edit**, then click **Remove photo** to revert to your identicon. - {% ifversion not ghae %}If your email address is associated with a [Gravatar](https://en.gravatar.com/), you cannot revert to your identicon. Click **Revert to Gravatar** instead.{% endif %} + If your email address is associated with a [Gravatar](https://en.gravatar.com/), you cannot revert to your identicon. Click **Revert to Gravatar** instead. ![Screenshot of the "Public profile" section of a user account's settings. A button, labeled with a pencil icon and "Edit", is outlined in dark orange.](/assets/images/help/profile/edit-profile-photo.png) diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile.md b/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile.md index 0d7620ac1d..6970efdd44 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile.md @@ -11,7 +11,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Profiles @@ -59,14 +58,4 @@ To send enterprise contributions from {% data variables.product.prodname_ghe_ser 1. Review the resources that {% data variables.product.prodname_ghe_server %} will access from your {% data variables.product.prodname_dotcom_the_website %} account, then click **Authorize**. {% data reusables.github-connect.send-contribution-counts-to-githubcom %} -{% elsif ghae %} - -1. Sign in to {% data variables.product.prodname_ghe_managed %} and {% data variables.product.prodname_dotcom_the_website %}. -1. On {% data variables.product.prodname_ghe_managed %}, in the upper-right corner of any page, click your profile photo, then click **Settings**. - ![Screenshot of a user's account menu on {% data variables.product.prodname_dotcom %}. The menu item "Settings" is outlined in dark orange.](/assets/images/help/settings/userbar-account-settings.png) -{% data reusables.github-connect.github-connect-tab-user-settings %} -{% data reusables.github-connect.connect-dotcom-and-enterprise %} -{% data reusables.github-connect.authorize-connection %} -{% data reusables.github-connect.send-contribution-counts-to-githubcom %} - {% endif %} diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile.md b/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile.md index 5c9f8b6538..1bd7bf38cd 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile.md @@ -9,7 +9,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Profiles @@ -20,7 +19,7 @@ If you publicize your private contributions, people without access to the privat {% note %} -**Note:** {% ifversion fpt or ghes or ghec %}On {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% elsif ghes %}{% data variables.product.product_name %}{% endif %}, public contributions on your profile are visible {% ifversion fpt or ghec %}to anyone in the world who can access {% data variables.product.prodname_dotcom_the_website %}{% elsif ghes %}only to other users of {% data variables.location.product_location%}{% endif %}.{% elsif ghae %}On {% data variables.product.prodname_ghe_managed %}, only other members of your enterprise can see the contributions on your profile.{% endif %} +**Note:** On {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% elsif ghes %}{% data variables.product.product_name %}{% endif %}, public contributions on your profile are visible {% ifversion fpt or ghec %}to anyone in the world who can access {% data variables.product.prodname_dotcom_the_website %}{% elsif ghes %}only to other users of {% data variables.location.product_location%}{% endif %}. {% endnote %} diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile.md b/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile.md index b61f237c53..bfd536c102 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile.md @@ -10,7 +10,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Profiles @@ -34,7 +33,7 @@ On your profile page, certain actions count as contributions: - Opening a discussion - Answering a discussion - Proposing a pull request -- Submitting a pull request review{% ifversion ghes or ghae %} +- Submitting a pull request review{% ifversion ghes %} - Co-authoring commits in a repository's default branch or `gh-pages` branch{% endif %} {% data reusables.pull_requests.pull_request_merges_and_contributions %} @@ -96,4 +95,4 @@ If you can't see certain events in your timeline, check to make sure you still h ## Viewing contributions from {% data variables.product.prodname_enterprise %} on {% data variables.product.prodname_dotcom_the_website %} -If you use {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae %} or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} and your enterprise owner enables {% data variables.enterprise.prodname_unified_contributions %}, you can send enterprise contribution counts to your {% data variables.product.prodname_dotcom_the_website %} profile. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)." +If you use {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% else %}{% data variables.product.product_name %}{% endif %} and your enterprise owner enables {% data variables.enterprise.prodname_unified_contributions %}, you can send enterprise contribution counts to your {% data variables.product.prodname_dotcom_the_website %} profile. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)." diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile.md b/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile.md index fbf080f9d0..64b79c2f14 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile.md @@ -9,7 +9,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Profiles @@ -18,7 +17,7 @@ shortTitle: Missing contributions ## About your contribution graph -Your profile contributions graph is a record of contributions you've made to repositories {% ifversion ghae %}owned by{% else %}on{% endif %} {% data variables.location.product_location %}. Contributions are timestamped according to Coordinated Universal Time (UTC) rather than your local time zone. Contributions are only counted if they meet certain criteria. In some cases, we may need to rebuild your graph in order for contributions to appear. +Your profile contributions graph is a record of contributions you've made to repositories on {% data variables.location.product_location %}. Contributions are timestamped according to Coordinated Universal Time (UTC) rather than your local time zone. Contributions are only counted if they meet certain criteria. In some cases, we may need to rebuild your graph in order for contributions to appear. If you are part of an organization that uses SAML single sign-on (SSO), you won’t be able to see contribution activity from the organization on your profile if you do not have an active SSO session. People viewing your profile from outside your organization will see anonymized contribution activity of your contribution activity for your organization. @@ -68,9 +67,9 @@ Date: Sun, 27 Apr 2014 15:36:39 +0530 Subject: [PATCH] updated index for better welcome message ``` -The email address in the `From:` field is the address that was set in the [local git config settings](/get-started/quickstart/set-up-git). In this example, the email address used for the commit is `octocat@nowhere.com`. +The email address in the `From:` field is the address that was set in the [local git config settings](/get-started/getting-started-with-git/set-up-git). In this example, the email address used for the commit is `octocat@nowhere.com`. -If the email address used for the commit is not connected to your account on {% data variables.location.product_location %}, {% ifversion ghae %}change the email address used to author commits in Git. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-in-git)."{% else %}you must [add the email address](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account) to your account on {% data variables.location.product_location %}. Your contributions graph will be rebuilt automatically when you add the new address.{% endif %} +If the email address used for the commit is not connected to your account on {% data variables.location.product_location %}, you must [add the email address](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account) to your account on {% data variables.location.product_location %}. Your contributions graph will be rebuilt automatically when you add the new address. {% ifversion fpt or ghec %} {% note %} diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md index 1fc0bfd537..3d7ba8a2d9 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md @@ -12,7 +12,6 @@ product: '{% data reusables.gated-features.user-repo-collaborators %}' versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Accounts @@ -35,7 +34,7 @@ If you're a member of an {% data variables.enterprise.prodname_emu_enterprise %} ## Inviting a collaborator to a personal repository -You can send an invitation to collaborate in your repository directly to someone on {% data variables.location.product_location %}{% ifversion fpt or ghec %}, or to the person's email address{% elsif ghes or ghae %}.{% endif %} +You can send an invitation to collaborate in your repository directly to someone on {% data variables.location.product_location %}{% ifversion fpt or ghec %}, or to the person's email address{% elsif ghes %}.{% endif %} {% ifversion fpt or ghec %} diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/index.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/index.md index 10004ee3ec..60ed65e1da 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/index.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/index.md @@ -1,6 +1,6 @@ --- title: Managing email preferences -intro: 'You can add or change the email addresses associated with your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}. You can also manage emails you receive from {% data variables.product.product_name %}.' +intro: 'You can add or change the email addresses associated with your account on {% data variables.location.product_location %}. You can also manage emails you receive from {% data variables.product.product_name %}.' redirect_from: - /categories/managing-email-preferences - /articles/managing-email-preferences diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address.md index 14da8bac36..40894516cb 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address.md @@ -16,7 +16,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Accounts @@ -27,7 +26,7 @@ shortTitle: Set commit email address {% data variables.product.prodname_dotcom %} uses your commit email address to associate commits with your account on {% data variables.location.product_location %}. You can choose the email address that will be associated with the commits you push from the command line as well as web-based Git operations you make. -For web-based Git operations, you can set your commit email address on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}. For commits you push from the command line, you can set your commit email address in Git. +For web-based Git operations, you can set your commit email address on {% data variables.location.product_location %}. For commits you push from the command line, you can set your commit email address in Git. {% ifversion fpt or ghec %}Any commits you made prior to changing your commit email address are still associated with your previous email address.{% else %}After changing your commit email address on {% data variables.product.product_name %}, the new email address will be visible in all of your future web-based Git operations by default. Any commits you made prior to changing your commit email address are still associated with your previous email address.{% endif %} @@ -45,7 +44,7 @@ For web-based Git operations, you can set your commit email address on {% ifvers You can also choose to block commits you push from the command line that expose your personal email address. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address)."{% endif %} -To ensure that commits are attributed to you and appear in your contributions graph, use an email address that is connected to your account on {% data variables.location.product_location %}{% ifversion fpt or ghec %}, or the `noreply` email address provided to you in your email settings{% endif %}. {% ifversion not ghae %}For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account)."{% endif %} +To ensure that commits are attributed to you and appear in your contributions graph, use an email address that is connected to your account on {% data variables.location.product_location %}{% ifversion fpt or ghec %}, or the `noreply` email address provided to you in your email settings{% endif %}. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account)." {% ifversion fpt or ghec %} diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address.md index 184ce49913..92926b3f96 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address.md @@ -27,7 +27,7 @@ If you do not verify your email address, you will not be able to: - Generate {% data variables.product.pat_generic %}s - Receive email notifications - Star repositories -- Create or update project boards, including adding cards +- Create or update projects - Create or update gists - Create or use {% data variables.product.prodname_actions %} - Sponsor developers with {% data variables.product.prodname_sponsors %} diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/about-your-personal-dashboard.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/about-your-personal-dashboard.md index f25e9705cd..9ecb7f206f 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/about-your-personal-dashboard.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/about-your-personal-dashboard.md @@ -44,7 +44,7 @@ In the left sidebar of your dashboard, you can access the top repositories and t The list of top repositories is automatically generated, and can include any repository you have interacted with, whether it's owned directly by your account or not. Interactions include making commits and opening or commenting on issues and pull requests. The list of top repositories cannot be edited, but repositories will drop off the list 1 year after you last interacted with them. -You can also find a list of your recently visited repositories, teams, and project boards when you click into the search bar at the top of any page on {% data variables.product.product_name %}. +You can also find a list of your recently visited repositories, teams, and projects when you click into the search bar at the top of any page on {% data variables.product.product_name %}. ## Staying updated with activity from the community diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-access-to-your-personal-accounts-project-boards.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-access-to-your-personal-accounts-project-boards.md index 7bd8ca5148..773a1440b2 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-access-to-your-personal-accounts-project-boards.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-access-to-your-personal-accounts-project-boards.md @@ -1,6 +1,6 @@ --- -title: Managing access to your personal account's project boards -intro: 'As a project board owner, you can add or remove a collaborator and customize their permissions to a project board.' +title: 'Managing access to your personal account''s {% data variables.projects.projects_v1_boards %}' +intro: 'As a {% data variables.projects.projects_v1_board %} owner, you can add or remove a collaborator and customize their permissions to a {% data variables.projects.projects_v1_board %}.' redirect_from: - /articles/managing-project-boards-in-your-repository-or-organization - /articles/managing-access-to-your-user-account-s-project-boards @@ -16,13 +16,14 @@ versions: ghec: '*' topics: - Accounts -shortTitle: Manage access project boards +shortTitle: 'Manage {% data variables.projects.projects_v1_boards %} access' +allowTitleToDifferFromFilename: true --- -A collaborator is a person who has permissions to a project board you own. A collaborator's permissions will default to read access. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/permission-levels-for-a-project-board-owned-by-a-personal-account)." +A collaborator is a person who has permissions to a {% data variables.projects.projects_v1_board %} you own. A collaborator's permissions will default to read access. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/permission-levels-for-a-project-board-owned-by-a-personal-account)." -## Inviting collaborators to a user-owned project board +## Inviting collaborators to a user-owned {% data variables.projects.projects_v1_board %} -1. Navigate to the project board where you want to add an collaborator. +1. Navigate to the {% data variables.projects.projects_v1_board %} where you want to add an collaborator. {% data reusables.project-management.click-menu %} {% data reusables.project-management.access-collaboration-settings %} {% data reusables.project-management.collaborator-option %} @@ -30,7 +31,7 @@ A collaborator is a person who has permissions to a project board you own. A col {% data reusables.project-management.add-collaborator %} 1. The new collaborator has read permissions by default. Optionally, next to the new collaborator's name, use the drop-down menu and choose a different permission level. -## Removing a collaborator from a user-owned project board +## Removing a collaborator from a user-owned {% data variables.projects.projects_v1_board %} {% data reusables.project-management.click-menu %} {% data reusables.project-management.access-collaboration-settings %} diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-accessibility-settings.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-accessibility-settings.md index b2259d1d50..fa89d78e3d 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-accessibility-settings.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-accessibility-settings.md @@ -12,9 +12,9 @@ type: how_to ## About accessibility settings -To create an experience on {% ifversion fpt or ghec or ghes %}{% data variables.location.product_location %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %} that fits your needs, you can customize the user interface. Accessibility settings can be essential for people with disabilities, but can be useful to anyone. For example, customization of keyboard shortcuts is essential to people who navigate using voice control, but can be useful to anyone when a keyboard shortcut for {% data variables.product.product_name %} clashes with another application shortcut. +To create an experience on {% data variables.location.product_location %} that fits your needs, you can customize the user interface. Accessibility settings can be essential for people with disabilities, but can be useful to anyone. For example, customization of keyboard shortcuts is essential to people who navigate using voice control, but can be useful to anyone when a keyboard shortcut for {% data variables.product.product_name %} clashes with another application shortcut. -You can decide whether you want to use some or all keyboard shortcuts on {% ifversion fpt or ghec %}{% data variables.location.product_location %}{% elsif ghes or ghae %}the website for {% data variables.location.product_location %}{% endif %} and you can also control the display of animated images{% ifversion link-underlines %} and how links are displayed{% endif %}. +You can decide whether you want to use some or all keyboard shortcuts on {% ifversion fpt or ghec %}{% data variables.location.product_location %}{% elsif ghes %}the website for {% data variables.location.product_location %}{% endif %} and you can also control the display of animated images{% ifversion link-underlines %} and how links are displayed{% endif %}. {% ifversion link-underlines %} @@ -31,10 +31,10 @@ You can control whether links in text blocks on {% data variables.location.produ {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.accessibility_settings %} 1. Under "Content", manage settings for link appearance. - + - To enable underlines on links in text blocks, under "Link underlines", select **Show link underlines**. - To disable underlines on links in text blocks, under "Link underlines", select **Hide link underlines**. - + {% endif %} ## Managing keyboard shortcuts diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/permission-levels-for-a-personal-account-repository.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/permission-levels-for-a-personal-account-repository.md index 26f541bf46..e1ba38c900 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/permission-levels-for-a-personal-account-repository.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/permission-levels-for-a-personal-account-repository.md @@ -10,7 +10,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Accounts @@ -85,7 +84,7 @@ Collaborators can also perform the following actions. | Submit a review on a pull request that affects the mergeability of the pull request | "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)" | | Create and edit a wiki for the repository | "[AUTOTITLE](/communities/documenting-your-project-with-wikis/about-wikis)" | | Create and edit releases for the repository | "[AUTOTITLE](/repositories/releasing-projects-on-github/managing-releases-in-a-repository)" | -| Act as a code owner for the repository | "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)" |{% ifversion fpt or ghae or ghec %} +| Act as a code owner for the repository | "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)" |{% ifversion fpt or ghec %} | Publish, view, or install packages | "[AUTOTITLE](/packages/learn-github-packages)" |{% endif %} | Remove themselves as collaborators on the repository | "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-yourself-from-a-collaborators-repository)" | diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/permission-levels-for-a-project-board-owned-by-a-personal-account.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/permission-levels-for-a-project-board-owned-by-a-personal-account.md index 701011bb09..59b619bf95 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/permission-levels-for-a-project-board-owned-by-a-personal-account.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/permission-levels-for-a-project-board-owned-by-a-personal-account.md @@ -1,6 +1,6 @@ --- -title: Permission levels for a project board owned by a personal account -intro: 'A project board owned by a personal account has two permission levels: the project board owner and collaborators.' +title: 'Permission levels for a {% data variables.projects.projects_v1_board %} owned by a personal account' +intro: 'A {% data variables.projects.projects_v1_board %} owned by a personal account has two permission levels: the {% data variables.projects.projects_v1_board %} owner and collaborators.' redirect_from: - /articles/permission-levels-for-user-owned-project-boards - /github/setting-up-and-managing-your-github-user-account/permission-levels-for-user-owned-project-boards @@ -10,55 +10,55 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Accounts -shortTitle: Project board permissions +shortTitle: '{% data variables.projects.projects_v1_board_caps %} permissions' +allowTitleToDifferFromFilename: true --- ## Permissions overview -There is only one owner of a user-owned project board; this permission cannot be shared with another personal account. In addition to the owner, other people can collaborate on project boards. +There is only one owner of a user-owned {% data variables.projects.projects_v1_board %}; this permission cannot be shared with another personal account. In addition to the owner, other people can collaborate on {% data variables.projects.projects_v1_boards %}. -There are three levels of permissions for project board collaborators: +There are three levels of permissions for {% data variables.projects.projects_v1_board %} collaborators: {% data reusables.project-management.project-board-permissions %} -## Owner and admin permissions for a user-owned project board +## Owner and admin permissions for a user-owned {% data variables.projects.projects_v1_board %} -The project board owner and collaborators with admin access have full control of the project board. In addition to all the permissions allowed by project board collaborators, a project board owner and collaborator with admin access can: +The {% data variables.projects.projects_v1_board %} owner and collaborators with admin access have full control of the {% data variables.projects.projects_v1_board %}. In addition to all the permissions allowed by {% data variables.projects.projects_v1_board %} collaborators, a {% data variables.projects.projects_v1_board %} owner and collaborator with admin access can: -- [Manage, view, and add collaborators](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-access-to-your-personal-accounts-project-boards) -- [Configure a project board as {% ifversion ghae %}internal{% else %}public{% endif %} or private](/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility) -- [Delete a project board](/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board) -- [Close a project board](/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board) -- [Reopen a closed project board](/issues/organizing-your-work-with-project-boards/managing-project-boards/reopening-a-closed-project-board) +- [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-access-to-your-personal-accounts-project-boards) +- [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility) +- [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board) +- [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board) +- [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/reopening-a-closed-project-board) -## Read and write permissions for a user-owned project board +## Read and write permissions for a user-owned {% data variables.projects.projects_v1_board %} -Collaborators with read access to a user-owned project board can: +Collaborators with read access to a user-owned {% data variables.projects.projects_v1_board %} can: -- View a project board -- Copy a project board -- Filter cards on a project board +- View a {% data variables.projects.projects_v1_board %} +- Copy a {% data variables.projects.projects_v1_board %} +- Filter cards on a {% data variables.projects.projects_v1_board %} -Collaborators with write access to a user-owned project board can: +Collaborators with write access to a user-owned {% data variables.projects.projects_v1_board %} can: -- View a project board -- Copy a project board -- Filter cards on a project board -- Edit a project board -- Link a repository to a project board -- Configure automation for project boards -- Copy a project board -- Add issues and pull requests to a project board -- Add notes to a project board -- Track progress on your project board -- Archive cards on a project board +- View a {% data variables.projects.projects_v1_board %} +- Copy a {% data variables.projects.projects_v1_board %} +- Filter cards on a {% data variables.projects.projects_v1_board %} +- Edit a {% data variables.projects.projects_v1_board %} +- Link a repository to a {% data variables.projects.projects_v1_board %} +- Configure automation for {% data variables.projects.projects_v1_boards %} +- Copy a {% data variables.projects.projects_v1_board %} +- Add issues and pull requests to a {% data variables.projects.projects_v1_board %} +- Add notes to a {% data variables.projects.projects_v1_board %} +- Track progress on your {% data variables.projects.projects_v1_board %} +- Archive cards on a {% data variables.projects.projects_v1_board %} -## Project board visibility +## {% data variables.projects.projects_v1_board_caps %} visibility -You can change the project board's visibility from private to {% ifversion ghae %}internal{% else %}public{% endif %} and back again. By default, user-owned project boards are private. For more information, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility)." +You can change the {% data variables.projects.projects_v1_board %}'s visibility from private to {% ifversion ghae %}internal{% else %}public{% endif %} and back again. By default, user-owned {% data variables.projects.projects_v1_boards %} are private. For more information, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility)." ## Further reading diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md index 8c84da2b37..0cf4f7df3e 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md @@ -55,7 +55,7 @@ Before you delete your personal account, make a copy of all repositories, privat {% warning %} -**Warning:** Once your personal account has been deleted, {% ifversion fpt or ghec %}{% data variables.product.company_short %}{% elsif ghes or ghae %}an enterprise owner{% endif %} cannot restore your content. +**Warning:** Once your personal account has been deleted, {% ifversion fpt or ghec %}{% data variables.product.company_short %}{% elsif ghes %}an enterprise owner{% endif %} cannot restore your content. {% endwarning %} diff --git a/content/actions/automating-builds-and-tests/about-continuous-integration.md b/content/actions/automating-builds-and-tests/about-continuous-integration.md index 1d2189b869..911d4bf214 100644 --- a/content/actions/automating-builds-and-tests/about-continuous-integration.md +++ b/content/actions/automating-builds-and-tests/about-continuous-integration.md @@ -10,7 +10,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' type: overview topics: @@ -30,9 +29,7 @@ Building and testing your code requires a server. You can build and test updates ## About continuous integration using {% data variables.product.prodname_actions %} -{% ifversion ghae %}CI using {% data variables.product.prodname_actions %} offers workflows that can build the code in your repository and run your tests. Workflows can run on runner systems that you host. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)." -{% else %} CI using {% data variables.product.prodname_actions %} offers workflows that can build the code in your repository and run your tests. Workflows can run on {% data variables.product.prodname_dotcom %}-hosted virtual machines, or on machines that you host yourself. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners)" and "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)." -{% endif %} + CI using {% data variables.product.prodname_actions %} offers workflows that can build the code in your repository and run your tests. Workflows can run on {% data variables.product.prodname_dotcom %}-hosted virtual machines, or on machines that you host yourself. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners)" and "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)." You can configure your CI workflow to run when a {% data variables.product.prodname_dotcom %} event occurs (for example, when new code is pushed to your repository), on a set schedule, or when an external event occurs using the repository dispatch webhook. diff --git a/content/actions/automating-builds-and-tests/building-and-testing-go.md b/content/actions/automating-builds-and-tests/building-and-testing-go.md index dea32c55f7..96ef8ea780 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-go.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-go.md @@ -4,24 +4,20 @@ intro: You can create a continuous integration (CI) workflow to build and test y versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' type: tutorial topics: - CI shortTitle: Build & test Go --- - + {% data reusables.actions.enterprise-github-hosted-runners %} ## Introduction This guide shows you how to build, test, and publish a Go package. -{% ifversion ghae %} -{% data reusables.actions.self-hosted-runners-software %} -{% else %} {% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with preinstalled software, which includes the dependencies for Go. For a full list of up-to-date software and the preinstalled versions of Go, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners#preinstalled-software)." -{% endif %} +{% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with preinstalled software, which includes the dependencies for Go. For a full list of up-to-date software and the preinstalled versions of Go, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners#preinstalled-software)." ## Prerequisites @@ -44,7 +40,7 @@ We recommend that you have a basic understanding of the Go language. For more in ![Screenshot of the "Choose a workflow" page. The "Configure" button on the "Go" workflow is highlighted with an orange outline.](/assets/images/help/actions/starter-workflow-go.png) -{%- ifversion ghes or ghae %} +{%- ifversion ghes %} If you don't find the "Go - by {% data variables.product.prodname_actions %}" starter workflow, copy the following workflow code to a new file called `go.yml` in the `.github/workflows` directory of your repository. ```yaml copy diff --git a/content/actions/automating-builds-and-tests/building-and-testing-java-with-ant.md b/content/actions/automating-builds-and-tests/building-and-testing-java-with-ant.md index ffdc9ece7f..addee74c79 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-java-with-ant.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-java-with-ant.md @@ -7,7 +7,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' type: tutorial topics: @@ -23,11 +22,7 @@ shortTitle: Build & test Java & Ant This guide shows you how to create a workflow that performs continuous integration (CI) for your Java project using the Ant build system. The workflow you create will allow you to see when commits to a pull request cause build or test failures against your default branch; this approach can help ensure that your code is always healthy. You can extend your CI workflow to upload artifacts from a workflow run. -{% ifversion ghae %} -{% data reusables.actions.self-hosted-runners-software %} -{% else %} {% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes Java Development Kits (JDKs) and Ant. For a list of software and the pre-installed versions for JDK and Ant, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-software)". -{% endif %} ## Prerequisites @@ -51,7 +46,7 @@ We recommend that you have a basic understanding of Java and the Ant framework. 1. The "{% ifversion actions-starter-template-ui %}Choose a workflow{% else %}Choose a workflow template{% endif %}" page shows a selection of recommended starter workflows. Search for "Java with Ant". 1. On the "Java with Ant" workflow, click {% ifversion actions-starter-template-ui %}**Configure**{% else %}**Set up this workflow**{% endif %}. -{%- ifversion ghes or ghae %} +{%- ifversion ghes %} If you don't find the "Java with Ant" starter workflow, copy the following workflow code to a new file called `ant.yml` in the `.github/workflows` directory of your repository. diff --git a/content/actions/automating-builds-and-tests/building-and-testing-java-with-gradle.md b/content/actions/automating-builds-and-tests/building-and-testing-java-with-gradle.md index b3387b5e8a..d40bab4812 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-java-with-gradle.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-java-with-gradle.md @@ -7,7 +7,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' type: tutorial topics: @@ -23,11 +22,7 @@ shortTitle: Build & test Java & Gradle This guide shows you how to create a workflow that performs continuous integration (CI) for your Java project using the Gradle build system. The workflow you create will allow you to see when commits to a pull request cause build or test failures against your default branch; this approach can help ensure that your code is always healthy. You can extend your CI workflow to {% ifversion actions-caching %}cache files and{% endif %} upload artifacts from a workflow run. -{% ifversion ghae %} -{% data reusables.actions.self-hosted-runners-software %} -{% else %} {% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes Java Development Kits (JDKs) and Gradle. For a list of software and the pre-installed versions for JDK and Gradle, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-software)". -{% endif %} ## Prerequisites @@ -51,7 +46,7 @@ We recommend that you have a basic understanding of Java and the Gradle framewor 1. The "{% ifversion actions-starter-template-ui %}Choose a workflow{% else %}Choose a workflow template{% endif %}" page shows a selection of recommended starter workflows. Search for "Java with Gradle". 1. On the "Java with Gradle" workflow, click {% ifversion actions-starter-template-ui %}**Configure**{% else %}**Set up this workflow**{% endif %}. -{%- ifversion ghes or ghae %} +{%- ifversion ghes %} If you don't find the "Java with Gradle" starter workflow, copy the following workflow code to a new file called `gradle.yml` in the `.github/workflows` directory of your repository. diff --git a/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md b/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md index 51648c6c7a..758d5c5fd4 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-java-with-maven.md @@ -7,7 +7,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' type: tutorial topics: @@ -23,11 +22,7 @@ shortTitle: Build & test Java with Maven This guide shows you how to create a workflow that performs continuous integration (CI) for your Java project using the Maven software project management tool. The workflow you create will allow you to see when commits to a pull request cause build or test failures against your default branch; this approach can help ensure that your code is always healthy. You can extend your CI workflow to {% ifversion actions-caching %}cache files and{% endif %} upload artifacts from a workflow run. -{% ifversion ghae %} -{% data reusables.actions.self-hosted-runners-software %} -{% else %} {% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes Java Development Kits (JDKs) and Maven. For a list of software and the pre-installed versions for JDK and Maven, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-software)". -{% endif %} ## Prerequisites @@ -51,7 +46,7 @@ We recommend that you have a basic understanding of Java and the Maven framework 1. The "{% ifversion actions-starter-template-ui %}Choose a workflow{% else %}Choose a workflow template{% endif %}" page shows a selection of recommended starter workflows. Search for "Java with Maven". 1. On the "Java with Maven" workflow, click {% ifversion actions-starter-template-ui %}**Configure**{% else %}**Set up this workflow**{% endif %}. -{%- ifversion ghes or ghae %} +{%- ifversion ghes %} If you don't find the "Java with Maven" starter workflow, copy the following workflow code to a new file called `maven.yml` in the `.github/workflows` directory of your repository. diff --git a/content/actions/automating-builds-and-tests/building-and-testing-net.md b/content/actions/automating-builds-and-tests/building-and-testing-net.md index ddd040e677..e0561112a6 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-net.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-net.md @@ -6,7 +6,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' shortTitle: Build & test .NET --- @@ -17,9 +16,7 @@ shortTitle: Build & test .NET This guide shows you how to build, test, and publish a .NET package. -{% ifversion ghae %} To build and test your .NET project on {% data variables.product.prodname_ghe_managed %}, the .NET Core SDK is required. {% data reusables.actions.self-hosted-runners-software %} -{% else %} {% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with preinstalled software, which includes the .NET Core SDK. For a full list of up-to-date software and the preinstalled versions of .NET Core SDK, see [software installed on {% data variables.product.prodname_dotcom %}-hosted runners](/actions/using-github-hosted-runners/about-github-hosted-runners). -{% endif %} + {% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with preinstalled software, which includes the .NET Core SDK. For a full list of up-to-date software and the preinstalled versions of .NET Core SDK, see [software installed on {% data variables.product.prodname_dotcom %}-hosted runners](/actions/using-github-hosted-runners/about-github-hosted-runners). ## Prerequisites @@ -39,7 +36,7 @@ We recommend that you have a basic understanding of the .NET Core SDK. For more 1. The "{% ifversion actions-starter-template-ui %}Choose a workflow{% else %}Choose a workflow template{% endif %}" page shows a selection of recommended starter workflows. Search for "dotnet". 1. On the ".NET" workflow, click {% ifversion actions-starter-template-ui %}**Configure**{% else %}**Set up this workflow**{% endif %}. -{%- ifversion ghes or ghae %} +{%- ifversion ghes %} If you don't find the ".NET" starter workflow, copy the following workflow code to a new file called `dotnet.yml` in the `.github/workflows` directory of your repository. diff --git a/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md b/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md index 5ff4fcf675..be8d4145b0 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md @@ -8,7 +8,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' type: tutorial topics: @@ -46,7 +45,7 @@ We recommend that you have a basic understanding of Node.js, YAML, workflow conf 1. Filter the selection of workflows by clicking **Continuous integration**. 1. On the "Node.js" workflow, click {% ifversion actions-starter-template-ui %}**Configure**{% else %}**Set up this workflow**{% endif %}. -{%- ifversion ghes or ghae %} +{%- ifversion ghes %} If you don't find the "Node.js" starter workflow, copy the following workflow code to a new file called `node.js.yml` in the `.github/workflows` directory of your repository. @@ -144,9 +143,7 @@ jobs: ``` If you don't specify a Node.js version, {% data variables.product.prodname_dotcom %} uses the environment's default Node.js version. -{% ifversion ghae %} {% data reusables.actions.self-hosted-runners-software %} -{% else %} For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-software)". -{% endif %} +For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-software)". ## Installing dependencies diff --git a/content/actions/automating-builds-and-tests/building-and-testing-powershell.md b/content/actions/automating-builds-and-tests/building-and-testing-powershell.md index 7aa9b81362..53710fb8f8 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-powershell.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-powershell.md @@ -6,7 +6,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' authors: - potatoqualitee @@ -25,10 +24,7 @@ This guide shows you how to use PowerShell for CI. It describes how to use Peste {% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes PowerShell and Pester. -{% ifversion ghae %} -{% data reusables.actions.self-hosted-runners-software %} -{% else %}For a full list of up-to-date software and the pre-installed versions of PowerShell and Pester, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-software)". -{% endif %} +For a full list of up-to-date software and the pre-installed versions of PowerShell and Pester, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-software)". ## Prerequisites diff --git a/content/actions/automating-builds-and-tests/building-and-testing-python.md b/content/actions/automating-builds-and-tests/building-and-testing-python.md index 382740ee72..af9dcfc4c8 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-python.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-python.md @@ -8,7 +8,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' type: tutorial topics: @@ -23,10 +22,7 @@ shortTitle: Build & test Python This guide shows you how to build, test, and publish a Python package. -{% ifversion ghae %} -{% data reusables.actions.self-hosted-runners-software %} -{% else %} {% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes Python and PyPy. You don't have to install anything! For a full list of up-to-date software and the pre-installed versions of Python and PyPy, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-software)". -{% endif %} +{% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes Python and PyPy. You don't have to install anything! For a full list of up-to-date software and the pre-installed versions of Python and PyPy, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-software)". ## Prerequisites @@ -51,7 +47,7 @@ We recommend that you have a basic understanding of Python, and pip. For more in 1. The "{% ifversion actions-starter-template-ui %}Choose a workflow{% else %}Choose a workflow template{% endif %}" page shows a selection of recommended starter workflows. Search for "Python application". 1. On the "Python application" workflow, click {% ifversion actions-starter-template-ui %}**Configure**{% else %}**Set up this workflow**{% endif %}. -{%- ifversion ghes or ghae %} +{%- ifversion ghes %} If you don't find the "Python application" starter workflow, copy the following workflow code to a new file called `python-app.yml` in the `.github/workflows` directory of your repository. diff --git a/content/actions/automating-builds-and-tests/building-and-testing-ruby.md b/content/actions/automating-builds-and-tests/building-and-testing-ruby.md index 56a78b6168..321c6d7f48 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-ruby.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-ruby.md @@ -6,7 +6,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' type: tutorial topics: @@ -41,7 +40,7 @@ We recommend that you have a basic understanding of Ruby, YAML, workflow configu 1. Filter the selection of workflows by clicking **Continuous integration**. 1. On the "Ruby" workflow, click {% ifversion actions-starter-template-ui %}**Configure**{% else %}**Set up this workflow**{% endif %}. -{%- ifversion ghes or ghae %} +{%- ifversion ghes %} If you don't find the "Ruby" starter workflow, copy the following workflow code to a new file called `ruby.yml` in the `.github/workflows` directory of your repository. diff --git a/content/actions/automating-builds-and-tests/building-and-testing-swift.md b/content/actions/automating-builds-and-tests/building-and-testing-swift.md index 8c6fe8b8a3..062984dff0 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-swift.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-swift.md @@ -6,7 +6,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' type: tutorial topics: @@ -21,8 +20,7 @@ shortTitle: Build & test Swift This guide shows you how to build and test a Swift package. -{% ifversion ghae %} To build and test your Swift project on {% data variables.product.prodname_ghe_managed %}, the necessary Swift dependencies are required. {% data reusables.actions.self-hosted-runners-software %} -{% else %}{% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with preinstalled software, and the Ubuntu and macOS runners include the dependencies for building Swift packages. For a full list of up-to-date software and the preinstalled versions of Swift and Xcode, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-software)."{% endif %} +{% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with preinstalled software, and the Ubuntu and macOS runners include the dependencies for building Swift packages. For a full list of up-to-date software and the preinstalled versions of Swift and Xcode, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-software)." ## Prerequisites @@ -43,7 +41,7 @@ We recommend that you have a basic understanding of Swift packages. For more inf 1. Filter the selection of workflows by clicking **Continuous integration**. 1. On the "Swift" workflow, click {% ifversion actions-starter-template-ui %}**Configure**{% else %}**Set up this workflow**{% endif %}. -{%- ifversion ghes or ghae %} +{%- ifversion ghes %} If you don't find the "Swift" starter workflow, copy the following workflow code to a new file called `swift.yml` in the `.github/workflows` directory of your repository. @@ -95,7 +93,6 @@ You can configure your job to use multiple versions of Swift in a matrix. {% data reusables.actions.actions-use-sha-pinning-comment %} - name: Swift on: [push] diff --git a/content/actions/creating-actions/creating-a-composite-action.md b/content/actions/creating-actions/creating-a-composite-action.md index a7881d5dab..9208652014 100644 --- a/content/actions/creating-actions/creating-a-composite-action.md +++ b/content/actions/creating-actions/creating-a-composite-action.md @@ -7,7 +7,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' type: tutorial defaultPlatform: linux @@ -27,7 +26,7 @@ Once you complete this project, you should understand how to build your own comp ## Prerequisites -Before you begin, you'll create a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}. +Before you begin, you'll create a repository on {% data variables.location.product_location %}. 1. Create a new public repository on {% data variables.location.product_location %}. You can choose any repository name, or use the following `hello-world-composite-action` example. You can add these files after your project has been pushed to {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/creating-a-new-repository)." diff --git a/content/actions/creating-actions/creating-a-docker-container-action.md b/content/actions/creating-actions/creating-a-docker-container-action.md index 87f719e60e..8386bad645 100644 --- a/content/actions/creating-actions/creating-a-docker-container-action.md +++ b/content/actions/creating-actions/creating-a-docker-container-action.md @@ -10,7 +10,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' type: tutorial topics: @@ -184,7 +183,7 @@ git push --follow-tags Now you're ready to test your action out in a workflow. {% ifversion private-actions %}- When an action is in a private repository, you can control who can access it. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)."{% else %}- When an action is in a private repository, the action can only be used in workflows in the same repository.{% endif %} -{% ifversion ghes or ghec or ghae %}{% ifversion internal-actions %}- When an action is in an internal repository, you can control who can access it. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)."{% else %}- When an action is in an internal repository, the action can only be used in workflows in the same repository.{% endif %}{% endif %} +{% ifversion ghes or ghec %}{% ifversion internal-actions %}- When an action is in an internal repository, you can control who can access it. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)."{% else %}- When an action is in an internal repository, the action can only be used in workflows in the same repository.{% endif %}{% endif %} - Public actions can be used by workflows in any repository. {% data reusables.actions.enterprise-marketplace-actions %} diff --git a/content/actions/creating-actions/creating-a-javascript-action.md b/content/actions/creating-actions/creating-a-javascript-action.md index 806f5655a5..67aaee7f9f 100644 --- a/content/actions/creating-actions/creating-a-javascript-action.md +++ b/content/actions/creating-actions/creating-a-javascript-action.md @@ -10,7 +10,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' type: tutorial topics: @@ -215,7 +214,7 @@ Checking in your `node_modules` directory can cause problems. As an alternative, Now you're ready to test your action out in a workflow. -Public actions can be used by workflows in any repository. When an action is in a private{% ifversion ghec or ghes or ghae%} or internal{% endif %} repository, the repository settings dictate whether the action is available only within the same repository or also to other repositories owned by the same {% ifversion ghec or ghes or ghae %}organization or enterprise{% else %}user or organization{% endif %}. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)." +Public actions can be used by workflows in any repository. When an action is in a private{% ifversion ghec or ghes %} or internal{% endif %} repository, the repository settings dictate whether the action is available only within the same repository or also to other repositories owned by the same {% ifversion ghec or ghes %}organization or enterprise{% else %}user or organization{% endif %}. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)." {% data reusables.actions.enterprise-marketplace-actions %} 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 22495f6fe7..fc2fe04643 100644 --- a/content/actions/creating-actions/metadata-syntax-for-github-actions.md +++ b/content/actions/creating-actions/metadata-syntax-for-github-actions.md @@ -10,7 +10,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' type: reference --- @@ -366,7 +365,7 @@ runs: last_name: Octocat ``` -{% ifversion ghes or ghae %} +{% ifversion ghes %} #### `runs.steps[*].continue-on-error` diff --git a/content/actions/creating-actions/releasing-and-maintaining-actions.md b/content/actions/creating-actions/releasing-and-maintaining-actions.md index 75f0eaa1dd..f39967f529 100644 --- a/content/actions/creating-actions/releasing-and-maintaining-actions.md +++ b/content/actions/creating-actions/releasing-and-maintaining-actions.md @@ -13,7 +13,7 @@ versions: ghes: '*' ghae: '*' --- - + {% data reusables.actions.enterprise-github-hosted-runners %} ## Introduction @@ -56,7 +56,7 @@ To support the developer process in the next section, add two {% data variables. Here is an example process that you can follow to automatically run tests, create a release{% ifversion fpt or ghec%} and publish to {% data variables.product.prodname_marketplace %}{% endif %}, and publish your action. -1. Do feature work in branches per GitHub flow. For more information, see "[AUTOTITLE](/get-started/quickstart/github-flow)." +1. Do feature work in branches per GitHub flow. For more information, see "[AUTOTITLE](/get-started/using-github/github-flow)." - Whenever a commit is pushed to the feature branch, your testing workflow will automatically run the tests. 1. Create pull requests to the `main` branch to initiate discussion and review, merging when ready. diff --git a/content/actions/deployment/about-deployments/deploying-with-github-actions.md b/content/actions/deployment/about-deployments/deploying-with-github-actions.md index f092af08ac..a7611e068e 100644 --- a/content/actions/deployment/about-deployments/deploying-with-github-actions.md +++ b/content/actions/deployment/about-deployments/deploying-with-github-actions.md @@ -147,7 +147,7 @@ You can also view the logs of each workflow run and the history of workflow runs ## Tracking deployments through apps {% ifversion fpt or ghec %} -If your personal account or organization on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} is integrated with Microsoft Teams or Slack, you can track deployments that use environments through Microsoft Teams or Slack. For example, you can receive notifications through the app when a deployment is pending approval, when a deployment is approved, or when the deployment status changes. For more information about integrating Microsoft Teams or Slack, see "[AUTOTITLE](/get-started/exploring-integrations/github-extensions-and-integrations#team-communication-tools)." +If your personal account or organization on {% data variables.location.product_location %} is integrated with Microsoft Teams or Slack, you can track deployments that use environments through Microsoft Teams or Slack. For example, you can receive notifications through the app when a deployment is pending approval, when a deployment is approved, or when the deployment status changes. For more information about integrating Microsoft Teams or Slack, see "[AUTOTITLE](/get-started/exploring-integrations/github-extensions-and-integrations#team-communication-tools)." {% endif %} You can also build an app that uses deployment and deployment status webhooks to track deployments. {% data reusables.actions.environment-deployment-event %} For more information, see "[AUTOTITLE](/apps)" and "[AUTOTITLE](/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment)." diff --git a/content/actions/examples/using-concurrency-expressions-and-a-test-matrix.md b/content/actions/examples/using-concurrency-expressions-and-a-test-matrix.md index cd3f3b7ad2..a1da13cbac 100644 --- a/content/actions/examples/using-concurrency-expressions-and-a-test-matrix.md +++ b/content/actions/examples/using-concurrency-expressions-and-a-test-matrix.md @@ -55,13 +55,13 @@ name: Node.js Tests # The `on` keyword lets you define the events that trigger when the workflow is run. You can define multiple events here. For more information, see "[AUTOTITLE](/actions/using-workflows/triggering-a-workflow#using-events-to-trigger-workflows)." on: -# Add the `workflow_dispatch` event if you want to be able to manually run this workflow. For more information, see [`workflow_dispatch`](/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch). + # Add the `workflow_dispatch` event if you want to be able to manually run this workflow. For more information, see [`workflow_dispatch`](/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch). workflow_dispatch: -# Add the `pull_request` event, so that the workflow runs automatically every time a pull request is created or updated. For more information, see [`pull_request`](/actions/using-workflows/events-that-trigger-workflows#pull_request). + # Add the `pull_request` event, so that the workflow runs automatically every time a pull request is created or updated. For more information, see [`pull_request`](/actions/using-workflows/events-that-trigger-workflows#pull_request). pull_request: -# Add the `push` event with the `branch` filter, so that the workflow runs automatically every time a commit is pushed to a branch called "main". For more information, see [`push`](/actions/using-workflows/events-that-trigger-workflows#push). + # Add the `push` event with the `branch` filter, so that the workflow runs automatically every time a commit is pushed to a branch called "main". For more information, see [`push`](/actions/using-workflows/events-that-trigger-workflows#push). push: branches: - main @@ -81,24 +81,24 @@ concurrency: # This groups together all the jobs that run in the workflow file. jobs: -# This defines a job with the ID `test` that is stored within the `jobs` key. + # This defines a job with the ID `test` that is stored within the `jobs` key. test: -# This configures the job to run on a {% data variables.product.prodname_dotcom %}-hosted runner or a self-hosted runner, depending on the repository running the workflow. -# -# In this example, the job will run on a self-hosted runner if the repository is named `docs-internal` and is within the `github` organization. If the repository doesn't match this path, then it will run on an `ubuntu-latest` runner hosted by {% data variables.product.prodname_dotcom %}. For more information on these options, see "[AUTOTITLE](/actions/using-jobs/choosing-the-runner-for-a-job)." + # This configures the job to run on a {% data variables.product.prodname_dotcom %}-hosted runner or a self-hosted runner, depending on the repository running the workflow. + # + # In this example, the job will run on a self-hosted runner if the repository is named `docs-internal` and is within the `github` organization. If the repository doesn't match this path, then it will run on an `ubuntu-latest` runner hosted by {% data variables.product.prodname_dotcom %}. For more information on these options, see "[AUTOTITLE](/actions/using-jobs/choosing-the-runner-for-a-job)." runs-on: {% raw %}${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }}{% endraw %} -# This sets the maximum number of minutes to let the job run before it is automatically canceled. For more information, see [`timeout-minutes`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idtimeout-minutes). + # This sets the maximum number of minutes to let the job run before it is automatically canceled. For more information, see [`timeout-minutes`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idtimeout-minutes). timeout-minutes: 60 -# This section defines the build matrix for your jobs. + # This section defines the build matrix for your jobs. strategy: -# Setting `fail-fast` to `false` prevents {% data variables.product.prodname_dotcom %} from cancelling all in-progress jobs if any matrix job fails. + # Setting `fail-fast` to `false` prevents {% data variables.product.prodname_dotcom %} from cancelling all in-progress jobs if any matrix job fails. fail-fast: false -# This creates a matrix named `test-group`, with an array of test groups. These values match the names of test groups that will be run by `npm test`. + # This creates a matrix named `test-group`, with an array of test groups. These values match the names of test groups that will be run by `npm test`. matrix: test-group: [ @@ -112,103 +112,56 @@ jobs: translations, ] -# This groups together all the steps that will run as part of the `test` job. Each job in a workflow has its own `steps` section. + # This groups together all the steps that will run as part of the `test` job. Each job in a workflow has its own `steps` section. steps: -# The `uses` keyword tells the job to retrieve the action named `actions/checkout`. This is an action that checks out your repository and downloads it to the runner, allowing you to run actions against your code (such as testing tools). You must use the checkout action any time your workflow will use your repository's code. Some extra options are provided to the action using the `with` key. + # The `uses` keyword tells the job to retrieve the action named `actions/checkout`. This is an action that checks out your repository and downloads it to the runner, allowing you to run actions against your code (such as testing tools). You must use the checkout action any time your workflow will use your repository's code. Some extra options are provided to the action using the `with` key. - name: Check out repo uses: {% data reusables.actions.action-checkout %} with: lfs: {% raw %}${{ matrix.test-group == 'content' }}{% endraw %} persist-credentials: 'false' -# If the current repository is the `github/docs-internal` repository, this step uses the `actions/github-script` action to run a script to check if there is a branch called `docs-early-access`. - - name: Figure out which docs-early-access branch to checkout, if internal repo - if: {% raw %}${{ github.repository == 'github/docs-internal' }}{% endraw %} - id: check-early-access - uses: {% data reusables.actions.action-github-script %} - env: - BRANCH_NAME: {% raw %}${{ github.head_ref || github.ref_name }}{% endraw %} - with: - github-token: {% raw %}${{ secrets.DOCUBOT_REPO_PAT }}{% endraw %} - result-encoding: string - script: | - const { BRANCH_NAME } = process.env - try { - const response = await github.repos.getBranch({ - owner: 'github', - repo: 'docs-early-access', - BRANCH_NAME, - }) - console.log(`Using docs-early-access branch called '${BRANCH_NAME}'.`) - return BRANCH_NAME - } catch (err) { - if (err.status === 404) { - console.log(`There is no docs-early-access branch called '${BRANCH_NAME}' so checking out 'main' instead.`) - return 'main' - } - throw err - } - -# If the current repository is the `github/docs-internal` repository, this step checks out the branch from the `github/docs-early-access` that was identified in the previous step. - - name: Check out docs-early-access too, if internal repo - if: {% raw %}${{ github.repository == 'github/docs-internal' }}{% endraw %} - uses: {% data reusables.actions.action-checkout %} - with: - repository: github/docs-early-access - token: {% raw %}${{ secrets.DOCUBOT_REPO_PAT }}{% endraw %} - path: docs-early-access - ref: {% raw %}${{ steps.check-early-access.outputs.result }}{% endraw %} - -# If the current repository is the `github/docs-internal` repository, this step uses the `run` keyword to execute shell commands to move the `docs-early-access` repository's folders into the main repository's folders. - - name: Merge docs-early-access repo's folders - if: {% raw %}${{ github.repository == 'github/docs-internal' }}{% endraw %} - run: | - mv docs-early-access/assets assets/images/early-access - mv docs-early-access/content content/early-access - mv docs-early-access/data data/early-access - rm -r docs-early-access - -# This step runs a command to check out large file storage (LFS) objects from the repository. + # This step runs a command to check out large file storage (LFS) objects from the repository. - name: Checkout LFS objects run: git lfs checkout -# This step uses the `trilom/file-changes-action` action to gather the files changed in the pull request, so they can be analyzed in the next step. This example is pinned to a specific version of the action, using the `a6ca26c14274c33b15e6499323aac178af06ad4b` SHA. + # This step uses the `trilom/file-changes-action` action to gather the files changed in the pull request, so they can be analyzed in the next step. This example is pinned to a specific version of the action, using the `a6ca26c14274c33b15e6499323aac178af06ad4b` SHA. - name: Gather files changed uses: trilom/file-changes-action@a6ca26c14274c33b15e6499323aac178af06ad4b id: get_diff_files with: output: ' ' -# This step runs a shell command that uses an output from the previous step to create a file containing the list of files changed in the pull request. + # This step runs a shell command that uses an output from the previous step to create a file containing the list of files changed in the pull request. - name: Insight into changed files run: | echo {% raw %}"${{ steps.get_diff_files.outputs.files }}" > get_diff_files.txt{% endraw %} -# This step uses the `actions/setup-node` action to install the specified version of the `node` software package on the runner, which gives you access to the `npm` command. + # This step uses the `actions/setup-node` action to install the specified version of the `node` software package on the runner, which gives you access to the `npm` command. - name: Setup node uses: {% data reusables.actions.action-setup-node %} with: node-version: 16.14.x cache: npm -# This step runs the `npm ci` shell command to install the npm software packages for the project. + # This step runs the `npm ci` shell command to install the npm software packages for the project. - name: Install dependencies run: npm ci -# {% ifversion actions-caching %}This step uses the `actions/cache` action to cache the Next.js build, so that the workflow will attempt to retrieve a cache of the build, and not rebuild it from scratch every time. For more information, see "[AUTOTITLE](/actions/using-workflows/caching-dependencies-to-speed-up-workflows)."{% endif %} + # {% ifversion actions-caching %}This step uses the `actions/cache` action to cache the Next.js build, so that the workflow will attempt to retrieve a cache of the build, and not rebuild it from scratch every time. For more information, see "[AUTOTITLE](/actions/using-workflows/caching-dependencies-to-speed-up-workflows)."{% endif %} - name: Cache nextjs build uses: {% data reusables.actions.action-cache %} with: path: .next/cache key: {% raw %}${{ runner.os }}-nextjs-${{ hashFiles('package*.json') }}{% endraw %} -# This step runs the build script. + # This step runs the build script. - name: Run build script run: npm run build -# This step runs the tests using `npm test`, and the test matrix provides a different value for {% raw %}`${{ matrix.test-group }}`{% endraw %} for each job in the matrix. It uses the `DIFF_FILE` environment variable to know which files have changed, and uses the `CHANGELOG_CACHE_FILE_PATH` environment variable for the changelog cache file. + # This step runs the tests using `npm test`, and the test matrix provides a different value for {% raw %}`${{ matrix.test-group }}`{% endraw %} for each job in the matrix. It uses the `DIFF_FILE` environment variable to know which files have changed, and uses the `CHANGELOG_CACHE_FILE_PATH` environment variable for the changelog cache file. - name: Run tests env: DIFF_FILE: get_diff_files.txt diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller.md index 28be535224..e94b44349b 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller.md @@ -774,24 +774,25 @@ The following table shows the metrics emitted by the controller-manager and list {% endnote %} -| Owner | Metric | Type | Description | -| ------------------ | ------------------------------ | --------- | ----------------------------------------------------------------------------------------------------------- | -| controller-manager | pending_ephemeral_runners | gauge | Number of ephemeral runners in a pending state | -| controller-manager | running_ephemeral_runners | gauge | Number of ephemeral runners in a running state | -| controller-manager | failed_ephemeral_runners | gauge | Number of ephemeral runners in a failed state | -| listener | assigned_jobs | gauge | Number of jobs assigned to the runner scale set | -| listener | running_jobs | gauge | Number of jobs running or queued to run | -| listener | registered_runners | gauge | Number of runners registered by the runner scale set | -| listener | busy_runners | gauge | Number of registered runners currently running a job | -| listener | min_runners | gauge | Minimum number of runners configured for the runner scale set | -| listener | max_runners | gauge | Maximum number of runners configured for the runner scale set | -| listener | desired_runners | gauge | Number of runners desired (scale up / down target) by the runner scale set | -| listener | idle_runners | gauge | Number of registered runners not running a job | -| listener | started_jobs_total | counter | Total number of jobs started since the listener became ready [1] | -| listener | completed_jobs_total | counter | Total number of jobs completed since the listener became ready [1] | -| listener | job_queue_duration_seconds | histogram | Number of seconds spent waiting for workflow jobs to get assigned to the runner scale set after queueing | -| listener | job_startup_duration_seconds | histogram | Number of seconds spent waiting for workflow job to get started on the runner owned by the runner scale set | -| listener | job_execution_duration_seconds | histogram | Number of seconds spent executing workflow jobs by the runner scale set | +| Owner | Metric | Type | Description | +| ------------------ | --------------------------------------------- | --------- | ----------------------------------------------------------------------------------------------------------- | +| controller-manager | gha_controller_pending_ephemeral_runners | gauge | Number of ephemeral runners in a pending state | +| controller-manager | gha_controller_running_ephemeral_runners | gauge | Number of ephemeral runners in a running state | +| controller-manager | gha_controller_failed_ephemeral_runners | gauge | Number of ephemeral runners in a failed state | +| controller-manager | gha_controller_running_listeners | gauge | Number of listeners in a running state | +| listener | gha_assigned_jobs | gauge | Number of jobs assigned to the runner scale set | +| listener | gha_running_jobs | gauge | Number of jobs running or queued to run | +| listener | gha_registered_runners | gauge | Number of runners registered by the runner scale set | +| listener | gha_busy_runners | gauge | Number of registered runners currently running a job | +| listener | gha_min_runners | gauge | Minimum number of runners configured for the runner scale set | +| listener | gha_max_runners | gauge | Maximum number of runners configured for the runner scale set | +| listener | gha_desired_runners | gauge | Number of runners desired (scale up / down target) by the runner scale set | +| listener | gha_idle_runners | gauge | Number of registered runners not running a job | +| listener | gha_started_jobs_total | counter | Total number of jobs started since the listener became ready [1] | +| listener | gha_completed_jobs_total | counter | Total number of jobs completed since the listener became ready [1] | +| listener | gha_job_queue_duration_seconds | histogram | Number of seconds spent waiting for workflow jobs to get assigned to the runner scale set after queueing | +| listener | gha_job_startup_duration_seconds | histogram | Number of seconds spent waiting for workflow job to get started on the runner owned by the runner scale set | +| listener | gha_job_execution_duration_seconds | histogram | Number of seconds spent executing workflow jobs by the runner scale set | [1]: Listener metrics that have the counter type are reset when the listener pod restarts. diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md index 024ad3fc41..b332241db2 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners.md @@ -12,7 +12,7 @@ versions: ghec: '*' type: overview --- - + {% data reusables.actions.enterprise-github-hosted-runners %} ## About self-hosted runners @@ -232,7 +232,7 @@ You can also use self-hosted runners with a proxy server. For more information, For more information about troubleshooting common network connectivity issues, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners#troubleshooting-network-connectivity)." -{% ifversion ghes or ghae %} +{% ifversion ghes %} ## Communication between self-hosted runners and {% data variables.product.prodname_dotcom_the_website %} diff --git a/content/actions/learn-github-actions/understanding-github-actions.md b/content/actions/learn-github-actions/understanding-github-actions.md index a70f9071fc..c5b6886ab7 100644 --- a/content/actions/learn-github-actions/understanding-github-actions.md +++ b/content/actions/learn-github-actions/understanding-github-actions.md @@ -82,7 +82,7 @@ For more information, see "[AUTOTITLE](/actions/creating-actions)." ### Runners -{% data reusables.actions.about-runners %} Each runner can run a single job at a time. {% ifversion ghes or ghae %} You must host your own runners for {% data variables.product.product_name %}. {% elsif fpt or ghec %}{% data variables.product.company_short %} provides Ubuntu Linux, Microsoft Windows, and macOS runners to run your workflows; each workflow run executes in a fresh, newly-provisioned virtual machine. {% ifversion actions-hosted-runners %} {% data variables.product.prodname_dotcom %} also offers {% data variables.actions.hosted_runner %}s, which are available in larger configurations. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/using-larger-runners)." {% endif %}If you need a different operating system or require a specific hardware configuration, you can host your own runners.{% endif %} For more information{% ifversion fpt or ghec %} about self-hosted runners{% endif %}, see "[AUTOTITLE](/actions/hosting-your-own-runners)." +{% data reusables.actions.about-runners %} Each runner can run a single job at a time. {% ifversion ghes %} You must host your own runners for {% data variables.product.product_name %}. {% elsif fpt or ghec %}{% data variables.product.company_short %} provides Ubuntu Linux, Microsoft Windows, and macOS runners to run your workflows; each workflow run executes in a fresh, newly-provisioned virtual machine. {% ifversion actions-hosted-runners %} {% data variables.product.prodname_dotcom %} also offers {% data variables.actions.hosted_runner %}s, which are available in larger configurations. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/using-larger-runners)." {% endif %}If you need a different operating system or require a specific hardware configuration, you can host your own runners.{% endif %} For more information{% ifversion fpt or ghec %} about self-hosted runners{% endif %}, see "[AUTOTITLE](/actions/hosting-your-own-runners)." {% data reusables.actions.workflow-basic-example-and-explanation %} diff --git a/content/actions/managing-issues-and-pull-requests/moving-assigned-issues-on-project-boards.md b/content/actions/managing-issues-and-pull-requests/moving-assigned-issues-on-project-boards.md index f92dc9b383..cb4b46a5ca 100644 --- a/content/actions/managing-issues-and-pull-requests/moving-assigned-issues-on-project-boards.md +++ b/content/actions/managing-issues-and-pull-requests/moving-assigned-issues-on-project-boards.md @@ -1,6 +1,6 @@ --- -title: Moving assigned issues on project boards -intro: 'You can use {% data variables.product.prodname_actions %} to automatically move an issue to a specific column on a project board when the issue is assigned.' +title: 'Moving assigned issues on {% data variables.projects.projects_v1_boards %}' +intro: 'You can use {% data variables.product.prodname_actions %} to automatically move an issue to a specific column on a {% data variables.projects.projects_v1_board %} when the issue is assigned.' redirect_from: - /actions/guides/moving-assigned-issues-on-project-boards versions: @@ -13,20 +13,21 @@ topics: - Workflows - Project management shortTitle: Move assigned issues +allowTitleToDifferFromFilename: true --- {% data reusables.actions.enterprise-github-hosted-runners %} ## Introduction -This tutorial demonstrates how to use the [`alex-page/github-project-automation-plus` action](https://github.com/marketplace/actions/github-project-automation) to automatically move an issue to a specific column on a project board when the issue is assigned. For example, when an issue is assigned, you can move it into the `In Progress` column your project board. +This tutorial demonstrates how to use the [`alex-page/github-project-automation-plus` action](https://github.com/marketplace/actions/github-project-automation) to automatically move an issue to a specific column on a {% data variables.projects.projects_v1_board %} when the issue is assigned. For example, when an issue is assigned, you can move it into the `In Progress` column your {% data variables.projects.projects_v1_board %}. In the tutorial, you will first make a workflow file that uses the [`alex-page/github-project-automation-plus` action](https://github.com/marketplace/actions/github-project-automation). Then, you will customize the workflow to suit your needs. ## Creating the workflow 1. {% data reusables.actions.choose-repo %} -1. In your repository, choose a project board. You can use an existing project, or you can create a new project. For more information about creating a project, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board)." +1. In your repository, choose a {% data variables.projects.projects_v1_board %}. You can use an existing project, or you can create a new project. For more information about creating a project, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/creating-a-project-board)." 1. {% data reusables.actions.make-workflow-file %} 1. Copy the following YAML contents into your workflow file. @@ -52,7 +53,7 @@ In the tutorial, you will first make a workflow file that uses the [`alex-page/g ``` 1. Customize the parameters in your workflow file: - - Change the value for `project` to the name of your project board. If you have multiple project boards with the same name, the `alex-page/github-project-automation-plus` action will act on all projects with the specified name. + - Change the value for `project` to the name of your {% data variables.projects.projects_v1_board %}. If you have multiple {% data variables.projects.projects_v1_boards %} with the same name, the `alex-page/github-project-automation-plus` action will act on all projects with the specified name. - Change the value for `column` to the name of the column where you want issues to move when they are assigned. - Change the value for `repo-token`: 1. Create a {% data variables.product.pat_v1 %} with the `repo` scope. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." @@ -62,7 +63,7 @@ In the tutorial, you will first make a workflow file that uses the [`alex-page/g ## Testing the workflow -Whenever an issue in your repository is assigned, the issue will be moved to the specified project board column. If the issue is not already on the project board, it will be added to the project board. +Whenever an issue in your repository is assigned, the issue will be moved to the specified {% data variables.projects.projects_v1_board %} column. If the issue is not already on the {% data variables.projects.projects_v1_board %}, it will be added to the {% data variables.projects.projects_v1_board %}. If your repository is user-owned, the `alex-page/github-project-automation-plus` action will act on all projects in your repository or personal account that have the specified project name and column. Likewise, if your repository is organization-owned, the action will act on all projects in your repository or organization that have the specified project name and column. @@ -71,7 +72,7 @@ Test your workflow by assigning an issue in your repository. 1. Open an issue in your repository. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)." 1. Assign the issue. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users)." 1. To see the workflow run that assigning the issue triggered, view the history of your workflow runs. For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)." -1. When the workflow completes, the issue that you assigned should be added to the specified project board column. +1. When the workflow completes, the issue that you assigned should be added to the specified {% data variables.projects.projects_v1_board %} column. ## Next steps diff --git a/content/actions/managing-issues-and-pull-requests/removing-a-label-when-a-card-is-added-to-a-project-board-column.md b/content/actions/managing-issues-and-pull-requests/removing-a-label-when-a-card-is-added-to-a-project-board-column.md index 7bc7c9d1d6..71cfa7c5f2 100644 --- a/content/actions/managing-issues-and-pull-requests/removing-a-label-when-a-card-is-added-to-a-project-board-column.md +++ b/content/actions/managing-issues-and-pull-requests/removing-a-label-when-a-card-is-added-to-a-project-board-column.md @@ -1,5 +1,5 @@ --- -title: Removing a label when a card is added to a project board column +title: 'Removing a label when a card is added to a {% data variables.projects.projects_v1_board %} column' intro: 'You can use {% data variables.product.prodname_actions %} to automatically remove a label when an issue or pull request is added to a specific column on a {% data variables.projects.projects_v1_board %}.' redirect_from: - /actions/guides/removing-a-label-when-a-card-is-added-to-a-project-board-column @@ -13,6 +13,7 @@ topics: - Workflows - Project management shortTitle: Remove label when adding card +allowTitleToDifferFromFilename: true --- {% data reusables.actions.enterprise-github-hosted-runners %} @@ -62,7 +63,7 @@ In the tutorial, you will first make a workflow file that uses the [`actions/git To find the column ID, navigate to your {% data variables.projects.projects_v1_board %}. Next to the title of the column, click {% octicon "kebab-horizontal" aria-label="Column menu" %} then click **Copy column link**. The column ID is the number at the end of the copied link. For example, `24687531` is the column ID for `https://github.com/octocat/octo-repo/projects/1#column-24687531`. - If you want to act on more than one column, separate the conditions with `||`. For example, `if github.event.project_card.column_id == '12345678' || github.event.project_card.column_id == '87654321'` will act whenever a project card is added to column `12345678` or column `87654321`. The columns may be on different project boards. + If you want to act on more than one column, separate the conditions with `||`. For example, `if github.event.project_card.column_id == '12345678' || github.event.project_card.column_id == '87654321'` will act whenever a project card is added to column `12345678` or column `87654321`. The columns may be on different {% data variables.projects.projects_v1_boards %}. - Change the value for `name` in the `github.rest.issues.removeLabel()` function to the name of the label that you want to remove from issues or pull requests that are moved to the specified column(s). For more information on labels, see "[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels#applying-labels-to-issues-and-pull-requests)." 1. {% data reusables.actions.commit-workflow %} diff --git a/content/actions/managing-issues-and-pull-requests/using-github-actions-for-project-management.md b/content/actions/managing-issues-and-pull-requests/using-github-actions-for-project-management.md index 77ec4e0a19..fdb2496e9b 100644 --- a/content/actions/managing-issues-and-pull-requests/using-github-actions-for-project-management.md +++ b/content/actions/managing-issues-and-pull-requests/using-github-actions-for-project-management.md @@ -15,7 +15,7 @@ shortTitle: Actions for project management --- -You can use {% data variables.product.prodname_actions %} to automate your project management tasks by creating workflows. Each workflow contains a series of tasks that are performed automatically every time the workflow runs. For example, you can create a workflow that runs every time an issue is created to add a label, leave a comment, and move the issue onto a project board. +You can use {% data variables.product.prodname_actions %} to automate your project management tasks by creating workflows. Each workflow contains a series of tasks that are performed automatically every time the workflow runs. For example, you can create a workflow that runs every time an issue is created to add a label, leave a comment, and move the issue onto a {% data variables.projects.projects_v1_board %}. ## When do workflows run? @@ -32,7 +32,7 @@ For a full list of events that can trigger workflows, see "[AUTOTITLE](/actions/ ## What can workflows do? -Workflows can do many things, such as commenting on an issue, adding or removing labels, moving cards on project boards, and opening issues. +Workflows can do many things, such as commenting on an issue, adding or removing labels, moving cards on {% data variables.projects.projects_v1_boards %}, and opening issues. You can learn about using {% data variables.product.prodname_actions %} for project management by following these tutorials, which include example workflows that you can adapt to meet your needs. diff --git a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-azure-devops-with-github-actions-importer.md b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-azure-devops-with-github-actions-importer.md index 4d5e3fe994..3201d4b7ae 100644 --- a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-azure-devops-with-github-actions-importer.md +++ b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-azure-devops-with-github-actions-importer.md @@ -88,7 +88,7 @@ The `configure` CLI command is used to set required credentials and options for - For "Which CI providers are you configuring?", use the arrow keys to select `Azure DevOps`, press Space to select it, then press Enter. - For "{% data variables.product.pat_generic_caps %} for GitHub", enter the value of the {% data variables.product.pat_v1 %} that you created earlier, and press Enter. - - For "Base url of the GitHub instance", {% ifversion ghes or ghae %}enter the URL for your {% data variables.product.product_name %} instance, and press Enter.{% else %}press Enter to accept the default value (`https://github.com`).{% endif %} + - For "Base url of the GitHub instance", {% ifversion ghes %}enter the URL for your {% data variables.product.product_name %} instance, and press Enter.{% else %}press Enter to accept the default value (`https://github.com`).{% endif %} - For "{% data variables.product.pat_generic_caps %} for Azure DevOps", enter the value for the Azure DevOps {% data variables.product.pat_generic %} that you created earlier, and press Enter. - For "Base url of the Azure DevOps instance", press Enter to accept the default value (`https://dev.azure.com`). - For "Azure DevOps organization name", enter the name for your Azure DevOps organization, and press Enter. @@ -313,7 +313,7 @@ In this example, {% data variables.product.prodname_actions_importer %} uses the The pipeline is selected by matching the `repository_slug` in the configuration file to the value of the `--azure-devops-organization` and `--azure-devops-project` option. The `path` is then used to pull the specified source file. ```shell -gh actions-importer dry-run azure-devops pipeline --output-dir ./output/ --config-file-path ./path/to/azure_devops/config.yml +gh actions-importer dry-run azure-devops pipeline --output-dir ./output/ --config-file-path ./path/to/azure_devops/config.yml ``` ##### Specify the repository of converted reusable workflows and composite actions @@ -495,7 +495,7 @@ variables: ```yaml parameters: - name: template - type: string + type: string default: simple_step.yml steps: @@ -511,7 +511,7 @@ parameters: default: - build_step - release_step -steps: +steps: - {% raw %}${{ each step in parameters.steps }}{% endraw %}: - template: "${{ step }}-variables.yml" ``` diff --git a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-bamboo-with-github-actions-importer.md b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-bamboo-with-github-actions-importer.md index e226f1fb2a..ed038d8127 100644 --- a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-bamboo-with-github-actions-importer.md +++ b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-bamboo-with-github-actions-importer.md @@ -85,7 +85,7 @@ The `configure` CLI command is used to set required credentials and options for - For "Which CI providers are you configuring?", use the arrow keys to select `Bamboo`, press Space to select it, then press Enter. - For "{% data variables.product.pat_generic_caps %} for GitHub", enter the value of the {% data variables.product.pat_v1 %} that you created earlier, and press Enter. - - For "Base url of the GitHub instance", {% ifversion ghes or ghae %}enter the URL for your {% data variables.product.product_name %} instance, and press Enter.{% else %}press Enter to accept the default value (`https://github.com`).{% endif %} + - For "Base url of the GitHub instance", {% ifversion ghes %}enter the URL for your {% data variables.product.product_name %} instance, and press Enter.{% else %}press Enter to accept the default value (`https://github.com`).{% endif %} - For "{% data variables.product.pat_generic_caps %} for Bamboo", enter the value for the Bamboo {% data variables.product.pat_generic %} that you created earlier, and press Enter. - For "Base url of the Bamboo instance", enter the URL for your Bamboo Server or Bamboo Data Center instance, and press Enter. diff --git a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-bitbucket-pipelines-with-github-actions-importer.md b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-bitbucket-pipelines-with-github-actions-importer.md index a2e719c79a..11e9db89d0 100644 --- a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-bitbucket-pipelines-with-github-actions-importer.md +++ b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-bitbucket-pipelines-with-github-actions-importer.md @@ -82,7 +82,7 @@ The `configure` CLI command is used to set required credentials and options for - For "Which CI providers are you configuring?", use the arrow keys to select `Bitbucket`, press Space to select it, then press Enter. - For "{% data variables.product.pat_generic_caps %} for GitHub", enter the value of the {% data variables.product.pat_v1 %} that you created earlier, and press Enter. - - For "Base url of the GitHub instance", {% ifversion ghes or ghae %}enter the URL for your {% data variables.product.product_name %} instance, and press Enter.{% else %}press Enter to accept the default value (`https://github.com`).{% endif %} + - For "Base url of the GitHub instance", {% ifversion ghes %}enter the URL for your {% data variables.product.product_name %} instance, and press Enter.{% else %}press Enter to accept the default value (`https://github.com`).{% endif %} - For "{% data variables.product.pat_generic_caps %} for Bitbucket", enter the Workspace Access Token that you created earlier, and press Enter. - For "Base url of the Bitbucket instance", enter the URL for your Bitbucket instance, and press Enter. diff --git a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-circleci-with-github-actions-importer.md b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-circleci-with-github-actions-importer.md index bb8e217d9b..0076ac163e 100644 --- a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-circleci-with-github-actions-importer.md +++ b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-circleci-with-github-actions-importer.md @@ -68,7 +68,7 @@ The `configure` CLI command is used to set required credentials and options for - For "Which CI providers are you configuring?", use the arrow keys to select `CircleCI`, press Space to select it, then press Enter. - For "{% data variables.product.pat_generic_caps %} for GitHub", enter the value of the {% data variables.product.pat_v1 %} that you created earlier, and press Enter. - - For "Base url of the GitHub instance", {% ifversion ghes or ghae %}enter the URL for your {% data variables.product.product_name %} instance, and press Enter.{% else %}press Enter to accept the default value (`https://github.com`).{% endif %} + - For "Base url of the GitHub instance", {% ifversion ghes %}enter the URL for your {% data variables.product.product_name %} instance, and press Enter.{% else %}press Enter to accept the default value (`https://github.com`).{% endif %} - For "{% data variables.product.pat_generic_caps %} for CircleCI", enter the value for the CircleCI personal API token that you created earlier, and press Enter. - For "Base url of the CircleCI instance", press Enter to accept the default value (`https://circleci.com`). - For "CircleCI organization name", enter the name for your CircleCI organization, and press Enter. @@ -76,7 +76,7 @@ The `configure` CLI command is used to set required credentials and options for An example of the `configure` command is shown below: ```shell - $ gh actions-importer configure + $ gh actions-importer configure ✔ Which CI providers are you configuring?: CircleCI Enter the following values (leave empty to omit): ✔ {% data variables.product.pat_generic_caps %} for GitHub: *************** @@ -258,7 +258,7 @@ In this example, {% data variables.product.prodname_actions_importer %} uses the The pipeline is selected by matching the `repository_slug` in the config file to the value of the `--circle-ci-organization` and `--circle-ci-project` options. The `path` is then used to pull the specified source file. ```bash -gh actions-importer dry-run circle-ci --circle-ci-project circle-org-name/circle-project-name --output-dir ./output/ --config-file-path ./path/to/circle-ci/config.yml +gh actions-importer dry-run circle-ci --circle-ci-project circle-org-name/circle-project-name --output-dir ./output/ --config-file-path ./path/to/circle-ci/config.yml ``` ##### Specify the repository of converted composite actions diff --git a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-gitlab-with-github-actions-importer.md b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-gitlab-with-github-actions-importer.md index fcaa85a125..efe0a2f5c3 100644 --- a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-gitlab-with-github-actions-importer.md +++ b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-gitlab-with-github-actions-importer.md @@ -70,7 +70,7 @@ The `configure` CLI command is used to set required credentials and options for - For "Which CI providers are you configuring?", use the arrow keys to select `GitLab`, press Space to select it, then press Enter. - For "{% data variables.product.pat_generic_caps %} for GitHub", enter the value of the {% data variables.product.pat_v1 %} that you created earlier, and press Enter. - - For "Base url of the GitHub instance", {% ifversion ghes or ghae %}enter the URL for your {% data variables.product.product_name %} instance, and press Enter.{% else %}press Enter to accept the default value (`https://github.com`).{% endif %} + - For "Base url of the GitHub instance", {% ifversion ghes %}enter the URL for your {% data variables.product.product_name %} instance, and press Enter.{% else %}press Enter to accept the default value (`https://github.com`).{% endif %} - For "Private token for GitLab", enter the value for the GitLab {% data variables.product.pat_generic %} that you created earlier, and press Enter. - For "Base url of the GitLab instance", enter the URL of your GitLab instance, and press Enter. diff --git a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-jenkins-with-github-actions-importer.md b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-jenkins-with-github-actions-importer.md index 2455f453ce..dfcad8292c 100644 --- a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-jenkins-with-github-actions-importer.md +++ b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-jenkins-with-github-actions-importer.md @@ -64,7 +64,7 @@ The `configure` CLI command is used to set required credentials and options for - For "Which CI providers are you configuring?", use the arrow keys to select `Jenkins`, press Space to select it, then press Enter. - For "{% data variables.product.pat_generic_caps %} for GitHub", enter the value of the {% data variables.product.pat_v1 %} that you created earlier, and press Enter. - - For "Base url of the GitHub instance", {% ifversion ghes or ghae %}enter the URL for your {% data variables.product.product_name %} instance, and press Enter.{% else %}press Enter to accept the default value (`https://github.com`).{% endif %} + - For "Base url of the GitHub instance", {% ifversion ghes %}enter the URL for your {% data variables.product.product_name %} instance, and press Enter.{% else %}press Enter to accept the default value (`https://github.com`).{% endif %} - For "{% data variables.product.pat_generic_caps %} for Jenkins", enter the value for the Jenkins personal API token that you created earlier, and press Enter. - For "Username of Jenkins user", enter your Jenkins username and press Enter. - For "Base url of the Jenkins instance", enter the URL of your Jenkins instance, and press Enter. @@ -93,7 +93,7 @@ The `configure` CLI command is used to set required credentials and options for ```shell Updating ghcr.io/actions-importer/cli:latest... - ghcr.io/actions-importer/cli:latest up-to-date + ghcr.io/actions-importer/cli:latest up-to-date ``` ## Perform an audit of Jenkins @@ -137,7 +137,7 @@ To install the `paginated-builds` plugin: To perform a forecast of potential {% data variables.product.prodname_actions %}, run the following command in your terminal. By default, {% data variables.product.prodname_actions_importer %} includes the previous seven days in the forecast report. ```shell -gh actions-importer forecast jenkins --output-dir tmp/forecast +gh actions-importer forecast jenkins --output-dir tmp/forecast ``` ### Inspecting the forecast report diff --git a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-travis-ci-with-github-actions-importer.md b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-travis-ci-with-github-actions-importer.md index 0564ae15d4..400132ea4f 100644 --- a/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-travis-ci-with-github-actions-importer.md +++ b/content/actions/migrating-to-github-actions/automated-migrations/migrating-from-travis-ci-with-github-actions-importer.md @@ -71,7 +71,7 @@ The `configure` CLI command is used to set required credentials and options for - For "Which CI providers are you configuring?", use the arrow keys to select `Travis CI`, press Space to select it, then press Enter. - For "{% data variables.product.pat_generic_caps %} for GitHub", enter the value of the {% data variables.product.pat_v1 %} that you created earlier, and press Enter. - - For "Base url of the GitHub instance", {% ifversion ghes or ghae %}enter the URL for your {% data variables.product.product_name %} instance, and press Enter.{% else %}press Enter to accept the default value (`https://github.com`).{% endif %} + - For "Base url of the GitHub instance", {% ifversion ghes %}enter the URL for your {% data variables.product.product_name %} instance, and press Enter.{% else %}press Enter to accept the default value (`https://github.com`).{% endif %} - For "{% data variables.product.pat_generic_caps %} for Travis CI", enter the value for the Travis CI API access token that you created earlier, and press Enter. - For "Base url of the Travis CI instance", enter the URL of your Travis CI instance, and press Enter. - For "Travis CI organization name", enter the name of your Travis CI organization, and press Enter. diff --git a/content/actions/migrating-to-github-actions/manually-migrating-to-github-actions/migrating-from-gitlab-cicd-to-github-actions.md b/content/actions/migrating-to-github-actions/manually-migrating-to-github-actions/migrating-from-gitlab-cicd-to-github-actions.md index 77034b113d..85f2c7e3fc 100644 --- a/content/actions/migrating-to-github-actions/manually-migrating-to-github-actions/migrating-from-gitlab-cicd-to-github-actions.md +++ b/content/actions/migrating-to-github-actions/manually-migrating-to-github-actions/migrating-from-gitlab-cicd-to-github-actions.md @@ -8,7 +8,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' type: tutorial topics: @@ -18,7 +17,7 @@ topics: - CD shortTitle: Migrate from GitLab CI/CD --- - + {% data reusables.actions.enterprise-github-hosted-runners %} ## Introduction diff --git a/content/actions/security-guides/security-hardening-for-github-actions.md b/content/actions/security-guides/security-hardening-for-github-actions.md index f6d0dbbc7f..a6cf50188e 100644 --- a/content/actions/security-guides/security-hardening-for-github-actions.md +++ b/content/actions/security-guides/security-hardening-for-github-actions.md @@ -181,6 +181,8 @@ To help mitigate the risk of an exposed token, consider restricting the assigned {% data reusables.actions.about-oidc-short-overview %} +{% data reusables.actions.oidc-custom-claims-aws-restriction %} + {% endif %} ## Using third-party actions diff --git a/content/actions/security-guides/using-secrets-in-github-actions.md b/content/actions/security-guides/using-secrets-in-github-actions.md index 923e965044..b55c33ac70 100644 --- a/content/actions/security-guides/using-secrets-in-github-actions.md +++ b/content/actions/security-guides/using-secrets-in-github-actions.md @@ -13,10 +13,9 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' --- - + {% data reusables.actions.enterprise-github-hosted-runners %} ## About secrets @@ -27,16 +26,12 @@ Secrets are variables that you create in an organization, repository, or reposit For secrets stored at the environment level, you can enable required reviewers to control access to the secrets. A workflow job cannot access environment secrets until approval is granted by required approvers. -{% ifversion fpt or ghec or ghes %} - {% note %} **Note**: {% data reusables.actions.about-oidc-short-overview %} {% endnote %} -{% endif %} - ### Naming your secrets The following rules apply to secret names: diff --git a/content/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners.md b/content/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners.md index d88c60c613..70c41bd918 100644 --- a/content/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners.md +++ b/content/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners.md @@ -112,11 +112,20 @@ While the job runs, the logs and output can be viewed in the {% data variables.p {% ifversion actions-hosted-runners %} +{% data variables.product.prodname_dotcom %}-hosted runners are available for use in both public and private repositories. + {% note %} -**Note**: {% data variables.product.prodname_dotcom %} also offers {% data variables.actions.hosted_runner %}s, which are available in larger configurations for Linux, Windows, and macOS virtual machines. Autoscaling is enabled by default and optional dedicated IP addresses are available for Linux and Windows. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/using-larger-runners#machine-specs-for-larger-runners)." +**Note:** The `-latest` runner images are the latest stable images that {% data variables.product.prodname_dotcom %} provides, and might not be the most recent version of the operating system available from the operating system vendor. {% endnote %} + +{% warning %} + +**Warning:** Beta and Deprecated Images are provided "as-is", "with all faults" and "as available" and are excluded from the service level agreement and warranty. Beta Images may not be covered by customer support. + +{% endwarning %} + {% endif %} {% data reusables.actions.supported-github-runners %} @@ -161,7 +170,11 @@ You can install additional software on {% data variables.product.prodname_dotcom ## Cloud hosts used by {% data variables.product.prodname_dotcom %}-hosted runners -{% data variables.product.prodname_dotcom %} hosts Linux and Windows runners on `Standard_DS2_v2` virtual machines in Microsoft Azure with the {% data variables.product.prodname_actions %} runner application installed. The {% data variables.product.prodname_dotcom %}-hosted runner application is a fork of the Azure Pipelines Agent. Inbound ICMP packets are blocked for all Azure virtual machines, so ping or traceroute commands might not work. For more information about the `Standard_DS2_v2` resources, see "[Dv2 and DSv2-series](https://docs.microsoft.com/azure/virtual-machines/dv2-dsv2-series#dsv2-series)" in the Microsoft Azure documentation. {% data variables.product.prodname_dotcom %} hosts macOS runners in Azure data centers. +{% data variables.product.prodname_dotcom %} hosts Linux and Windows runners on virtual machines in Microsoft Azure with the {% data variables.product.prodname_actions %} runner application installed. The {% data variables.product.prodname_dotcom %}-hosted runner application is a fork of the Azure Pipelines Agent. Inbound ICMP packets are blocked for all Azure virtual machines, so ping or traceroute commands might not work. {% data variables.product.prodname_dotcom %} hosts macOS runners in Azure data centers. + +{% data variables.product.prodname_dotcom %} provides different Linux and Windows runners for public and private repositories. +- For Linux and Windows runners in **public** repositories, GitHub uses `Standard_D4ads_v5` virtual machines. For more information, see [Dasv5 and Dadsv5-series](https://learn.microsoft.com/en-us/azure/virtual-machines/dasv5-dadsv5-series#dadsv5-series) in the Microsoft Azure documentation. +- For Linux and Windows runners in **private** repositories, GitHub uses `Standard_DS2_v2` virtual machines. For more information, see [Dv2 and DSv2-series](https://learn.microsoft.com/en-us/azure/virtual-machines/dv2-dsv2-series#dsv2-series) in the Microsoft Azure documentation. ## Workflow continuity diff --git a/content/actions/using-github-hosted-runners/about-larger-runners/about-larger-runners.md b/content/actions/using-github-hosted-runners/about-larger-runners/about-larger-runners.md index f7c25efcb5..85507b9290 100644 --- a/content/actions/using-github-hosted-runners/about-larger-runners/about-larger-runners.md +++ b/content/actions/using-github-hosted-runners/about-larger-runners/about-larger-runners.md @@ -29,8 +29,8 @@ The following machines sizes are available for macOS {% data variables.actions.h | Runner Size | Architecture| Processor (CPU)| Memory (RAM) | Storage (SSD) | YAML workflow label | | --------------| --------------| -------------- | ------------- | ------------- | --------------------- | -| Large | Intel| 12 | 30 GB | 14 GB | macos-latest-large, macos-12-large , macos-13-large[Beta] | -| XLarge| arm64 (M1)|6 CPU and 8 GPU| 14 GB | 14 GB | macos-latest-xlarge[Beta], macos-13-xlarge[Beta] | +| Large | Intel| 12 | 30 GB | 14 GB | macos-latest-large, macos-12-large [latest] , macos-13-large, macos-14-large[Beta] | +| XLarge| arm64 (M1)|6 CPU and 8 GPU| 14 GB | 14 GB | macos-latest-xlarge, macos-13-xlarge[latest], macos-14-xlarge[Beta] | #### Limitations for macOS {% data variables.actions.hosted_runners %} diff --git a/content/actions/using-github-hosted-runners/about-larger-runners/running-jobs-on-larger-runners.md b/content/actions/using-github-hosted-runners/about-larger-runners/running-jobs-on-larger-runners.md index c248414c08..88764de906 100644 --- a/content/actions/using-github-hosted-runners/about-larger-runners/running-jobs-on-larger-runners.md +++ b/content/actions/using-github-hosted-runners/about-larger-runners/running-jobs-on-larger-runners.md @@ -38,8 +38,8 @@ Use the labels in the table below to run your workflows on the corresponding mac | Runner Size | Architecture| Processor (CPU)| Memory (RAM) | Storage (SSD) | OS (YAML workflow label) | | --------------| --------------| -------------- | ------------- | ------------- | --------------------- | -| Large | Intel| 12 | 30 GB | 14 GB | macos-latest-large, macos-12-large , macos-13-large[Beta] | -| XLarge| arm64 (M1)|6 CPU and 8 GPU| 14 GB | 14 GB | macos-latest-xlarge[Beta], macos-13-xlarge[Beta] | +| Large | Intel| 12 | 30 GB | 14 GB | macos-latest-large, macos-12-large [latest] , macos-13-large, macos-14-large[Beta] | +| XLarge| arm64 (M1)|6 CPU and 8 GPU| 14 GB | 14 GB | macos-latest-xlarge, macos-13-xlarge [latest], macos-14-xlarge[Beta] | {% note %} **Note:** For macOS {% data variables.actions.hosted_runner %}s, the `-latest` runner label uses the macOS 12 runner image. For macOS Xlarge, the `-latest` runner label uses the macOS 13 runner image diff --git a/content/actions/using-workflows/events-that-trigger-workflows.md b/content/actions/using-workflows/events-that-trigger-workflows.md index 138ff3c103..018cd2f8a2 100644 --- a/content/actions/using-workflows/events-that-trigger-workflows.md +++ b/content/actions/using-workflows/events-that-trigger-workflows.md @@ -459,7 +459,7 @@ on: {% note %} -**Note**: {% data reusables.developer-site.multiple_activity_types %} The `edited` activity type refers to when a project board, not a column or card on the project board, is edited. For information about each activity type, see "[AUTOTITLE](/webhooks-and-events/webhooks/webhook-events-and-payloads#project)." {% data reusables.developer-site.limit_workflow_to_activity_types %} +**Note**: {% data reusables.developer-site.multiple_activity_types %} The `edited` activity type refers to when a {% data variables.projects.projects_v1_board %}, not a column or card on the {% data variables.projects.projects_v1_board %}, is edited. For information about each activity type, see "[AUTOTITLE](/webhooks-and-events/webhooks/webhook-events-and-payloads#project)." {% data reusables.developer-site.limit_workflow_to_activity_types %} {% endnote %} @@ -479,7 +479,7 @@ on: {% endnote %} {% endif %} -Runs your workflow when a project board is created or modified. For activity related to cards or columns in a project board, use the [`project_card`](#project_card) or [`project_column`](#project_column) events instead. For more information about project boards, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the project board APIs, see "[AUTOTITLE](/graphql/reference/objects#project)" in the GraphQL API documentation or "[AUTOTITLE](/rest/projects)" in the REST API documentation. +Runs your workflow when a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to cards or columns in a {% data variables.projects.projects_v1_board %}, use the [`project_card`](#project_card) or [`project_column`](#project_column) events instead. For more information about {% data variables.projects.projects_v1_boards %}, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the {% data variables.projects.projects_v1_board %} APIs, see "[AUTOTITLE](/graphql/reference/objects#project)" in the GraphQL API documentation or "[AUTOTITLE](/rest/projects)" in the REST API documentation. For example, you can run a workflow when a project has been `created` or `deleted`. @@ -517,7 +517,7 @@ on: {% endnote %} {% endif %} -Runs your workflow when a card on a project board is created or modified. For activity related to project boards or columns in a project board, use the [`project`](#project) or [`project_column`](#project_column) event instead. For more information about project boards, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the project card APIs, see "[AUTOTITLE](/graphql/reference/objects#projectcard)" in the GraphQL API documentation or "[AUTOTITLE](/rest/projects#cards)" in the REST API documentation. +Runs your workflow when a card on a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to {% data variables.projects.projects_v1_boards %} or columns in a {% data variables.projects.projects_v1_board %}, use the [`project`](#project) or [`project_column`](#project_column) event instead. For more information about {% data variables.projects.projects_v1_boards %}, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the project card APIs, see "[AUTOTITLE](/graphql/reference/objects#projectcard)" in the GraphQL API documentation or "[AUTOTITLE](/rest/projects#cards)" in the REST API documentation. For example, you can run a workflow when a project card has been `created` or `deleted`. @@ -555,7 +555,7 @@ on: {% endnote %} {% endif %} -Runs your workflow when a column on a project board is created or modified. For activity related to project boards or cards in a project board, use the [`project`](#project) or [`project_card`](#project_card) event instead. For more information about project boards, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the project column APIs, see "[AUTOTITLE](/graphql/reference/objects#projectcolumn)" in the GraphQL API documentation or "[AUTOTITLE](/rest/projects#columns)" in the REST API documentation. +Runs your workflow when a column on a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to {% data variables.projects.projects_v1_boards %} or cards in a {% data variables.projects.projects_v1_board %}, use the [`project`](#project) or [`project_card`](#project_card) event instead. For more information about {% data variables.projects.projects_v1_boards %}, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the project column APIs, see "[AUTOTITLE](/graphql/reference/objects#projectcolumn)" in the GraphQL API documentation or "[AUTOTITLE](/rest/projects#columns)" in the REST API documentation. For example, you can run a workflow when a project column has been `created` or `deleted`. diff --git a/content/actions/using-workflows/storing-workflow-data-as-artifacts.md b/content/actions/using-workflows/storing-workflow-data-as-artifacts.md index cb8a08c313..41646a06a3 100644 --- a/content/actions/using-workflows/storing-workflow-data-as-artifacts.md +++ b/content/actions/using-workflows/storing-workflow-data-as-artifacts.md @@ -180,15 +180,15 @@ Jobs that are dependent on a previous job's artifacts must wait for the dependen Job 1 performs these steps: - Performs a math calculation and saves the result to a text file called `math-homework.txt`. -- Uses the `upload-artifact` action to upload the `math-homework.txt` file with the artifact name `homework`. +- Uses the `upload-artifact` action to upload the `math-homework.txt` file with the artifact name `homework_pre`. Job 2 uses the result in the previous job: -- Downloads the `homework` artifact uploaded in the previous job. By default, the `download-artifact` action downloads artifacts to the workspace directory that the step is executing in. You can use the `path` input parameter to specify a different download directory. +- Downloads the `homework_pre` artifact uploaded in the previous job. By default, the `download-artifact` action downloads artifacts to the workspace directory that the step is executing in. You can use the `path` input parameter to specify a different download directory. - Reads the value in the `math-homework.txt` file, performs a math calculation, and saves the result to `math-homework.txt` again, overwriting its contents. -- Uploads the `math-homework.txt` file. This upload overwrites the previously uploaded artifact because they share the same name. +- Uploads the `math-homework.txt` file. As artifacts are considered immutable in `v4`, the artifact is passed a different input, `homework_final`, as a name. Job 3 displays the result uploaded in the previous job: -- Downloads the `homework` artifact. +- Downloads the `homework_final` artifact from Job 2. - Prints the result of the math equation to the log. The full math operation performed in this workflow example is `(3 + 7) x 9 = 90`. @@ -209,7 +209,7 @@ jobs: - name: Upload math result for job 1 uses: {% data reusables.actions.action-upload-artifact %} with: - name: homework + name: homework_pre path: math-homework.txt job_2: @@ -220,7 +220,7 @@ jobs: - name: Download math result for job 1 uses: {% data reusables.actions.action-download-artifact %} with: - name: homework + name: homework_pre - shell: bash run: | value=`cat math-homework.txt` @@ -228,7 +228,7 @@ jobs: - name: Upload math result for job 2 uses: {% data reusables.actions.action-upload-artifact %} with: - name: homework + name: homework_final path: math-homework.txt job_3: @@ -239,7 +239,7 @@ jobs: - name: Download math result for job 2 uses: {% data reusables.actions.action-download-artifact %} with: - name: homework + name: homework_final - name: Print the final result shell: bash run: | diff --git a/content/actions/using-workflows/workflow-syntax-for-github-actions.md b/content/actions/using-workflows/workflow-syntax-for-github-actions.md index 862d264d5a..862952d3bf 100644 --- a/content/actions/using-workflows/workflow-syntax-for-github-actions.md +++ b/content/actions/using-workflows/workflow-syntax-for-github-actions.md @@ -1130,7 +1130,7 @@ You can use special characters in path, branch, and tag filters. - `**`: Matches zero or more of any character. - `?`: Matches zero or one of the preceding character. - `+`: 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-z]` matches any digit or lowercase letter. For example, `[CB]at` matches `Cat` or `Bat` and `[1-2]00` matches `100` and `200`. +- `[]` Matches one alphanumeric 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. Also, if you use a [flow sequence](https://yaml.org/spec/1.2.2/#flow-sequences) with a pattern containing `[` and/or `]`, the pattern must be enclosed in quotes. diff --git a/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md b/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md index 17a7cb2f63..e427b55ebe 100644 --- a/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md +++ b/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md @@ -529,6 +529,12 @@ You can use these additional options with the utility: ghe-ssl-ca-certificate-install -c CERTIFICATE_PATH ``` +To apply the configuration, run the following command. During a configuration run, services on {% data variables.location.product_location %} may restart, which can cause brief downtime for users. + +```shell copy +ghe-config-apply +``` + ### ghe-ssl-certificate-setup This utility allows you to update an SSL certificate for {% data variables.location.product_location %}. diff --git a/content/admin/configuration/configuring-github-connect/about-github-connect.md b/content/admin/configuration/configuring-github-connect/about-github-connect.md index 2997ae6dd1..3d3cc023c0 100644 --- a/content/admin/configuration/configuring-github-connect/about-github-connect.md +++ b/content/admin/configuration/configuring-github-connect/about-github-connect.md @@ -28,7 +28,7 @@ After you configure the connection between {% data variables.location.product_lo | Feature | Description | More information | | ----------- | ----------- | ----------- |{% ifversion ghes %} -Automatic user license sync | Manage license usage across your {% data variables.product.prodname_enterprise %} deployments by automatically syncing user licenses from {% data variables.location.product_location %} to {% data variables.product.prodname_ghe_cloud %}. | "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-automatic-user-license-sync-for-your-enterprise)"{% endif %}{% ifversion ghes or ghae %} +Automatic user license sync | Manage license usage across your {% data variables.product.prodname_enterprise %} deployments by automatically syncing user licenses from {% data variables.location.product_location %} to {% data variables.product.prodname_ghe_cloud %}. | "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-automatic-user-license-sync-for-your-enterprise)"{% endif %}{% ifversion ghes %} {% data variables.product.prodname_dependabot %} | Allow users to find and fix vulnerabilities in code dependencies. | "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)"{% endif %} {% data variables.product.prodname_dotcom_the_website %} actions | Allow users to use actions from {% data variables.product.prodname_dotcom_the_website %} in public workflow files. | "[AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect)"{% ifversion server-statistics %} {% data variables.product.prodname_server_statistics %} | Analyze your own aggregate data from GitHub Enterprise Server, and help us improve GitHub products. | "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)"{% endif %} @@ -70,7 +70,7 @@ Additional data is transmitted if you enable individual features of {% data vari | Feature | Data | Which way does the data flow? | Where is the data used? | | ------- | ---- | --------- | ------ |{% ifversion ghes %} -Automatic user license sync | Each {% data variables.product.product_name %} user's user ID and email addresses | From {% data variables.product.product_name %} to {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %} |{% endif %}{% ifversion ghes or ghae %} +Automatic user license sync | Each {% data variables.product.product_name %} user's user ID and email addresses | From {% data variables.product.product_name %} to {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %} |{% endif %}{% ifversion ghes %} {% data variables.product.prodname_dependabot_alerts %} | Vulnerability alerts | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %} | {% data variables.product.product_name %} |{% endif %}{% ifversion dependabot-updates-github-connect %} {% data variables.product.prodname_dependabot_updates %} | Dependencies and the metadata for each dependency's repository

If a dependency is stored in a private repository on {% data variables.product.prodname_dotcom_the_website %}, data will only be transmitted if {% data variables.product.prodname_dependabot %} is configured and authorized to access that repository. | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %} | {% data variables.product.product_name %} {% endif %} {% data variables.product.prodname_dotcom_the_website %} actions | Name of action, action (YAML file from {% data variables.product.prodname_marketplace %}) | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %}

From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %}{% ifversion server-statistics %} diff --git a/content/admin/configuration/configuring-private-networking-for-hosted-compute-products/configuring-private-networking-for-github-hosted-runners.md b/content/admin/configuration/configuring-private-networking-for-hosted-compute-products/configuring-private-networking-for-github-hosted-runners.md index 61cd3dc497..14fb0111ea 100644 --- a/content/admin/configuration/configuring-private-networking-for-hosted-compute-products/configuring-private-networking-for-github-hosted-runners.md +++ b/content/admin/configuration/configuring-private-networking-for-hosted-compute-products/configuring-private-networking-for-github-hosted-runners.md @@ -113,53 +113,12 @@ You will use a script to automate configuring your Azure resources. direction: 'Outbound' destinationAddressPrefixes: [ '140.82.112.0/20' - '142.250.0.0/15' '143.55.64.0/20' - '192.30.252.0/22' '185.199.108.0/22' + '192.30.252.0/22' ] } - } - { - name: 'AllowInternetOutBoundMicrosoft' - properties: { - protocol: 'TCP' - sourcePortRange: '*' - destinationPortRange: '443' - sourceAddressPrefix: '*' - access: 'Allow' - priority: 230 - direction: 'Outbound' - destinationAddressPrefixes: [ - '13.64.0.0/11' - '13.96.0.0/13' - '13.104.0.0/14' - '20.33.0.0/16' - '20.34.0.0/15' - '20.36.0.0/14' - '20.40.0.0/13' - '20.48.0.0/12' - '20.64.0.0/10' - '20.128.0.0/16' - '52.224.0.0/11' - '204.79.197.200' - ] - } - } - { - name: 'AllowInternetOutBoundCannonical' - properties: { - protocol: 'TCP' - sourcePortRange: '*' - destinationPortRange: '443' - sourceAddressPrefix: '*' - destinationAddressPrefix: '185.125.188.0/22' - access: 'Allow' - priority: 240 - direction: 'Outbound' - destinationAddressPrefixes: [] - } - } + } ] } } diff --git a/content/admin/configuration/hardening-security-for-your-enterprise/troubleshooting-tls-errors.md b/content/admin/configuration/hardening-security-for-your-enterprise/troubleshooting-tls-errors.md index a161a83004..d2e088340d 100644 --- a/content/admin/configuration/hardening-security-for-your-enterprise/troubleshooting-tls-errors.md +++ b/content/admin/configuration/hardening-security-for-your-enterprise/troubleshooting-tls-errors.md @@ -90,6 +90,8 @@ If your {% data variables.product.prodname_ghe_server %} appliance interacts wit ghe-ssl-ca-certificate-install -c rootCA.crt ``` +{% data reusables.enterprise.apply-configuration %} + ## Updating a TLS certificate You can generate a new self-signed certificate or update an existing TLS certificate for {% data variables.location.product_location %} with the `ghe-ssl-certificate-setup` command line utility. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-ssl-ca-certificate-setup)." diff --git a/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/managing-self-hosted-runners-for-dependabot-updates.md b/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/managing-self-hosted-runners-for-dependabot-updates.md index 0107cade32..685b405da6 100644 --- a/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/managing-self-hosted-runners-for-dependabot-updates.md +++ b/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server/managing-self-hosted-runners-for-dependabot-updates.md @@ -64,6 +64,10 @@ If you specify more than 14 concurrent runners on a VM, you must also update the {% data variables.product.prodname_dependabot %} runners require access to the public internet, {% data variables.product.prodname_dotcom_the_website %}, and any internal registries that will be used in {% data variables.product.prodname_dependabot %} updates. To minimize the risk to your internal network, you should limit access from the Virtual Machine (VM) to your internal network. This reduces the potential for damage to internal systems if a runner were to download a hijacked dependency. +### Certificate configuration for {% data variables.product.prodname_dependabot %} runners + +If your {% data variables.product.prodname_ghe_server %} instance uses a self-signed certificate, or if {% data variables.product.prodname_dependabot %} needs to interact with registries that use self-signed certificates, those certificates must also be installed on the self-hosted runners that run {% data variables.product.prodname_dependabot %} jobs. This security hardens the connection. You must also configure Node.js to use the certificate, because most actions are written in JavaScript and run using Node.js, which does not use the operating system certificate store. + ### Adding self-hosted runners for {% data variables.product.prodname_dependabot %} updates 1. Provision self-hosted runners, at the repository, organization, or enterprise account level. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)" and "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners)." @@ -74,6 +78,8 @@ If you specify more than 14 concurrent runners on a VM, you must also update the - Recommended approach: [Run the Docker daemon as a non-root user (Rootless mode)](https://docs.docker.com/engine/security/rootless/) - Alternative approach: [Manage Docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) - Verify that the runners have access to the public internet and can only access the internal networks that {% data variables.product.prodname_dependabot %} needs. + - Install any self-signed certificates for your {% data variables.product.prodname_ghe_server %} instance or for registries that {% data variables.product.prodname_dependabot %} will need to interact with. + - Configure Node.js to use the same certificate. For more information, see "[AUTOTITLE](/admin/github-actions/advanced-configuration-and-troubleshooting/troubleshooting-github-actions-for-your-enterprise#configuring-nodejs-to-use-the-certificate)." 1. Assign a `dependabot` label to each runner you want {% data variables.product.prodname_dependabot %} to use. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/using-labels-with-self-hosted-runners#assigning-a-label-to-a-self-hosted-runner)." diff --git a/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md b/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md index e9edbb6e5e..b534fd5640 100644 --- a/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md +++ b/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md @@ -5,7 +5,6 @@ intro: 'You can configure a runner machine for your enterprise so your developer versions: ghec: '*' ghes: '*' - ghae: '*' permissions: 'Enterprise owners can configure policies for {% data variables.product.prodname_actions %} and add self-hosted runners to the enterprise.' type: quick_start topics: @@ -18,7 +17,7 @@ topics: {% data reusables.actions.about-actions-for-enterprises %} For more information, see "[AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises)." -With {% data variables.product.prodname_actions %}, developers can write and combine individual tasks called actions to create custom workflows. {% ifversion ghes or ghae %}To enable {% data variables.product.prodname_actions %} for {% ifversion ghae %}your enterprise{% elsif ghes %} {% data variables.location.product_location %}{% endif %}, you must host at least one machine to execute jobs.{% endif %} {% ifversion ghec %}You can host your own runner machine to execute jobs, and this{% elsif ghes or ghae %}This{% endif %} machine is called a self-hosted runner. {% data reusables.actions.self-hosted-runner-locations %} {% data reusables.actions.self-hosted-runner-architecture %} {% ifversion ghec %}All{% elsif ghes or ghae %}Self-hosted{% endif %} runners can run Linux, Windows, or macOS. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)." +With {% data variables.product.prodname_actions %}, developers can write and combine individual tasks called actions to create custom workflows. {% ifversion ghes %}To enable {% data variables.product.prodname_actions %} for {% ifversion ghes %} {% data variables.location.product_location %}{% endif %}, you must host at least one machine to execute jobs.{% endif %} {% ifversion ghec %}You can host your own runner machine to execute jobs, and this{% elsif ghes %}This{% endif %} machine is called a self-hosted runner. {% data reusables.actions.self-hosted-runner-locations %} {% data reusables.actions.self-hosted-runner-architecture %} {% ifversion ghec %}All{% elsif ghes %}Self-hosted{% endif %} runners can run Linux, Windows, or macOS. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)." {% ifversion ghec %} @@ -34,9 +33,9 @@ This guide shows you how to apply a centralized management approach to self-host 1. Optionally, further restrict the repositories that can use the runner 1. Optionally, {% ifversion actions-runner-controller %}to build and scale self-hosted runners automatically, use {% data variables.product.prodname_actions_runner_controller %} (ARC). For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-actions-runner-controller)."{% else %}build custom tooling to automatically scale your self-hosted runners{% endif %} -You'll also find additional information about how to monitor and secure your self-hosted runners,{% ifversion ghes or ghae %} how to access actions from {% data variables.product.prodname_dotcom_the_website %},{% endif %} and how to customize the software on your runner machines. +You'll also find additional information about how to monitor and secure your self-hosted runners,{% ifversion ghes %} how to access actions from {% data variables.product.prodname_dotcom_the_website %},{% endif %} and how to customize the software on your runner machines. -After you finish the guide, {% ifversion ghec or ghae %}members of your enterprise{% elsif ghes %}users of {% data variables.location.product_location %}{% endif %} will be able to run workflow jobs from {% data variables.product.prodname_actions %} on a self-hosted runner machine. +After you finish the guide, {% ifversion ghec %}members of your enterprise{% elsif ghes %}users of {% data variables.location.product_location %}{% endif %} will be able to run workflow jobs from {% data variables.product.prodname_actions %} on a self-hosted runner machine. ## Prerequisites @@ -46,7 +45,7 @@ After you finish the guide, {% ifversion ghec or ghae %}members of your enterpri ## 1. Configure policies for {% data variables.product.prodname_actions %} -First, enable {% data variables.product.prodname_actions %} for all organizations, and configure a policy to restrict the actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} that can run {% ifversion ghec or ghae%}within your enterprise on {% data variables.product.product_name %}{% elsif ghes %}on {% data variables.location.product_location %}{% endif %}. Optionally, organization owners can further restrict these policies for each organization. +First, enable {% data variables.product.prodname_actions %} for all organizations, and configure a policy to restrict the actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} that can run {% ifversion ghec %}within your enterprise on {% data variables.product.product_name %}{% elsif ghes %}on {% data variables.location.product_location %}{% endif %}. Optionally, organization owners can further restrict these policies for each organization. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} @@ -55,11 +54,11 @@ First, enable {% data variables.product.prodname_actions %} for all organization 1. To enable local actions{% ifversion actions-workflow-policy %} and reusable workflows, {% endif %} and actions created by {% data variables.product.company_short %}, select {% data reusables.actions.policy-label-for-select-actions-workflows %}, then select **Allow actions created by {% data variables.product.company_short %}**. 1. Click **Save**. -You can configure additional policies to restrict the actions available to {% ifversion ghec or ghae %}enterprise members{% elsif ghes %}users of {% data variables.location.product_location %}{% endif %}. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#allowing-select-actions-to-run)." +You can configure additional policies to restrict the actions available to {% ifversion ghec %}enterprise members{% elsif ghes %}users of {% data variables.location.product_location %}{% endif %}. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#allowing-select-actions-to-run)." ## 2. Deploy the self-hosted runner for your enterprise -Next, add a self-hosted runner to your enterprise. {% data variables.product.product_name %} will guide you through installation of the necessary software on the runner machine. After you deploy the runner, you can verify connectivity between the runner machine and {%ifversion ghec or ghae %}your enterprise{% elsif ghes %}{% data variables.location.product_location %}{% endif %}. +Next, add a self-hosted runner to your enterprise. {% data variables.product.product_name %} will guide you through installation of the necessary software on the runner machine. After you deploy the runner, you can verify connectivity between the runner machine and {%ifversion ghec %}your enterprise{% elsif ghes %}{% data variables.location.product_location %}{% endif %}. ### Adding the self-hosted runner @@ -110,7 +109,7 @@ For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managin {% ifversion actions-runner-controller %}Optionally, you can use {% data variables.product.prodname_actions_runner_controller %} (ARC) to automatically scale self-hosted runners. {% data reusables.actions.actions-runner-controller-about-arc %} -{% else %}Optionally, you can build custom tooling to automatically scale the self-hosted runners for {% ifversion ghec or ghae %}your enterprise{% elsif ghes %}{% data variables.location.product_location %}{% endif %}. For example, your tooling can respond to webhook events from {% data variables.location.product_location %} to automatically scale a cluster of runner machines. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/autoscaling-with-self-hosted-runners)." +{% else %}Optionally, you can build custom tooling to automatically scale the self-hosted runners for {% ifversion ghec %}your enterprise{% elsif ghes %}{% data variables.location.product_location %}{% endif %}. For example, your tooling can respond to webhook events from {% data variables.location.product_location %} to automatically scale a cluster of runner machines. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/autoscaling-with-self-hosted-runners)." {% endif %} ## Next steps @@ -119,12 +118,12 @@ For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managin - {% data variables.product.company_short %} recommends that you review security considerations for self-hosted runner machines. For more information, see "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#hardening-for-self-hosted-runners)." -- {% ifversion ghec %}If you use {% data variables.product.prodname_ghe_server %}, you{% elsif ghes or ghae %}You{% endif %} can manually sync repositories on {% data variables.product.prodname_dotcom_the_website %} containing actions to your enterprise on {% ifversion ghes or ghae %}{% data variables.product.product_name %}{% elsif ghec %}{% data variables.product.prodname_ghe_server %}{% endif %}. Alternatively, you can allow members of your enterprise to automatically access actions from {% data variables.product.prodname_dotcom_the_website %} by using {% data variables.product.prodname_github_connect %}. For more information, see the following. +- {% ifversion ghec %}If you use {% data variables.product.prodname_ghe_server %}, you{% elsif ghes %}You{% endif %} can manually sync repositories on {% data variables.product.prodname_dotcom_the_website %} containing actions to your enterprise on {% ifversion ghes %}{% data variables.product.product_name %}{% elsif ghec %}{% data variables.product.prodname_ghe_server %}{% endif %}. Alternatively, you can allow members of your enterprise to automatically access actions from {% data variables.product.prodname_dotcom_the_website %} by using {% data variables.product.prodname_github_connect %}. For more information, see the following. - - "[AUTOTITLE]({% ifversion ghec or ghae %}/enterprise-server@latest{% endif %}/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom)"{% ifversion ghec or ghae %} in the {% data variables.product.prodname_ghe_server %} documentation{% endif %} - - "[AUTOTITLE]({% ifversion ghec or ghae %}/enterprise-server@latest{% endif %}/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect)"{% ifversion ghec or ghae %} in the {% data variables.product.prodname_ghe_server %} documentation{% endif %} + - "[AUTOTITLE]({% ifversion ghec %}/enterprise-server@latest{% endif %}/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom)"{% ifversion ghec %} in the {% data variables.product.prodname_ghe_server %} documentation{% endif %} + - "[AUTOTITLE]({% ifversion ghec %}/enterprise-server@latest{% endif %}/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect)"{% ifversion ghec %} in the {% data variables.product.prodname_ghe_server %} documentation{% endif %} -- You can customize the software available on your self-hosted runner machines, or configure your runners to run software similar to {% data variables.product.company_short %}-hosted runners{% ifversion ghes or ghae %} available for customers using {% data variables.product.prodname_dotcom_the_website %}{% endif %}. The software that powers runner machines for {% data variables.product.prodname_actions %} is open source. For more information, see the [`actions/runner`](https://github.com/actions/runner) and [`actions/runner-images`](https://github.com/actions/runner-images) repositories. +- You can customize the software available on your self-hosted runner machines, or configure your runners to run software similar to {% data variables.product.company_short %}-hosted runners{% ifversion ghes %} available for customers using {% data variables.product.prodname_dotcom_the_website %}{% endif %}. The software that powers runner machines for {% data variables.product.prodname_actions %} is open source. For more information, see the [`actions/runner`](https://github.com/actions/runner) and [`actions/runner-images`](https://github.com/actions/runner-images) repositories. ## Further reading diff --git a/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md b/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md index 1f3e8db61c..5eaec49fb2 100644 --- a/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md +++ b/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md @@ -13,12 +13,12 @@ topics: - Enterprise shortTitle: Manually sync actions --- - + {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.enterprise-no-internet-actions %} -{% ifversion ghes or ghae %} +{% ifversion ghes %} The recommended approach of enabling access to actions from {% data variables.product.prodname_dotcom_the_website %} is to enable automatic access to all actions. You can do this by using {% data variables.product.prodname_github_connect %} to integrate {% data variables.product.product_name %} with {% data variables.product.prodname_ghe_cloud %}. For more information, see "[AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect)." @@ -45,9 +45,9 @@ The `actions-sync` tool can only download actions from {% data variables.product - If you want to sync the bundled actions in the `actions` organization on {% data variables.location.product_location %}, you must be an owner of the `actions` organization. {% note %} - + **Note:** By default, even site administrators are not owners of the bundled `actions` organization. - + {% endnote %} Site administrators can use the `ghe-org-admin-promote` command in the administrative shell to promote a user to be an owner of the bundled `actions` organization. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh)" and "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-org-admin-promote)." diff --git a/content/admin/identity-and-access-management/configuring-authentication-for-enterprise-managed-users/configuring-saml-single-sign-on-for-enterprise-managed-users.md b/content/admin/identity-and-access-management/configuring-authentication-for-enterprise-managed-users/configuring-saml-single-sign-on-for-enterprise-managed-users.md index 046f3015b1..3c41f7e483 100644 --- a/content/admin/identity-and-access-management/configuring-authentication-for-enterprise-managed-users/configuring-saml-single-sign-on-for-enterprise-managed-users.md +++ b/content/admin/identity-and-access-management/configuring-authentication-for-enterprise-managed-users/configuring-saml-single-sign-on-for-enterprise-managed-users.md @@ -114,7 +114,11 @@ After you enable SAML SSO, enable provisioning. For more information, see "[AUTO ### Enabling guest collaborators -If your enterprise uses {% data variables.product.prodname_emus %}, you can use the role of guest collaborator to grant limited access to vendors and contractors. Guest collaborators are provisioned by your IdP, and only have access to the specific repositories or organizations you add them to. Guest collaborators only have access to internal repositories within organizations where they are a member and private repositories they are expressly authorized to access. Guest collaborators will never see internal repositories in an organization they are not a member of. For more information, see "[AUTOTITLE](/admin/enterprise-cloud@latest/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/roles-in-an-enterprise#guest-collaborators)." +{% data reusables.emus.guest-collaborators-note %} + +If your enterprise uses {% data variables.product.prodname_emus %}, you can use the role of guest collaborator to grant limited access to vendors and contractors. For more information, see "[AUTOTITLE](/admin/enterprise-cloud@latest/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/roles-in-an-enterprise#guest-collaborators)." + +All repository access for organization members, including guest collaborators, is governed by the base permission policy for the organization. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/setting-base-permissions-for-an-organization)." If you use Azure AD or Okta for SAML authentication, you may need to update your IdP application to use guest collaborators. diff --git a/content/admin/identity-and-access-management/iam-configuration-reference/saml-configuration-reference.md b/content/admin/identity-and-access-management/iam-configuration-reference/saml-configuration-reference.md index 567615bbcf..67539a65c0 100644 --- a/content/admin/identity-and-access-management/iam-configuration-reference/saml-configuration-reference.md +++ b/content/admin/identity-and-access-management/iam-configuration-reference/saml-configuration-reference.md @@ -83,12 +83,12 @@ The following SAML attributes are available for {% data variables.product.produc | :- | :- | :- | | `NameID` | {% octicon "check" aria-label="Required" %} | A persistent user identifier. Any persistent name identifier format may be used. {% ifversion ghec %}If you use an enterprise with {% data variables.product.prodname_emus %}, {% endif %}{% data variables.product.product_name %} will normalize the `NameID` element to use as a username unless one of the alternative assertions is provided. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication)."

{% note %}**Note:** It's important to use a human-readable, persistent identifier. Using a transient identifier format like `urn:oasis:names:tc:SAML:2.0:nameid-format:transient` will result in re-linking of accounts on every sign-in, which can be detrimental to authorization management.{% endnote %} | | `SessionNotOnOrAfter` | {% octicon "x" aria-label="Optional" %} | The date that {% data variables.product.product_name %} invalidates the associated session. After invalidation, the person must authenticate once again to access {% ifversion ghec or ghae %}your enterprise's resources{% elsif ghes %}{% data variables.location.product_location %}{% endif %}. For more information, see "[Session duration and timeout](#session-duration-and-timeout)." | -{%- ifversion ghes or ghae %} +{%- ifversion ghes %} | `administrator` | {% octicon "x" aria-label="Optional" %} | When the value is `true`, {% data variables.product.product_name %} will automatically promote the user to be a {% ifversion ghes %}site administrator{% elsif ghae %}enterprise owner{% endif %}. Setting this attribute to anything but `true` will result in demotion, as long as the value is not blank. Omitting this attribute or leaving the value blank will not change the role of the user. | | `username` | {% octicon "x" aria-label="Optional" %} | The username for {% data variables.location.product_location %}. | {%- endif %} | `full_name` | {% octicon "x" aria-label="Optional" %} | {% ifversion ghec %}If you configure SAML SSO for an enterprise and you use {% data variables.product.prodname_emus %}, the{% else %}The{% endif %} full name of the user to display on the user's profile page. | -| `emails` | {% octicon "x" aria-label="Optional" %} | The email addresses for the user.{% ifversion ghes or ghae %} You can specify more than one address.{% endif %}{% ifversion ghec or ghes %} If you sync license usage between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}, {% data variables.product.prodname_github_connect %} uses `emails` to identify unique users across products. For more information, see "[AUTOTITLE](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)."{% endif %} | +| `emails` | {% octicon "x" aria-label="Optional" %} | The email addresses for the user.{% ifversion ghes %} You can specify more than one address.{% endif %}{% ifversion ghec or ghes %} If you sync license usage between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}, {% data variables.product.prodname_github_connect %} uses `emails` to identify unique users across products. For more information, see "[AUTOTITLE](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)."{% endif %} | | `public_keys` | {% octicon "x" aria-label="Optional" %} | {% ifversion ghec %}If you configure SAML SSO for an enterprise and you use {% data variables.product.prodname_emus %}, the{% else %}The{% endif %} public SSH keys for the user. You can specify more than one key. | | `gpg_keys` | {% octicon "x" aria-label="Optional" %} | {% ifversion ghec %}If you configure SAML SSO for an enterprise and you use {% data variables.product.prodname_emus %}, the{% else %}The{% endif %} GPG keys for the user. You can specify more than one key. | @@ -106,7 +106,7 @@ To specify more than one value for an attribute, use multiple `` element on the root response document and match the ACS URL only when the root response document is signed. If your IdP signs the assertion, {% data variables.product.product_name %} will ignore the assertion. -- Your IdP must always provide the `` element as part of the `` element. The value must match your `EntityId` for {% data variables.product.product_name %}.{% ifversion ghes or ghae %} This value is the URL where you access {% data variables.location.product_location %}, such as {% ifversion ghes %}`http(s)://HOSTNAME`{% elsif ghae %}`https://SUBDOMAIN.githubenterprise.com`, `https://SUBDOMAIN.github.us`, or `https://SUBDOMAIN.ghe.com`{% endif %}.{% endif %} +- Your IdP must always provide the `` element as part of the `` element. The value must match your `EntityId` for {% data variables.product.product_name %}.{% ifversion ghes %} This value is the URL where you access {% data variables.location.product_location %}, such as {% ifversion ghes %}`http(s)://HOSTNAME`{% elsif ghae %}`https://SUBDOMAIN.githubenterprise.com`, `https://SUBDOMAIN.github.us`, or `https://SUBDOMAIN.ghe.com`{% endif %}.{% endif %} {%- ifversion ghec %} - If you configure SAML for an organization, this value is `https://github.com/orgs/ORGANIZATION`. diff --git a/content/admin/identity-and-access-management/iam-configuration-reference/username-considerations-for-external-authentication.md b/content/admin/identity-and-access-management/iam-configuration-reference/username-considerations-for-external-authentication.md index 3daba543e0..2f8f367360 100644 --- a/content/admin/identity-and-access-management/iam-configuration-reference/username-considerations-for-external-authentication.md +++ b/content/admin/identity-and-access-management/iam-configuration-reference/username-considerations-for-external-authentication.md @@ -76,7 +76,7 @@ Usernames{% ifversion ghec %}, including underscore and short code,{% endif %} m ## About username normalization -Usernames for user accounts on {% ifversion ghes or ghae %}{% data variables.product.product_name %}{% elsif ghec %}{% data variables.product.prodname_dotcom_the_website %}{% endif %} can only contain alphanumeric characters and dashes (`-`). +Usernames for user accounts on {% ifversion ghes %}{% data variables.product.product_name %}{% elsif ghec %}{% data variables.product.prodname_dotcom_the_website %}{% endif %} can only contain alphanumeric characters and dashes (`-`). {% ifversion ghec %} When you configure SAML authentication, {% data variables.product.product_name %} uses the SCIM `userName` attribute value sent from the IdP to determine the username for the corresponding user account on {% data variables.product.prodname_dotcom_the_website %}. If this value includes unsupported characters, {% data variables.product.product_name %} will normalize the username per the following rules. diff --git a/content/admin/identity-and-access-management/using-cas-for-enterprise-iam/using-cas.md b/content/admin/identity-and-access-management/using-cas-for-enterprise-iam/using-cas.md index 1a3128cbcb..540b5f9970 100644 --- a/content/admin/identity-and-access-management/using-cas-for-enterprise-iam/using-cas.md +++ b/content/admin/identity-and-access-management/using-cas-for-enterprise-iam/using-cas.md @@ -48,3 +48,4 @@ No other attributes are available. 1. Under "Authentication", select **CAS**. 1. {% data reusables.enterprise_user_management.built-in-authentication-option %} 1. In the **Server URL** field, type the full URL of your CAS server. If your CAS server uses a certificate that can't be validated by {% data variables.product.prodname_ghe_server %}, you can use the `ghe-ssl-ca-certificate-install` command to install it as a trusted certificate. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-ssl-ca-certificate-install)." +{% data reusables.enterprise.apply-configuration %} diff --git a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/index.md b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/index.md index f3d5025e90..4992bb4e94 100644 --- a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/index.md +++ b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/index.md @@ -1,7 +1,7 @@ --- title: Using SAML for enterprise IAM shortTitle: SAML for enterprise IAM -intro: 'You can centrally manage {% ifversion ghes or ghae %}accounts and {% endif %}access to {% ifversion ghes %}{% data variables.location.product_location %}{% elsif ghae %}your enterprise{% elsif ghec %}your enterprise''s resources{% endif %} with SAML single sign-on (SSO){% ifversion ghec or ghae %} and System for Cross-domain Identity Management (SCIM){% endif %}.' +intro: 'You can centrally manage {% ifversion ghes %}accounts and {% endif %}access to {% ifversion ghes %}{% data variables.location.product_location %}{% elsif ghae %}your enterprise{% elsif ghec %}your enterprise''s resources{% endif %} with SAML single sign-on (SSO){% ifversion ghec or ghae %} and System for Cross-domain Identity Management (SCIM){% endif %}.' versions: ghec: '*' ghes: '*' diff --git a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/updating-a-users-saml-nameid.md b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/updating-a-users-saml-nameid.md index 938c06089e..b7f7270cec 100644 --- a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/updating-a-users-saml-nameid.md +++ b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/updating-a-users-saml-nameid.md @@ -1,7 +1,7 @@ --- title: Updating a user's SAML NameID shortTitle: Update SAML NameID -intro: 'When an account''s `NameID` changes on your identity provider (IdP) and the person can no longer {% ifversion ghes or ghae %}sign into {% data variables.location.product_location %}{% elsif ghec %}authenticate to access your enterprise''s resources{% endif %}, you must {% ifversion ghec %}either contact {% data variables.product.company_short %} Support or revoke the person''s linked identity{% elsif ghes %}update the `NameID` mapping on {% data variables.location.product_location %}{% elsif ghae %}contact {% data variables.product.company_short %} Support{% endif %}.' +intro: 'When an account''s `NameID` changes on your identity provider (IdP) and the person can no longer {% ifversion ghes %}sign into {% data variables.location.product_location %}{% elsif ghec %}authenticate to access your enterprise''s resources{% endif %}, you must {% ifversion ghec %}either contact {% data variables.product.company_short %} Support or revoke the person''s linked identity{% elsif ghes %}update the `NameID` mapping on {% data variables.location.product_location %}{% elsif ghae %}contact {% data variables.product.company_short %} Support{% endif %}.' versions: ghes: '*' type: how_to diff --git a/content/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/configuring-custom-footers.md b/content/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/configuring-custom-footers.md index c1be9fcdf0..5116324810 100644 --- a/content/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/configuring-custom-footers.md +++ b/content/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/configuring-custom-footers.md @@ -17,7 +17,7 @@ redirect_from: ## About custom footers for {% ifversion ghec or ghae %}your enterprise{% elsif ghes %}{% data variables.product.product_name %}{% endif %} -You can configure the web UI for {% data variables.product.product_name %} to display a custom footer with up to five additional links. The custom footer appears above the default {% data variables.product.prodname_dotcom %} footer{% ifversion ghes or ghae %}, to all users and on all pages{% elsif ghec %} to all enterprise members and collaborators, on all repository and organization pages for repositories and organizations that belong to the enterprise{% endif %}. +You can configure the web UI for {% data variables.product.product_name %} to display a custom footer with up to five additional links. The custom footer appears above the default {% data variables.product.prodname_dotcom %} footer{% ifversion ghes %}, to all users and on all pages{% elsif ghec %} to all enterprise members and collaborators, on all repository and organization pages for repositories and organizations that belong to the enterprise{% endif %}. ## Configuring custom footers diff --git a/content/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/customizing-user-messages-for-your-enterprise.md b/content/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/customizing-user-messages-for-your-enterprise.md index 9e84e7dd70..f1ebd49c23 100644 --- a/content/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/customizing-user-messages-for-your-enterprise.md +++ b/content/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/customizing-user-messages-for-your-enterprise.md @@ -11,7 +11,6 @@ intro: 'You can create custom messages that users will see on {% data variables. versions: ghec: '*' ghes: '*' - ghae: '*' type: how_to topics: - Enterprise @@ -54,24 +53,24 @@ There are several types of user messages. {% endif %} -{% ifversion ghes or ghae %} +{% ifversion ghes %} ## Creating a custom sign out message {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.messages-tab %} -1. {% ifversion ghes or ghae %}To the right of{% else %}Under{% endif %} "Sign out page", click **Add message** or **Edit message**. +1. {% ifversion ghes %}To the right of{% else %}Under{% endif %} "Sign out page", click **Add message** or **Edit message**. ![Screenshot of the "Sign out page" section of the "Messages" settings. A button, labeled with a plus icon and "Add message," is highlighted with an orange outline.](/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png) 1. Under **Sign out message**, type the message you'd like users to see. -{% ifversion ghes or ghae %} +{% ifversion ghes %} {% data reusables.enterprise_site_admin_settings.message-preview-save %}{% else %} {% data reusables.enterprise_site_admin_settings.click-preview %} 1. Review the rendered message. {% data reusables.enterprise_site_admin_settings.save-changes %}{% endif %}{% endif %} -{% ifversion ghes or ghae %} +{% ifversion ghes %} ## Creating a mandatory message @@ -114,7 +113,7 @@ You can set a global announcement banner to be displayed to all users at the top {% ifversion custom-banner-messages %} You can also create announcement banners at the organization level. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/creating-an-announcement-banner-for-your-organization)."{% endif %} -{% ifversion ghae or ghes %} +{% ifversion ghes %} You can also set an announcement banner{% ifversion ghes %} in the administrative shell using a command line utility or{% endif %} using the API. For more information, see {% ifversion ghes %}"[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-announce)" and {% endif %}"[AUTOTITLE](/rest/enterprise-admin#announcements)." {% endif %} diff --git a/content/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/configuring-visibility-for-organization-membership.md b/content/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/configuring-visibility-for-organization-membership.md index 8bba058530..b6aaa3478e 100644 --- a/content/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/configuring-visibility-for-organization-membership.md +++ b/content/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/configuring-visibility-for-organization-membership.md @@ -20,7 +20,7 @@ You can also enforce your default setting on all current organization members in {% endif %} {% data reusables.enterprise-accounts.access-enterprise %} -{% ifversion ghes or ghae %} +{% ifversion ghes %} {% data reusables.enterprise-accounts.policies-tab %} {% else %} {% data reusables.enterprise-accounts.settings-tab %} diff --git a/content/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/preventing-users-from-creating-organizations.md b/content/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/preventing-users-from-creating-organizations.md index 24e5b3bc1d..355bfd4e61 100644 --- a/content/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/preventing-users-from-creating-organizations.md +++ b/content/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/preventing-users-from-creating-organizations.md @@ -18,7 +18,7 @@ topics: shortTitle: Prevent organization creation --- {% data reusables.enterprise-accounts.access-enterprise %} -{% ifversion ghes or ghae %} +{% ifversion ghes %} {% data reusables.enterprise-accounts.policies-tab %} {% else %} {% data reusables.enterprise-accounts.settings-tab %} diff --git a/content/admin/managing-accounts-and-repositories/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md b/content/admin/managing-accounts-and-repositories/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md index 0c425bc7fd..c00cd4d0ae 100644 --- a/content/admin/managing-accounts-and-repositories/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md +++ b/content/admin/managing-accounts-and-repositories/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md @@ -39,7 +39,7 @@ For more information, see "[AUTOTITLE](/repositories/working-with-files/managing ## Configuring {% data variables.large_files.product_name_long %} for your enterprise {% data reusables.enterprise-accounts.access-enterprise %} -{% ifversion ghes or ghae %} +{% ifversion ghes %} {% data reusables.enterprise-accounts.policies-tab %} {% else %} {% data reusables.enterprise-accounts.settings-tab %} diff --git a/content/admin/managing-accounts-and-repositories/managing-repositories-in-your-enterprise/disabling-git-ssh-access-on-your-enterprise.md b/content/admin/managing-accounts-and-repositories/managing-repositories-in-your-enterprise/disabling-git-ssh-access-on-your-enterprise.md index 6900ff03aa..2ce6c23bec 100644 --- a/content/admin/managing-accounts-and-repositories/managing-repositories-in-your-enterprise/disabling-git-ssh-access-on-your-enterprise.md +++ b/content/admin/managing-accounts-and-repositories/managing-repositories-in-your-enterprise/disabling-git-ssh-access-on-your-enterprise.md @@ -53,7 +53,7 @@ shortTitle: Disable SSH for Git ## Disabling Git SSH access to all repositories in your enterprise {% data reusables.enterprise-accounts.access-enterprise %} -{% ifversion ghes or ghae %} +{% ifversion ghes %} {% data reusables.enterprise-accounts.policies-tab %} {% else %} {% data reusables.enterprise-accounts.settings-tab %} diff --git a/content/admin/managing-accounts-and-repositories/managing-repositories-in-your-enterprise/migrating-to-internal-repositories.md b/content/admin/managing-accounts-and-repositories/managing-repositories-in-your-enterprise/migrating-to-internal-repositories.md index 24440a8269..8bf53326b7 100644 --- a/content/admin/managing-accounts-and-repositories/managing-repositories-in-your-enterprise/migrating-to-internal-repositories.md +++ b/content/admin/managing-accounts-and-repositories/managing-repositories-in-your-enterprise/migrating-to-internal-repositories.md @@ -40,7 +40,7 @@ If you don't have private mode enabled, the migration script will have no effect ## Running the migration 1. Connect to the administrative shell. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh)." -{% ifversion ghes or ghae %} +{% ifversion ghes %} 1. Run the migration command. ```shell diff --git a/content/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/roles-in-an-enterprise.md b/content/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/roles-in-an-enterprise.md index 90f323c208..35066ddc51 100644 --- a/content/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/roles-in-an-enterprise.md +++ b/content/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/roles-in-an-enterprise.md @@ -86,19 +86,15 @@ People with outside collaborator access to repositories owned by your organizati ## Guest collaborators -{% note %} +{% data reusables.emus.guest-collaborators-note %} -**Note:** The guest collaborator role is only available with {% data variables.product.prodname_emus %}. This feature is currently in public beta and subject to change. +If your enterprise uses {% data variables.product.prodname_emus %}, you can use the role of guest collaborator to grant limited access to vendors and contractors. Like all {% data variables.enterprise.prodname_managed_users %}, guest collaborators are provisioned by your IdP. Unlike enterprise members, guest collaborators only have access to internal repositories within organizations where they are a member. Guest collaborators will never see internal repositories in an organization they are not a member of. -{% endnote %} +The base permission policy for an organization controls whether or not the guest collaborator has access to private repositories in an organization they are a member of, just like it will for other enterprise members. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/setting-base-permissions-for-an-organization)." -If your enterprise uses {% data variables.product.prodname_emus %}, you can use the role of guest collaborator to grant limited access to vendors and contractors. Like all {% data variables.enterprise.prodname_managed_users %}, guest collaborators are provisioned by your IdP. Unlike enterprise members, guest collaborators only have access to the specific repositories or organizations you add them to. +Guest collaborators can be members of IdP groups that are connected to {% data variables.product.prodname_dotcom %} teams, and will be added to the organization via SCIM, just like other enterprise members. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/managing-team-memberships-with-identity-provider-groups)." -Currently, guest collaborators must be added to an organization team in order to be granted access to repositories within that organization. When they are added to an organization team they become organization members. Guest collaborators only have access to internal repositories within organizations where they are a member and private repositories they are expressly authorized to access. Guest collaborators will never see internal repositories in an organization they are not a member of. - -Guest collaborators can be members of IdP groups that are connected to {% data variables.product.prodname_dotcom %} teams. However, guest collaborators are never added to an organization via SCIM. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/managing-team-memberships-with-identity-provider-groups)." - -If you want to prevent a user from accessing internal repositories, make sure that the only role assigned to the user is guest collaborator, both directly and via group membership. If the same user is assigned multiple roles, the more privileged role will override the less privileged role. For example, if you assign the guest collaborator role directly to a user, but the user is also a member of a group that's assigned the enterprise owner role, the user will have full privileges of an enterprise owner. +When provisioning your guest collaborators, make sure that the only role assigned to the user in your IdP is guest collaborator. This applies to both direct assignment, and group memberships. If the same user is assigned multiple roles, the more privileged role will override the less privileged role. For example, if you assign the guest collaborator role directly to a user, but the user is also a member of a group that's assigned the enterprise owner role, the user will have the full privileges of an enterprise owner. If you use Azure AD or Okta for SAML authentication, you may need to update your IdP application to use guest collaborators. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/configuring-authentication-for-enterprise-managed-users/configuring-saml-single-sign-on-for-enterprise-managed-users#enabling-guest-collaborators)." diff --git a/content/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md b/content/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md index 8f85e2699e..41a7e8ea2c 100644 --- a/content/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md +++ b/content/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/viewing-people-in-your-enterprise.md @@ -187,7 +187,7 @@ If your enterprise uses {% data variables.product.prodname_emus %}, you can view ## Viewing dormant users -You can view a list of all dormant users {% ifversion ghes or ghae %} who have not been suspended and {% endif %}who are not site administrators. {% data reusables.enterprise-accounts.dormant-user-activity-threshold %} For more information, see "[AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users)." +You can view a list of all dormant users {% ifversion ghes %} who have not been suspended and {% endif %}who are not site administrators. {% data reusables.enterprise-accounts.dormant-user-activity-threshold %} For more information, see "[AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users)." {% ifversion filter-by-enterprise-member-type %} diff --git a/content/admin/monitoring-activity-in-your-enterprise/index.md b/content/admin/monitoring-activity-in-your-enterprise/index.md index 229bc23617..fa69cd7d09 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/index.md +++ b/content/admin/monitoring-activity-in-your-enterprise/index.md @@ -1,6 +1,6 @@ --- title: Monitoring activity in your enterprise -intro: 'You can view user and system activity by leveraging audit logs{% ifversion ghes or ghae %}, push logs, dashboards, webhooks, and log forwarding{% else %}and webhooks{% endif %}.' +intro: 'You can view user and system activity by leveraging audit logs{% ifversion ghes %}, push logs, dashboards, webhooks, and log forwarding{% else %}and webhooks{% endif %}.' redirect_from: - /enterprise/admin/installation/monitoring-activity-on-your-github-enterprise-server-instance versions: diff --git a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise.md b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise.md index e5563d5877..20dfa5f8b7 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise.md +++ b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise.md @@ -40,7 +40,7 @@ topics: {% data reusables.enterprise_site_admin_settings.access-settings %} 1. In the left menu, click **Audit log**.{% endif %} -In addition to viewing your audit log, you can monitor activity in your enterprise in other ways, such as {% ifversion ghes or ghae %}viewing push logs and {% endif %}managing global webhooks. For more information, see "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/exploring-user-activity)." You can also use the audit log, and other tools, to monitor the actions taken in response to security alerts. For more information, see "[AUTOTITLE](/code-security/getting-started/auditing-security-alerts)." +In addition to viewing your audit log, you can monitor activity in your enterprise in other ways, such as {% ifversion ghes %}viewing push logs and {% endif %}managing global webhooks. For more information, see "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/exploring-user-activity)." You can also use the audit log, and other tools, to monitor the actions taken in response to security alerts. For more information, see "[AUTOTITLE](/code-security/getting-started/auditing-security-alerts)." ## Using your audit logs diff --git a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md index bd051bc92f..44821cafb5 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md +++ b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md @@ -12,7 +12,6 @@ redirect_from: versions: ghec: '*' ghes: '*' - ghae: '*' type: reference topics: - Auditing diff --git a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/index.md b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/index.md index b820feece5..04025994cd 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/index.md +++ b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/index.md @@ -5,7 +5,6 @@ shortTitle: Review audit logs versions: ghec: '*' ghes: '*' - ghae: '*' topics: - Enterprise children: @@ -20,4 +19,3 @@ children: - /using-the-audit-log-api-for-your-enterprise - /audit-log-events-for-your-enterprise --- - diff --git a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise.md b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise.md index bcaab95c3f..2c32350e27 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise.md +++ b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise.md @@ -63,38 +63,38 @@ Key | Value -------------- | -------------------------------------------------------- `action` | Name of the audited action. `actor` | Name of the user account that initiated the action. -{%- ifversion ghes or ghae %} +{%- ifversion ghes %} `actor_id` | ID of the user account that initiated the action.{% endif %} -{%- ifversion ghes or ghae %} +{%- ifversion ghes %} `actor_ip` | IP address from which the action was initiated.{% endif %} -{%- ifversion ghes or ghae %} +{%- ifversion ghes %} `business` | Name of the enterprise affected by the action (if applicable).{% endif %} -{%- ifversion ghes or ghae %} +{%- ifversion ghes %} `business_id` | ID of the enterprise affected by the action (if applicable).{% endif %} {%- ifversion token-audit-log %} `created` | Time at which the action occurred.{% ifversion ghes %} If querying the audit log from the site admin dashboard, use `created_at` instead.{% endif %} `country` | Name of the country where the actor was when performing the action. `country_code` | Two-letter short code of the country where the actor was when performing the action. -{%- ifversion ghes or ghae %} +{%- ifversion ghes %} `from` | View from which the action was initiated.{% endif %} `hashed_token` | The token used to authenticate for the action (if applicable, see "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/identifying-audit-log-events-performed-by-an-access-token)"). {% endif %} `ip` | IP address of the actor. -{%- ifversion ghes or ghae %} +{%- ifversion ghes %} `note` | Miscellaneous event-specific information (in either plain text or JSON format).{% endif %} -{%- ifversion ghes or ghae %} +{%- ifversion ghes %} `oauth_app_id` | ID of the {% data variables.product.prodname_oauth_app %} associated with the action.{% endif %} `operation` | Operation type that corresponds with the action. Operation types are `create`, `access`, `modify`, `remove`, `authentication`, `transfer`, and `restore`. -{%- ifversion ghes or ghae %} +{%- ifversion ghes %} `org` | Name of the organization affected by the action (if applicable).{% endif %} -{%- ifversion ghes or ghae %} +{%- ifversion ghes %} `org_id` | ID of the organization affected by the action (if applicable).{% endif %} -{%- ifversion ghes or ghae %} +{%- ifversion ghes %} `repo_id` | ID of the repository affected by the action (if applicable).{% endif %} -{%- ifversion ghes or ghae %} +{%- ifversion ghes %} `repository` | Name with owner of the repository where the action occurred (such as `"octocat/octo-repo"`).{% endif %} {%- ifversion ghec %} `repository` | Name with owner of the repository where the action occurred (such as `octocat/octo-repo`).{% endif %} -{%- ifversion ghes or ghae %} +{%- ifversion ghes %} `user_id` | ID of the user affected by the action.{% endif %} `user` | Name of the user affected by the action. diff --git a/content/admin/overview/about-enterprise-accounts.md b/content/admin/overview/about-enterprise-accounts.md index 33571185e1..ce6f34dad5 100644 --- a/content/admin/overview/about-enterprise-accounts.md +++ b/content/admin/overview/about-enterprise-accounts.md @@ -47,7 +47,7 @@ Your enterprise account allows you to manage and enforce policies for all the or ## About administration of your enterprise account -{% ifversion ghes or ghae %} +{% ifversion ghes %} From your enterprise account on {% ifversion ghae %}{% data variables.product.product_name %}{% elsif ghes %}a {% data variables.product.prodname_ghe_server %} instance{% endif %}, administrators can view{% ifversion remove-enterprise-members %} and manage{% endif %} enterprise membership{% ifversion enterprise-owner-join-org %}, manage their own membership in organizations owned by the enterprise,{% endif %} and manage the following for the {% ifversion ghes %}{% data variables.product.prodname_ghe_server %} instance{% elsif ghae %}enterprise on {% data variables.product.prodname_ghe_managed %}{% endif %}. diff --git a/content/admin/overview/about-github-for-enterprises.md b/content/admin/overview/about-github-for-enterprises.md index ecf8de9d44..2272746cda 100644 --- a/content/admin/overview/about-github-for-enterprises.md +++ b/content/admin/overview/about-github-for-enterprises.md @@ -30,7 +30,7 @@ For a full list of features available with {% data variables.product.prodname_en For {% data variables.product.prodname_ghe_cloud %}, you can allow developers to create and manage their own personal accounts, or you can use {% data variables.product.prodname_emus %}, which enables you to create and manage the user accounts for your developers. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise)." -You can benefit from the power of {% data variables.product.prodname_dotcom_the_website %} even while using {% data variables.product.prodname_ghe_server %}{% ifversion ghae %} or {% data variables.product.prodname_ghe_managed %}{% endif %} by enabling {% data variables.product.prodname_github_connect %}, which allows you to configure additional features and workflows such as {% data variables.product.prodname_dependabot_alerts %} for insecure dependencies. For more information, see "[About {% data variables.product.prodname_github_connect %}]({% ifversion ghec %}/enterprise-server@latest{% endif %}/admin/configuration/configuring-github-connect/about-github-connect){% ifversion ghes or ghae %}."{% elsif ghec %}" in the {% data variables.product.prodname_ghe_server %} documentation.{% endif %} +You can benefit from the power of {% data variables.product.prodname_dotcom_the_website %} even while using {% data variables.product.prodname_ghe_server %}{% ifversion ghae %} or {% data variables.product.prodname_ghe_managed %}{% endif %} by enabling {% data variables.product.prodname_github_connect %}, which allows you to configure additional features and workflows such as {% data variables.product.prodname_dependabot_alerts %} for insecure dependencies. For more information, see "[About {% data variables.product.prodname_github_connect %}]({% ifversion ghec %}/enterprise-server@latest{% endif %}/admin/configuration/configuring-github-connect/about-github-connect){% ifversion ghes %}."{% elsif ghec %}" in the {% data variables.product.prodname_ghe_server %} documentation.{% endif %} ## Further reading diff --git a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md index 9dd5bd0505..66081beb6a 100644 --- a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md +++ b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md @@ -43,7 +43,7 @@ You can choose to disable {% data variables.product.prodname_actions %} for all {% data reusables.actions.actions-use-policy-settings %} - {%- ifversion ghes or ghae %} + {%- ifversion ghes %} {% note %} **Note:** To enable access to public actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %}, you must first configure {% data variables.location.product_location %} to connect to {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect)." diff --git a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-projects-in-your-enterprise.md b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-projects-in-your-enterprise.md index f1c7aadbf5..b910d4fc92 100644 --- a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-projects-in-your-enterprise.md +++ b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-projects-in-your-enterprise.md @@ -19,7 +19,7 @@ topics: - Enterprise - Policies - Projects -shortTitle: Project board policies +shortTitle: Projects policies --- ## About policies for projects in your enterprise @@ -31,7 +31,7 @@ Some policies apply to both {% data variables.product.prodname_projects_v2 %}, t ## Enforcing a policy for organization-wide projects -Across all organizations owned by your enterprise, you can enable or disable organization-wide project boards, or allow owners to administer the setting on the organization level. +Across all organizations owned by your enterprise, you can enable or disable organization-wide {% data variables.projects.projects_v1_boards %}, or allow owners to administer the setting on the organization level. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} diff --git a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md index cebe4b9cec..d607cf44b9 100644 --- a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md +++ b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md @@ -50,7 +50,7 @@ shortTitle: Repository management policies You can enforce policies to control how members of your enterprise on {% data variables.product.product_name %} manage repositories. You can also allow organization owners to manage policies for repository management. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories) and "[AUTOTITLE](/organizations)." -{% ifversion ghes or ghae %} +{% ifversion ghes %} ## Configuring the default visibility of new repositories @@ -59,7 +59,7 @@ Each time someone creates a new repository within your enterprise, that person m If an enterprise owner disallows members from creating certain types of repositories, members will not be able to create that type of repository even if the visibility setting defaults to that type. For more information, see "[Enforcing a policy for repository creation](#enforcing-a-policy-for-repository-creation)." {% data reusables.enterprise-accounts.access-enterprise %} -{% ifversion ghes or ghae %} +{% ifversion ghes %} {% data reusables.enterprise-accounts.policies-tab %} {% else %} {% data reusables.enterprise-accounts.settings-tab %} @@ -181,7 +181,7 @@ Across all organizations owned by your enterprise, you can allow members with ad 1. On the **Repository policies** tab, under "Repository issue deletion", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} 1. Under "Repository issue deletion", select the dropdown menu and click a policy. -{% ifversion ghes or ghae %} +{% ifversion ghes %} ## Enforcing a policy for Git push limits @@ -226,7 +226,7 @@ Across all organizations owned by your enterprise, you can allow members to see Requiring users to resolve merge conflicts locally on their computer can prevent people from inadvertently writing to an upstream repository from a fork. {% data reusables.enterprise-accounts.access-enterprise %} -{% ifversion ghes or ghae %} +{% ifversion ghes %} {% data reusables.enterprise-accounts.policies-tab %} {% else %} {% data reusables.enterprise-accounts.settings-tab %} @@ -298,7 +298,7 @@ If necessary, you can prevent repository administrators from changing anonymous ### Setting anonymous Git read access for all repositories {% data reusables.enterprise-accounts.access-enterprise %} -{% ifversion ghes or ghae %} +{% ifversion ghes %} {% data reusables.enterprise-accounts.policies-tab %} {% else %} {% data reusables.enterprise-accounts.settings-tab %} diff --git a/content/apps/creating-github-apps/about-creating-github-apps/migrating-oauth-apps-to-github-apps.md b/content/apps/creating-github-apps/about-creating-github-apps/migrating-oauth-apps-to-github-apps.md index d871ee4b57..1d4da54234 100644 --- a/content/apps/creating-github-apps/about-creating-github-apps/migrating-oauth-apps-to-github-apps.md +++ b/content/apps/creating-github-apps/about-creating-github-apps/migrating-oauth-apps-to-github-apps.md @@ -88,14 +88,14 @@ As the app owner, you should include calls to action to encourage your users to If you want your {% data variables.product.prodname_github_app %} to make API requests on behalf of itself or access organization or repository resources, the user must install your {% data variables.product.prodname_github_app %}. When a user installs a {% data variables.product.prodname_github_app %} on their account or organization, they choose which repositories the app can access, and they grant the app the organization and repository permissions that it requested. -To help your users install your {% data variables.product.prodname_github_app %}, you can add a link to your app's webpage that users can click to install the {% data variables.product.prodname_github_app %}. The format of the install URL is `{% data variables.product.oauth_host_code %}/{% ifversion ghes or ghae %}github-apps{% else %}apps{% endif %}/YOUR_APP_NAME/installations/new`. Replace `YOUR_APP_NAME` with the sluggified name of your {% data variables.product.prodname_github_app %}, which you can find in the "Public link" field on the settings page for your {% data variables.product.prodname_github_app %}. +To help your users install your {% data variables.product.prodname_github_app %}, you can add a link to your app's webpage that users can click to install the {% data variables.product.prodname_github_app %}. The format of the install URL is `{% data variables.product.oauth_host_code %}/{% ifversion ghes %}github-apps{% else %}apps{% endif %}/YOUR_APP_NAME/installations/new`. Replace `YOUR_APP_NAME` with the sluggified name of your {% data variables.product.prodname_github_app %}, which you can find in the "Public link" field on the settings page for your {% data variables.product.prodname_github_app %}. To pre-select any repositories your {% data variables.product.prodname_oauth_app %} had access to, you can append `/permissions` and query parameters to the install URL. This helps users grant your {% data variables.product.prodname_github_app %} access to repositories that your {% data variables.product.prodname_oauth_app %} already has access to. The query parameters are: - `suggested_target_id`: The ID of the user or organization that is installing your {% data variables.product.prodname_github_app %}. This parameter is required. - `repository_ids[]`: The repository IDs to select for the installation. If omitted, all repositories are selected. The maximum number of repositories that can be pre-selected is 100. To get a list of repositories that your {% data variables.product.prodname_oauth_app %} has access to, use the [List repositories for the authenticated user](/rest/repos#list-repositories-for-the-authenticated-user) and [List organization repositories](/rest/repos#list-organization-repositories) endpoints. -For example: `{% data variables.product.oauth_host_code %}/{% ifversion ghes or ghae %}github-apps{% else %}apps{% endif %}/YOUR_APP_NAME/installations/new/permissions?suggested_target_id=ID_OF_USER_OR_ORG&repository_ids[]=REPO_A_ID&repository_ids[]=REPO_B_ID`. +For example: `{% data variables.product.oauth_host_code %}/{% ifversion ghes %}github-apps{% else %}apps{% endif %}/YOUR_APP_NAME/installations/new/permissions?suggested_target_id=ID_OF_USER_OR_ORG&repository_ids[]=REPO_A_ID&repository_ids[]=REPO_B_ID`. For more information about installing {% data variables.product.prodname_github_apps %}, see {% ifversion ghec or fpt %}"[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-personal-account)," "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations),"{% endif %} "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-a-third-party)" and "[AUTOTITLE](/apps/using-github-apps/installing-your-own-github-app)." diff --git a/content/apps/creating-github-apps/writing-code-for-a-github-app/building-a-github-app-that-responds-to-webhook-events.md b/content/apps/creating-github-apps/writing-code-for-a-github-app/building-a-github-app-that-responds-to-webhook-events.md index 9c44fc4a49..370f4b8751 100644 --- a/content/apps/creating-github-apps/writing-code-for-a-github-app/building-a-github-app-that-responds-to-webhook-events.md +++ b/content/apps/creating-github-apps/writing-code-for-a-github-app/building-a-github-app-that-responds-to-webhook-events.md @@ -116,12 +116,12 @@ Make sure that you are on a secure machine before performing these steps since y 1. In your terminal, navigate to the directory where your clone is stored. 1. Create a file called `.env` at the top level of this directory. 1. Add `.env` to your `.gitignore` file. This will prevent you from accidentally committing your app's credentials. -1. Add the following contents to your `.env` file. {% ifversion ghes or ghae %}Replace `YOUR_HOSTNAME` with the name of {% data variables.location.product_location %}. You will update the other values in a later step.{% else %}You will update the values in a later step.{% endif %} +1. Add the following contents to your `.env` file. {% ifversion ghes %}Replace `YOUR_HOSTNAME` with the name of {% data variables.location.product_location %}. You will update the other values in a later step.{% else %}You will update the values in a later step.{% endif %} ```text copy APP_ID="YOUR_APP_ID" WEBHOOK_SECRET="YOUR_WEBHOOK_SECRET" - PRIVATE_KEY_PATH="YOUR_PRIVATE_KEY_PATH"{% ifversion ghes or ghae %} + PRIVATE_KEY_PATH="YOUR_PRIVATE_KEY_PATH"{% ifversion ghes %} ENTERPRISE_HOSTNAME="YOUR_HOSTNAME"{% endif %} ``` @@ -144,7 +144,7 @@ Add the following code to `app.js`. The code includes annotations that explain e // // You installed the `dotenv` and `octokit` modules earlier. The `@octokit/webhooks` is a dependency of the `octokit` module, so you don't need to install it separately. The `fs` and `http` dependencies are built-in Node.js modules. import dotenv from "dotenv"; -import {App{% ifversion ghes or ghae %}, Octokit{% endif %}} from "octokit"; +import {App{% ifversion ghes %}, Octokit{% endif %}} from "octokit"; import {createNodeMiddleware} from "@octokit/webhooks"; import fs from "fs"; import http from "http"; @@ -155,7 +155,7 @@ dotenv.config(); // This assigns the values of your environment variables to local variables. const appId = process.env.APP_ID; const webhookSecret = process.env.WEBHOOK_SECRET; -const privateKeyPath = process.env.PRIVATE_KEY_PATH;{% ifversion ghes or ghae %} +const privateKeyPath = process.env.PRIVATE_KEY_PATH;{% ifversion ghes %} const enterpriseHostname = process.env.ENTERPRISE_HOSTNAME;{% endif %} // This reads the contents of your private key file. @@ -167,7 +167,7 @@ const app = new App({ privateKey: privateKey, webhooks: { secret: webhookSecret - },{% ifversion ghes or ghae %} + },{% ifversion ghes %} Octokit: Octokit.defaults({ baseUrl: `https://${enterpriseHostname}/api/v3`, }),{% endif %} diff --git a/content/apps/creating-github-apps/writing-code-for-a-github-app/building-ci-checks-with-a-github-app.md b/content/apps/creating-github-apps/writing-code-for-a-github-app/building-ci-checks-with-a-github-app.md index d9921cf62f..cc6cab68de 100644 --- a/content/apps/creating-github-apps/writing-code-for-a-github-app/building-ci-checks-with-a-github-app.md +++ b/content/apps/creating-github-apps/writing-code-for-a-github-app/building-ci-checks-with-a-github-app.md @@ -166,7 +166,7 @@ Make sure that you are on a secure machine before performing these steps, since 1. In your terminal, navigate to the directory where your clone is stored. 1. Create a file called `.env` at the top level of this directory. 1. Add `.env` to your `.gitignore` file. This will prevent you from accidentally committing your app's credentials. -1. Add the following contents to your `.env` file. {% ifversion ghes or ghae %}Replace `YOUR_HOSTNAME` with the name of {% data variables.location.product_location %}. You will update the other values in a later step.{% else %}You will update the values in a later step.{% endif %} +1. Add the following contents to your `.env` file. {% ifversion ghes %}Replace `YOUR_HOSTNAME` with the name of {% data variables.location.product_location %}. You will update the other values in a later step.{% else %}You will update the values in a later step.{% endif %} ```shell copy GITHUB_APP_IDENTIFIER="YOUR_APP_ID" diff --git a/content/apps/creating-github-apps/writing-code-for-a-github-app/quickstart.md b/content/apps/creating-github-apps/writing-code-for-a-github-app/quickstart.md index 7e497466bd..12217d1382 100644 --- a/content/apps/creating-github-apps/writing-code-for-a-github-app/quickstart.md +++ b/content/apps/creating-github-apps/writing-code-for-a-github-app/quickstart.md @@ -73,12 +73,12 @@ Your cloned repository includes `.env` in the `.gitignore` file. This will preve 1. Navigate to the directory where your clone of [github/github-app-js-sample](https://github.com/github/github-app-js-sample) is stored. 1. Create a file called `.env` at the top level of this directory. -1. Add the following contents to your `.env` file. {% ifversion ghes or ghae %}Replace `YOUR_HOSTNAME` with the name of {% data variables.location.product_location %}. You will update the other values in a later step.{% else %}You will update the values in a later step.{% endif %} +1. Add the following contents to your `.env` file. {% ifversion ghes %}Replace `YOUR_HOSTNAME` with the name of {% data variables.location.product_location %}. You will update the other values in a later step.{% else %}You will update the values in a later step.{% endif %} ```text copy APP_ID="YOUR_APP_ID" WEBHOOK_SECRET="YOUR_WEBHOOK_SECRET" - PRIVATE_KEY_PATH="YOUR_PRIVATE_KEY_PATH"{% ifversion ghes or ghae %} + PRIVATE_KEY_PATH="YOUR_PRIVATE_KEY_PATH"{% ifversion ghes %} HOSTNAME="YOUR_HOSTNAME"{% endif %} ``` diff --git a/content/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps.md b/content/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps.md index eb2e1cbdeb..a1c5fb5009 100644 --- a/content/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps.md +++ b/content/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps.md @@ -48,7 +48,7 @@ X-Accepted-OAuth-Scopes: user Name | Description -----|-----------|{% ifversion not ghae %} -**`(no scope)`** | Grants read-only access to public information (including user profile info, repository info, and gists){% endif %}{% ifversion ghes or ghae %} +**`(no scope)`** | Grants read-only access to public information (including user profile info, repository info, and gists){% endif %}{% ifversion ghes %} **`site_admin`** | Grants site administrators access to [{% data variables.product.prodname_ghe_server %} Administration API endpoints](/rest/enterprise-admin).{% endif %} **`repo`** | Grants full access to public{% ifversion ghec or ghes or ghae %}, internal,{% endif %} and private repositories including read and write access to code, commit statuses, repository invitations, collaborators, deployment statuses, and repository webhooks. **Note**: In addition to repository related resources, the `repo` scope also grants access to manage organization-owned resources including projects, invitations, team memberships and webhooks. This scope also grants the ability to manage projects owned by users.  `repo:status`| Grants read/write access to commit statuses in {% ifversion fpt %}public and private{% elsif ghec or ghes %}public, private, and internal{% elsif ghae %}private and internal{% endif %} repositories. This scope is only necessary to grant other users or services access to private repository commit statuses _without_ granting access to the code. diff --git a/content/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps.md b/content/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps.md index 3d287e96ec..c5fd633fe0 100644 --- a/content/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps.md +++ b/content/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps.md @@ -15,7 +15,7 @@ topics: - Identity - Access management --- -When an {% data variables.product.prodname_oauth_app %} wants to identify you by your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}, you'll see a page with the app's developer contact information and a list of the specific data that's being requested. +When an {% data variables.product.prodname_oauth_app %} wants to identify you by your account on {% data variables.location.product_location %}, you'll see a page with the app's developer contact information and a list of the specific data that's being requested. {% ifversion fpt or ghec %} diff --git a/content/apps/sharing-github-apps/sharing-your-github-app.md b/content/apps/sharing-github-apps/sharing-your-github-app.md index 0ba90e8830..c8421ee14d 100644 --- a/content/apps/sharing-github-apps/sharing-your-github-app.md +++ b/content/apps/sharing-github-apps/sharing-your-github-app.md @@ -38,12 +38,12 @@ If your {% data variables.product.prodname_github_app %} is public, other users {% data reusables.user-settings.github_apps %} 1. Next to the {% data variables.product.prodname_github_app %} that you want to share, click **Edit**. 1. Click **Public page**. {% data variables.product.company_short %} will bring you to the public page for your {% data variables.product.prodname_github_app %}. -1. Click **Install**. {% data variables.product.company_short %} will bring you to the installation URL for your {% data variables.product.prodname_github_app %}. The URL will look something like `{% data variables.product.oauth_host_code %}/{% ifversion ghes or ghae %}github-apps{% else %}apps{% endif %}/APP-NAME/installations/new`, where `APP-NAME` is the name of the {% data variables.product.prodname_github_app %}. +1. Click **Install**. {% data variables.product.company_short %} will bring you to the installation URL for your {% data variables.product.prodname_github_app %}. The URL will look something like `{% data variables.product.oauth_host_code %}/{% ifversion ghes %}github-apps{% else %}apps{% endif %}/APP-NAME/installations/new`, where `APP-NAME` is the name of the {% data variables.product.prodname_github_app %}. 1. Share the installation URL with other users. For more information about how users can install your app from this URL, see "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-a-third-party)." When you share the URL, you can include a `state` query parameter in the installation URL to preserve the state of the application page and return people back to that state after they install, authenticate, or accept updates to your GitHub App. For example, you could use the `state` to correlate an installation to a user or account. - To preserve a state, add it to the installation URL: `{% data variables.product.oauth_host_code %}/{% ifversion ghes or ghae %}github-apps{% else %}apps{% endif %}//installations/new?state=AB12t` + To preserve a state, add it to the installation URL: `{% data variables.product.oauth_host_code %}/{% ifversion ghes %}github-apps{% else %}apps{% endif %}//installations/new?state=AB12t` ## Sharing your {% data variables.product.prodname_github_app %} with {% data variables.product.prodname_ghe_server %} instances diff --git a/content/apps/using-github-apps/installing-a-github-app-from-a-third-party.md b/content/apps/using-github-apps/installing-a-github-app-from-a-third-party.md index 179125a37b..7751a0f3f0 100644 --- a/content/apps/using-github-apps/installing-a-github-app-from-a-third-party.md +++ b/content/apps/using-github-apps/installing-a-github-app-from-a-third-party.md @@ -9,7 +9,7 @@ versions: shortTitle: Install from third party --- -{% ifversion ghes or ghae %} +{% ifversion ghes %} You cannot install third-party {% data variables.product.prodname_github_apps %} on organizations owned by your instance.{% ifversion ghes %} If you want to use the functionality of a third-party {% data variables.product.prodname_github_app %}, you can contact the app developer about making the {% data variables.product.prodname_github_app %} available for {% data variables.product.prodname_ghe_server %}. For more information, see "[AUTOTITLE](/apps/sharing-github-apps/making-your-github-app-available-for-github-enterprise-server)."{% endif %} @@ -45,7 +45,7 @@ The "app manager" role in an organization does not give a person the ability to ## Installing a {% data variables.product.prodname_github_app %} -During the installation process, the app owner will direct you to a {% data variables.product.company_short %} URL to install the {% data variables.product.prodname_github_app %}. The URL will look something like `{% data variables.product.oauth_host_code %}/{% ifversion ghes or ghae %}github-apps{% else %}apps{% endif %}/APP-NAME/installations/new`, where `APP-NAME` is the name of the {% data variables.product.prodname_github_app %}. +During the installation process, the app owner will direct you to a {% data variables.product.company_short %} URL to install the {% data variables.product.prodname_github_app %}. The URL will look something like `{% data variables.product.oauth_host_code %}/{% ifversion ghes %}github-apps{% else %}apps{% endif %}/APP-NAME/installations/new`, where `APP-NAME` is the name of the {% data variables.product.prodname_github_app %}. 1. Select the location where you want to install the {% data variables.product.prodname_github_app %}. You can select your personal account or an organization that you are a member of. diff --git a/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md b/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md index 7ce8f8a6f5..9fcf79c313 100644 --- a/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md +++ b/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md @@ -1,6 +1,6 @@ --- title: Adding a new SSH key to your GitHub account -intro: 'To configure your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} to use your new (or existing) SSH key, you''ll also need to add the key to your account.' +intro: 'To configure your account on {% data variables.location.product_location %} to use your new (or existing) SSH key, you''ll also need to add the key to your account.' redirect_from: - /articles/adding-a-new-ssh-key-to-your-github-account - /github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account @@ -25,7 +25,7 @@ After you generate an SSH key pair, you must add the public key to {% ifversion ## Prerequisites -Before adding a new SSH key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}, complete the following steps. +Before adding a new SSH key to your account on {% data variables.location.product_location %}, complete the following steps. 1. Check for existing SSH keys. For more information, see "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." 1. Generate a new SSH key and add it to your machine's SSH agent. For more information, see "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)." @@ -34,7 +34,7 @@ Before adding a new SSH key to your account on {% ifversion ghae %}{% data varia You can add an SSH key and use it for authentication, or commit signing, or both. If you want to use the same SSH key for both authentication and signing, you need to upload it twice. -After adding a new SSH authentication key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}, you can reconfigure any local repositories to use SSH. For more information, see "[AUTOTITLE](/get-started/getting-started-with-git/managing-remote-repositories#switching-remote-urls-from-https-to-ssh)." +After adding a new SSH authentication key to your account on {% data variables.location.product_location %}, you can reconfigure any local repositories to use SSH. For more information, see "[AUTOTITLE](/get-started/getting-started-with-git/managing-remote-repositories#switching-remote-urls-from-https-to-ssh)." {% data reusables.ssh.key-type-support %} diff --git a/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md b/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md index b9c3c9b1b5..33e9e75abd 100644 --- a/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md +++ b/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md @@ -10,7 +10,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - SSH @@ -29,7 +28,7 @@ If you want to use a hardware security key to authenticate to {% data variables. ## Generating a new SSH key -You can generate a new SSH key on your local machine. After you generate the key, you can add the public key to your account on {% ifversion fpt or ghec or ghes %}{% data variables.location.product_location %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %} to enable authentication for Git operations over SSH. +You can generate a new SSH key on your local machine. After you generate the key, you can add the public key to your account on {% data variables.location.product_location %} to enable authentication for Git operations over SSH. {% ifversion ghes %} @@ -41,13 +40,6 @@ If you are a site administrator for {% data variables.location.product_location {% data reusables.command_line.open_the_multi_os_terminal %} 1. Paste the text below, replacing the email used in the example with your {% data variables.product.product_name %} email address. - {%- ifversion ghae %} - - ```shell - ssh-keygen -t rsa -b 4096 -C "your_email@example.com" - ``` - - {%- else %} ```shell ssh-keygen -t ed25519 -C "your_email@example.com" @@ -62,7 +54,6 @@ If you are a site administrator for {% data variables.location.product_location ``` {% endnote %} - {%- endif %} This creates a new SSH key, using the provided email as a label. @@ -129,10 +120,10 @@ Before adding a new SSH key to the ssh-agent to manage your keys, you should hav - Open your `~/.ssh/config` file, then modify the file to contain the following lines. If your SSH key file has a different name or path than the example code, modify the filename or path to match your current setup. ```text - Host {% ifversion ghes or ghae %}HOSTNAME{% else %}github.com{% endif %} + Host {% ifversion ghes %}HOSTNAME{% else %}github.com{% endif %} AddKeysToAgent yes UseKeychain yes - IdentityFile ~/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %} + IdentityFile ~/.ssh/id_ed25519 ``` {% note %} @@ -141,10 +132,10 @@ Before adding a new SSH key to the ssh-agent to manage your keys, you should hav - If you chose not to add a passphrase to your key, you should omit the `UseKeychain` line. - - If you see a `Bad configuration option: usekeychain` error, add an additional line to the configuration's' `Host *.{% ifversion ghes or ghae %}HOSTNAME{% else %}github.com{% endif %}` section. + - If you see a `Bad configuration option: usekeychain` error, add an additional line to the configuration's' `Host *.{% ifversion ghes %}HOSTNAME{% else %}github.com{% endif %}` section. ```text - Host {% ifversion ghes or ghae %}HOSTNAME{% else %}github.com{% endif %} + Host {% ifversion ghes %}HOSTNAME{% else %}github.com{% endif %} IgnoreUnknown UseKeychain ``` @@ -153,7 +144,7 @@ Before adding a new SSH key to the ssh-agent to manage your keys, you should hav 1. Add your SSH private key to the ssh-agent and store your passphrase in the keychain. {% data reusables.ssh.add-ssh-key-to-ssh-agent %} ```shell - ssh-add --apple-use-keychain ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %} + ssh-add --apple-use-keychain ~/.ssh/id_ed25519 ``` {% data reusables.ssh.apple-use-keychain %} @@ -211,7 +202,7 @@ If you are using macOS or Linux, you may need to update your SSH client or insta {% mac %} ```shell - ssh-keygen -t {% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}-sk -C "your_email@example.com" + ssh-keygen -t ed25519-sk -C "your_email@example.com" ``` {% endmac %} @@ -219,7 +210,7 @@ If you are using macOS or Linux, you may need to update your SSH client or insta {% windows %} ```powershell - ssh-keygen -t {% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}-sk -C "your_email@example.com" + ssh-keygen -t ed25519-sk -C "your_email@example.com" ``` {% endwindows %} @@ -227,12 +218,11 @@ If you are using macOS or Linux, you may need to update your SSH client or insta {% linux %} ```shell - ssh-keygen -t {% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}-sk -C "your_email@example.com" + ssh-keygen -t ed25519-sk -C "your_email@example.com" ``` {% endlinux %} - {%- ifversion not ghae %} {% note %} **Note:** If the command fails and you receive the error `invalid format` or `feature not supported,` you may be using a hardware security key that does not support the Ed25519 algorithm. Enter the following command instead. @@ -242,7 +232,6 @@ If you are using macOS or Linux, you may need to update your SSH client or insta ``` {% endnote %} - {%- endif %} 1. When you are prompted, touch the button on your hardware security key. 1. When you are prompted to "Enter a file in which to save the key," press Enter to accept the default file location. @@ -250,7 +239,7 @@ If you are using macOS or Linux, you may need to update your SSH client or insta {% mac %} ```shell - > Enter a file in which to save the key (/Users/YOU/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk): [Press enter] + > Enter a file in which to save the key (/Users/YOU/.ssh/id_ed25519_sk): [Press enter] ``` {% endmac %} @@ -258,7 +247,7 @@ If you are using macOS or Linux, you may need to update your SSH client or insta {% windows %} ```shell - > Enter a file in which to save the key (c:\Users\YOU\.ssh\id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk):[Press enter] + > Enter a file in which to save the key (c:\Users\YOU\.ssh\id_ed25519_sk):[Press enter] ``` {% endwindows %} @@ -266,7 +255,7 @@ If you are using macOS or Linux, you may need to update your SSH client or insta {% linux %} ```shell - > Enter a file in which to save the key (/home/YOU/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk):[Press enter] + > Enter a file in which to save the key (/home/YOU/.ssh/id_ed25519_sk):[Press enter] ``` {% endlinux %} diff --git a/content/authentication/connecting-to-github-with-ssh/managing-deploy-keys.md b/content/authentication/connecting-to-github-with-ssh/managing-deploy-keys.md index 621c5e7356..c5a43ecd07 100644 --- a/content/authentication/connecting-to-github-with-ssh/managing-deploy-keys.md +++ b/content/authentication/connecting-to-github-with-ssh/managing-deploy-keys.md @@ -156,7 +156,7 @@ For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating ## Machine users -If your server needs to access multiple repositories, you can create a new account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} and attach an SSH key that will be used exclusively for automation. Since this account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} won't be used by a human, it's called a _machine user_. You can add the machine user as a [collaborator][collaborator] on a personal repository (granting read and write access), as an [outside collaborator][outside-collaborator] on an organization repository (granting read, write, or admin access), or to a [team][team] with access to the repositories it needs to automate (granting the permissions of the team). +If your server needs to access multiple repositories, you can create a new account on {% data variables.location.product_location %} and attach an SSH key that will be used exclusively for automation. Since this account on {% data variables.location.product_location %} won't be used by a human, it's called a _machine user_. You can add the machine user as a [collaborator][collaborator] on a personal repository (granting read and write access), as an [outside collaborator][outside-collaborator] on an organization repository (granting read, write, or admin access), or to a [team][team] with access to the repositories it needs to automate (granting the permissions of the team). {% ifversion fpt or ghec %} diff --git a/content/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection.md b/content/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection.md index e8ab59b31f..da4ed75e42 100644 --- a/content/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection.md +++ b/content/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection.md @@ -1,6 +1,6 @@ --- title: Testing your SSH connection -intro: 'After you''ve set up your SSH key and added it to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}, you can test your connection.' +intro: 'After you''ve set up your SSH key and added it to your account on {% data variables.location.product_location %}, you can test your connection.' redirect_from: - /articles/testing-your-ssh-connection - /github/authenticating-to-github/testing-your-ssh-connection diff --git a/content/authentication/connecting-to-github-with-ssh/using-ssh-agent-forwarding.md b/content/authentication/connecting-to-github-with-ssh/using-ssh-agent-forwarding.md index 4a2bf492e5..607ca9cd39 100644 --- a/content/authentication/connecting-to-github-with-ssh/using-ssh-agent-forwarding.md +++ b/content/authentication/connecting-to-github-with-ssh/using-ssh-agent-forwarding.md @@ -28,10 +28,10 @@ Check out [Steve Friedl's Tech Tips guide][tech-tips] for a more detailed explan Ensure that your own SSH key is set up and working. You can use [our guide on generating SSH keys][generating-keys] if you've not done this yet. -You can test that your local key works by entering `ssh -T git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %}` in the terminal: +You can test that your local key works by entering `ssh -T git@{% ifversion ghes %}hostname{% else %}github.com{% endif %}` in the terminal: ```shell -$ ssh -T git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %} +$ ssh -T git@{% ifversion ghes %}hostname{% else %}github.com{% endif %} # Attempt to SSH in to github > Hi USERNAME! You've successfully authenticated, but GitHub does not provide > shell access. @@ -54,7 +54,7 @@ We're off to a great start. Let's set up SSH to allow agent forwarding to your s ## Testing SSH agent forwarding -To test that agent forwarding is working with your server, you can SSH into your server and run `ssh -T git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %}` once more. If all is well, you'll get back the same prompt as you did locally. +To test that agent forwarding is working with your server, you can SSH into your server and run `ssh -T git@{% ifversion ghes %}hostname{% else %}github.com{% endif %}` once more. If all is well, you'll get back the same prompt as you did locally. If you're unsure if your local key is being used, you can also inspect the `SSH_AUTH_SOCK` variable on your server: @@ -70,7 +70,7 @@ If the variable is not set, it means that agent forwarding is not working: $ echo "$SSH_AUTH_SOCK" # Print out the SSH_AUTH_SOCK variable > [No output] -$ ssh -T git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %} +$ ssh -T git@{% ifversion ghes %}hostname{% else %}github.com{% endif %} # Try to SSH to github > Permission denied (publickey). ``` @@ -85,7 +85,7 @@ SSH forwarding only works with SSH URLs, not HTTP(s) URLs. Check the `.git/confi ```shell [remote "origin"] - url = git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %}:YOUR_ACCOUNT/YOUR_PROJECT.git + url = git@{% ifversion ghes %}hostname{% else %}github.com{% endif %}:YOUR_ACCOUNT/YOUR_PROJECT.git fetch = +refs/heads/*:refs/remotes/origin/* ``` diff --git a/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md b/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md index 4603fca8cd..947bc473e4 100644 --- a/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md +++ b/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md @@ -134,9 +134,9 @@ If you authenticate without {% data variables.product.prodname_cli %}, you must You can work with all repositories on {% data variables.product.product_name %} over SSH, although firewalls and proxies might refuse to allow SSH connections. -If you authenticate with {% data variables.product.prodname_cli %}, the CLI will find SSH public keys on your machine and will prompt you to select one for upload. If {% data variables.product.prodname_cli %} does not find a SSH public key for upload, it can generate a new SSH public/private keypair and upload the public key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}. Then, you can either authenticate with a {% data variables.product.pat_generic %} or via the web browser. For more information about authenticating with {% data variables.product.prodname_cli %}, see [`gh auth login`](https://cli.github.com/manual/gh_auth_login). +If you authenticate with {% data variables.product.prodname_cli %}, the CLI will find SSH public keys on your machine and will prompt you to select one for upload. If {% data variables.product.prodname_cli %} does not find a SSH public key for upload, it can generate a new SSH public/private keypair and upload the public key to your account on {% data variables.location.product_location %}. Then, you can either authenticate with a {% data variables.product.pat_generic %} or via the web browser. For more information about authenticating with {% data variables.product.prodname_cli %}, see [`gh auth login`](https://cli.github.com/manual/gh_auth_login). -If you authenticate without {% data variables.product.prodname_cli %}, you will need to generate an SSH public/private keypair on your local machine and add the public key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}. For more information, see "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)." Every time you use Git to authenticate with {% data variables.product.product_name %}, you'll be prompted to enter your SSH key passphrase, unless you've [stored the key](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#adding-your-ssh-key-to-the-ssh-agent). +If you authenticate without {% data variables.product.prodname_cli %}, you will need to generate an SSH public/private keypair on your local machine and add the public key to your account on {% data variables.location.product_location %}. For more information, see "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)." Every time you use Git to authenticate with {% data variables.product.product_name %}, you'll be prompted to enter your SSH key passphrase, unless you've [stored the key](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#adding-your-ssh-key-to-the-ssh-agent). {% ifversion fpt or ghec %} diff --git a/content/authentication/keeping-your-account-and-data-secure/creating-a-strong-password.md b/content/authentication/keeping-your-account-and-data-secure/creating-a-strong-password.md index c0f7e28cc3..e9181892a3 100644 --- a/content/authentication/keeping-your-account-and-data-secure/creating-a-strong-password.md +++ b/content/authentication/keeping-your-account-and-data-secure/creating-a-strong-password.md @@ -1,6 +1,6 @@ --- title: Creating a strong password -intro: 'Secure your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} with a strong and unique password using a password manager.' +intro: 'Secure your account on {% data variables.location.product_location %} with a strong and unique password using a password manager.' redirect_from: - /articles/what-is-a-strong-password - /articles/creating-a-strong-password @@ -15,13 +15,13 @@ topics: - Access management shortTitle: Create a strong password --- -You must choose or generate a password for your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} that is at least: +You must choose or generate a password for your account on {% data variables.location.product_location %} that is at least: - {% ifversion ghes %}Seven{% else %}Eight{% endif %} characters long, if it includes a number and a lowercase letter, or - 15 characters long with any combination of characters To keep your account secure, we recommend you follow these best practices: - Use a password manager to generate a password of at least 15 characters. -- Generate a unique password for {% data variables.product.product_name %}. If you use your {% data variables.product.product_name %} password elsewhere and that service is compromised, then attackers or other malicious actors could use that information to access your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}. +- Generate a unique password for {% data variables.product.product_name %}. If you use your {% data variables.product.product_name %} password elsewhere and that service is compromised, then attackers or other malicious actors could use that information to access your account on {% data variables.location.product_location %}. - Configure two-factor authentication for your personal account. For more information, see "[AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication)."{% ifversion passkeys %} - {% data reusables.passkeys.add-passkey-option %}{% endif %} - Never share your password, even with a potential collaborator. Each person should use their own personal account on {% data variables.product.product_name %}. For more information on ways to collaborate, see: "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository)," "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models)," or "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations)." diff --git a/content/authentication/keeping-your-account-and-data-secure/index.md b/content/authentication/keeping-your-account-and-data-secure/index.md index f819cadc8a..1df0d41250 100644 --- a/content/authentication/keeping-your-account-and-data-secure/index.md +++ b/content/authentication/keeping-your-account-and-data-secure/index.md @@ -1,6 +1,6 @@ --- title: Keeping your account and data secure -intro: 'To protect your personal information, you should keep both your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} and any associated data secure.' +intro: 'To protect your personal information, you should keep both your account on {% data variables.location.product_location %} and any associated data secure.' redirect_from: - /articles/keeping-your-account-and-data-secure - /github/authenticating-to-github/keeping-your-account-and-data-secure diff --git a/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md b/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md index 0c2c9f06bc..313efea197 100644 --- a/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md +++ b/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md @@ -24,7 +24,7 @@ You can remove the file from the latest commit with `git rm`. For information on {% warning %} -**Warning**: This article tells you how to make commits with sensitive data unreachable from any branches or tags in your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}. However, those commits may still be accessible in any clones or forks of your repository, directly via their SHA-1 hashes in cached views on {% data variables.product.product_name %}, and through any pull requests that reference them. You cannot remove sensitive data from other users' clones of your repository, but you can permanently remove cached views and references to the sensitive data in pull requests on {% data variables.product.product_name %} by contacting {% data variables.contact.contact_support %}. {% ifversion fpt or ghec %}{% data variables.contact.github_support %} only assists in the removal of sensitive data in cases where we determine that the risk can't be mitigated by rotating affected credentials.{% endif %} +**Warning**: This article tells you how to make commits with sensitive data unreachable from any branches or tags in your repository on {% data variables.location.product_location %}. However, those commits may still be accessible in any clones or forks of your repository, directly via their SHA-1 hashes in cached views on {% data variables.product.product_name %}, and through any pull requests that reference them. You cannot remove sensitive data from other users' clones of your repository, but you can permanently remove cached views and references to the sensitive data in pull requests on {% data variables.product.product_name %} by contacting {% data variables.contact.contact_support %}. {% ifversion fpt or ghec %}{% data variables.contact.github_support %} only assists in the removal of sensitive data in cases where we determine that the risk can't be mitigated by rotating affected credentials.{% endif %} Once you have pushed a commit to {% data variables.product.product_name %}, you should consider any sensitive data in the commit compromised. If you have committed a password, you should change it. If you have committed a key, generate a new one. Removing the compromised data doesn't resolve its initial exposure, especially in existing clones or forks of your repository. @@ -148,7 +148,7 @@ To illustrate how `git filter-repo` works, we'll show you how to remove your fil git remote add origin https://github.com/OWNER/REPOSITORY.git ``` -1. Once you're happy with the state of your repository, and you have set the appropriate remote, force-push your local changes to overwrite your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}, as well as all the branches you've pushed up. A force push is required to remove sensitive data from your commit history. +1. Once you're happy with the state of your repository, and you have set the appropriate remote, force-push your local changes to overwrite your repository on {% data variables.location.product_location %}, as well as all the branches you've pushed up. A force push is required to remove sensitive data from your commit history. ```shell $ git push origin --force --all diff --git a/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md b/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md index bc1257ebae..80dfe0aacf 100644 --- a/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md +++ b/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md @@ -44,10 +44,10 @@ The events listed in your security log are triggered by your actions. Actions ar | `payment_method` | Contains all activities related to paying for your {% data variables.product.prodname_dotcom %} subscription.{% endif %}{% ifversion pat-v2%} | `personal_access_token` | Contains activities related to {% data variables.product.pat_v2 %}s. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)."{% endif %} | `profile_picture`| Contains all activities related to your profile picture. -| `project` | Contains all activities related to project boards. +| `project` | Contains all activities related to {% data variables.projects.projects_v1_boards %}. | `public_key` | Contains all activities related to [your public SSH keys](/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account). | `repo`| Contains all activities related to the repositories you own.{% ifversion fpt or ghec %} -| `sponsors` | Contains all events related to {% data variables.product.prodname_sponsors %} and sponsor buttons (see "[AUTOTITLE](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)" and "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% ifversion ghes or ghae %} +| `sponsors` | Contains all events related to {% data variables.product.prodname_sponsors %} and sponsor buttons (see "[AUTOTITLE](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)" and "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% ifversion ghes %} | `team` | Contains all activities related to teams you are a part of.{% endif %}{% ifversion not ghae %} | `two_factor_authentication` | Contains all activities related to [two-factor authentication](/authentication/securing-your-account-with-two-factor-authentication-2fa).{% endif %} | `user` | Contains all activities related to your account. diff --git a/content/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys.md b/content/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys.md index de62738a08..8df0d611be 100644 --- a/content/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys.md +++ b/content/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys.md @@ -1,6 +1,6 @@ --- title: Reviewing your SSH keys -intro: 'To keep your credentials secure, you should regularly audit your SSH keys, deploy keys, and review authorized applications that access your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}.' +intro: 'To keep your credentials secure, you should regularly audit your SSH keys, deploy keys, and review authorized applications that access your account on {% data variables.location.product_location %}.' redirect_from: - /articles/keeping-your-application-access-tokens-safe - /articles/keeping-your-ssh-keys-and-application-access-tokens-safe diff --git a/content/authentication/keeping-your-account-and-data-secure/security-log-events.md b/content/authentication/keeping-your-account-and-data-secure/security-log-events.md index dc6bfdccad..d69cd6623d 100644 --- a/content/authentication/keeping-your-account-and-data-secure/security-log-events.md +++ b/content/authentication/keeping-your-account-and-data-secure/security-log-events.md @@ -4,7 +4,6 @@ intro: Learn about security log events recorded for your personal account. versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Identity @@ -16,7 +15,7 @@ autogenerated: audit-logs {% ifversion ghes %}**Notes**: - This article contains the events available in the latest version of {% data variables.product.prodname_ghe_server %}. Some of the events may not be available in previous versions. --{% else %}**Note:**{% endif %} This article contains the events that may appear in your user account's security log. For the events that can appear in an organization's audit log{% ifversion ghec or ghes or ghae %} or the audit log for an enterprise{% endif %}, see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization){% ifversion ghec or ghes or ghae %}" and "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise)."{% else %}."{% endif %} +-{% else %}**Note:**{% endif %} This article contains the events that may appear in your user account's security log. For the events that can appear in an organization's audit log{% ifversion ghec or ghes %} or the audit log for an enterprise{% endif %}, see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization){% ifversion ghec or ghes %}" and "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise)."{% else %}."{% endif %} {% endnote %} diff --git a/content/authentication/keeping-your-account-and-data-secure/token-expiration-and-revocation.md b/content/authentication/keeping-your-account-and-data-secure/token-expiration-and-revocation.md index 7cff35cc95..5e8b7efdb3 100644 --- a/content/authentication/keeping-your-account-and-data-secure/token-expiration-and-revocation.md +++ b/content/authentication/keeping-your-account-and-data-secure/token-expiration-and-revocation.md @@ -47,7 +47,7 @@ If a valid OAuth token, {% data variables.product.prodname_github_app %} token, You can revoke your authorization of a {% data variables.product.prodname_github_app %} or {% data variables.product.prodname_oauth_app %} from your account settings which will revoke any tokens associated with the app. For more information, see "[AUTOTITLE](/apps/using-github-apps/reviewing-your-authorized-integrations)" and "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/reviewing-your-authorized-applications-oauth)." -Once an authorization is revoked, any tokens associated with the authorization will be revoked as well. To reauthorize an application, follow the instructions from the third-party application or website to connect your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} again. +Once an authorization is revoked, any tokens associated with the authorization will be revoked as well. To reauthorize an application, follow the instructions from the third-party application or website to connect your account on {% data variables.location.product_location %} again. ## Token revoked by the {% data variables.product.prodname_oauth_app %} @@ -59,6 +59,6 @@ The owner of an {% data variables.product.prodname_oauth_app %} can revoke an ac {% data reusables.apps.oauth-token-limit %} -## User token revoked due to {% data variables.product.prodname_github_app %} configuration +## User token expired due to {% data variables.product.prodname_github_app %} configuration -User access tokens created by a {% data variables.product.prodname_github_app %} will expire after eight hours by default. Owners of {% data variables.product.prodname_github_apps %} can optionally change the default expiration period for their user access tokens, or configure the tokens to never expire. For more information about configuring your {% data variables.product.prodname_dotcom %} App's user access tokens, see "[AUTOTITLE](/apps/maintaining-github-apps/activating-optional-features-for-github-apps)." +User access tokens created by a {% data variables.product.prodname_github_app %} will expire after eight hours by default, and then must be regenerated using the included refresh token. Owners of {% data variables.product.prodname_github_apps %} can optionally configure these tokens to never expire instead, but this is not recommended due to the security implications. For more information about configuring your {% data variables.product.prodname_github_app %}'s user access tokens, see "[AUTOTITLE](/apps/maintaining-github-apps/activating-optional-features-for-github-apps)." diff --git a/content/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md b/content/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md index 78c070abc2..c814424cb0 100644 --- a/content/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md +++ b/content/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md @@ -22,7 +22,7 @@ shortTitle: Update access credentials ## Requesting a new password 1. To request a new password, visit {% ifversion fpt or ghec %}https://{% data variables.product.product_url %}/password_reset{% else %}`https://{% data variables.product.product_url %}/password_reset`{% endif %}. -1. Enter the email address associated with your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}, then click **Send password reset email.** The email will be sent to the backup email address if you have one configured. +1. Enter the email address associated with your account on {% data variables.location.product_location %}, then click **Send password reset email.** The email will be sent to the backup email address if you have one configured. 1. We'll email you a link that will allow you to reset your password. You must click on this link within 3 hours of receiving the email. If you didn't receive an email from us, make sure to check your spam folder. 1. If you have enabled two-factor authentication, you will be prompted for your 2FA credentials: {% ifversion fpt or ghec %} diff --git a/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md b/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md index c7b105026d..93f3d617a5 100644 --- a/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md +++ b/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md @@ -23,7 +23,7 @@ You can sign commits and tags locally, to give other people confidence about the ![Screenshot of a commit in the commit list for a repository. "Verified" is highlighted with an orange outline.](/assets/images/help/commits/verified-commit.png) -{% ifversion ghes or ghae %} +{% ifversion ghes %} If a commit or tag has a signature that can't be verified, {% data variables.product.product_name %} marks the commit or tag "Unverified." {% endif %} @@ -77,7 +77,7 @@ You can optionally choose to have {% data variables.product.prodname_dotcom %} G You can use GPG to sign commits with a GPG key that you generate yourself. -{% data variables.product.product_name %} uses OpenPGP libraries to confirm that your locally signed commits and tags are cryptographically verifiable against a public key you have added to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}. +{% data variables.product.product_name %} uses OpenPGP libraries to confirm that your locally signed commits and tags are cryptographically verifiable against a public key you have added to your account on {% data variables.location.product_location %}. To sign commits using GPG and have those commits verified on {% data variables.product.product_name %}, follow these steps: @@ -95,7 +95,7 @@ To sign commits using GPG and have those commits verified on {% data variables.p You can use SSH to sign commits with an SSH key that you generate yourself. For more information, see the [Git reference documentation](https://git-scm.com/docs/git-config#Documentation/git-config.txt-usersigningKey) for `user.Signingkey`. If you already use an SSH key to authenticate with {% data variables.product.product_name %}, you can also upload that same key again for use as a signing key. There's no limit on the number of signing keys you can add to your account. -{% data variables.product.product_name %} uses [ssh_data](https://github.com/github/ssh_data), an open source Ruby library, to confirm that your locally signed commits and tags are cryptographically verifiable against a public key you have added to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}. +{% data variables.product.product_name %} uses [ssh_data](https://github.com/github/ssh_data), an open source Ruby library, to confirm that your locally signed commits and tags are cryptographically verifiable against a public key you have added to your account on {% data variables.location.product_location %}. {% data reusables.gpg.ssh-git-version %} diff --git a/content/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account.md b/content/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account.md index 778c34739c..d64ce5c472 100644 --- a/content/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account.md +++ b/content/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account.md @@ -1,6 +1,6 @@ --- title: Adding a GPG key to your GitHub account -intro: 'To configure your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} to use your new (or existing) GPG key, you''ll also need to add the key to your account.' +intro: 'To configure your account on {% data variables.location.product_location %} to use your new (or existing) GPG key, you''ll also need to add the key to your account.' redirect_from: - /articles/adding-a-gpg-key-to-your-github-account - /github/authenticating-to-github/adding-a-new-gpg-key-to-your-github-account diff --git a/content/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key.md b/content/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key.md index e16db51f31..05a3abb4e0 100644 --- a/content/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key.md +++ b/content/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key.md @@ -17,7 +17,7 @@ shortTitle: Associate email with GPG key --- {% note %} -If you're using a GPG key that matches your committer identity and your verified email address associated with your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}, then you can begin signing commits and signing tags. +If you're using a GPG key that matches your committer identity and your verified email address associated with your account on {% data variables.location.product_location %}, then you can begin signing commits and signing tags. {% endnote %} diff --git a/content/authentication/managing-commit-signature-verification/signing-commits.md b/content/authentication/managing-commit-signature-verification/signing-commits.md index aba9600c5f..7755190bd4 100644 --- a/content/authentication/managing-commit-signature-verification/signing-commits.md +++ b/content/authentication/managing-commit-signature-verification/signing-commits.md @@ -25,10 +25,10 @@ topics: To configure your Git client to sign commits by default for a local repository, in Git versions 2.0.0 and above, run `git config commit.gpgsign true`. To sign all commits by default in any local repository on your computer, run `git config --global commit.gpgsign true`. To store your GPG key passphrase so you don't have to enter it every time you sign a commit, we recommend using the following tools: -- For Mac users, the [GPG Suite](https://gpgtools.org/) allows you to store your GPG key passphrase in the Mac OS Keychain. +- For Mac users, the [GPG Suite](https://gpgtools.org/) allows you to store your GPG key passphrase in the macOS Keychain. - For Windows users, the [Gpg4win](https://www.gpg4win.org/) integrates with other Windows tools. -You can also manually configure [gpg-agent](http://linux.die.net/man/1/gpg-agent) to save your GPG key passphrase, but this doesn't integrate with Mac OS Keychain like ssh-agent and requires more setup. +You can also manually configure [gpg-agent](http://linux.die.net/man/1/gpg-agent) to save your GPG key passphrase, but this doesn't integrate with macOS Keychain like ssh-agent and requires more setup. {% endtip %} diff --git a/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md b/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md index a026b9a38f..1ad77be162 100644 --- a/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md +++ b/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md @@ -21,7 +21,7 @@ shortTitle: Tell Git about your signing key {% mac %} -If you're using a GPG key that matches your committer identity and your verified email address associated with your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}, then you can begin signing commits and signing tags. +If you're using a GPG key that matches your committer identity and your verified email address associated with your account on {% data variables.location.product_location %}, then you can begin signing commits and signing tags. {% note %} @@ -63,7 +63,7 @@ If you have multiple GPG keys, you need to tell Git which one to use. {% windows %} -If you're using a GPG key that matches your committer identity and your verified email address associated with your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}, then you can begin signing commits and signing tags. +If you're using a GPG key that matches your committer identity and your verified email address associated with your account on {% data variables.location.product_location %}, then you can begin signing commits and signing tags. {% note %} @@ -84,7 +84,7 @@ If you have multiple GPG keys, you need to tell Git which one to use. {% linux %} -If you're using a GPG key that matches your committer identity and your verified email address associated with your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}, then you can begin signing commits and signing tags. +If you're using a GPG key that matches your committer identity and your verified email address associated with your account on {% data variables.location.product_location %}, then you can begin signing commits and signing tags. {% note %} diff --git a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/countries-where-sms-authentication-is-supported.md b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/countries-where-sms-authentication-is-supported.md index bd34219faa..8bc02d107e 100644 --- a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/countries-where-sms-authentication-is-supported.md +++ b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/countries-where-sms-authentication-is-supported.md @@ -124,7 +124,6 @@ If your country is not on this list, then we aren't currently able to reliably d
  • Trinidad and Tobago
  • Turks and Caicos Islands
  • Uganda
    • -
  • United Arab Emirates
  • United Kingdom
  • United States
  • Uzbekistan
    • diff --git a/content/authentication/troubleshooting-ssh/error-key-already-in-use.md b/content/authentication/troubleshooting-ssh/error-key-already-in-use.md index ae32ca4be7..fd8d787f42 100644 --- a/content/authentication/troubleshooting-ssh/error-key-already-in-use.md +++ b/content/authentication/troubleshooting-ssh/error-key-already-in-use.md @@ -24,7 +24,7 @@ $ ssh -T -ai ~/.ssh/id_rsa git@{% data variables.command_line.codeblock %} > provide shell access. ``` -The _username_ in the response is the account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} that the key is currently attached to. If the response looks something like "username/repo", the key has been attached to a repository as a [_deploy key_](/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys). +The _username_ in the response is the account on {% data variables.location.product_location %} that the key is currently attached to. If the response looks something like "username/repo", the key has been attached to a repository as a [_deploy key_](/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys). To force SSH to use only the key provided on the command line, use `-o` to add the `IdentitiesOnly=yes` option: diff --git a/content/billing/managing-billing-for-github-advanced-security/setting-up-a-trial-of-github-advanced-security.md b/content/billing/managing-billing-for-github-advanced-security/setting-up-a-trial-of-github-advanced-security.md index b10d5ff310..7a552b76c0 100644 --- a/content/billing/managing-billing-for-github-advanced-security/setting-up-a-trial-of-github-advanced-security.md +++ b/content/billing/managing-billing-for-github-advanced-security/setting-up-a-trial-of-github-advanced-security.md @@ -13,18 +13,16 @@ shortTitle: Set up an Advanced Security trial ## About trials of {% data variables.product.prodname_GH_advanced_security %} -{% data variables.product.prodname_GH_advanced_security %} provides features that help you improve and maintain the security and quality of code. For more information, see "[AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security)." - -{% note %} - -**Note:** You need an enterprise account to set up a trial to evaluate the features that come with {% data variables.product.prodname_GH_advanced_security %}, such as {% data variables.product.prodname_code_scanning %}, {% data variables.product.prodname_secret_scanning %}, and dependency review. For more information about enterprise accounts, see "[AUTOTITLE](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts)." - -{% endnote %} +{% data variables.product.prodname_GH_advanced_security %} provides features that help you improve and maintain the security and quality of code, such as {% data variables.product.prodname_code_scanning %}, {% data variables.product.prodname_secret_scanning %}, and dependency review. For more information, see "[AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security)." During a trial, you can add any number of committers and enable {% data variables.product.prodname_GH_advanced_security %} for any number of organizations. You can set up a trial if you pay for {% data variables.product.prodname_ghe_cloud %} by credit card or PayPal, or if you are already taking part in a free trial of {% data variables.product.prodname_ghe_cloud %}. The standard length of the trial is 30 days. If you're taking part in a free trial of {% data variables.product.prodname_ghe_cloud %}, the trial of {% data variables.product.prodname_GH_advanced_security %} will last for the time you have remaining on your trial of {% data variables.product.prodname_ghe_cloud %}. +## Prerequisites + +To set up a trial of {% data variables.product.prodname_GH_advanced_security %}, you must be an owner of an enterprise account. For more information, see "[AUTOTITLE](/admin/overview/about-enterprise-accounts)" and "[AUTOTITLE](/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owners)." + ## Setting up your trial of {% data variables.product.prodname_GH_advanced_security %} {% data reusables.enterprise-accounts.access-enterprise %} diff --git a/content/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-personal-account.md b/content/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-personal-account.md index 24d2f16094..04f4800c03 100644 --- a/content/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-personal-account.md +++ b/content/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-personal-account.md @@ -21,8 +21,6 @@ If you have access to {% data variables.product.prodname_copilot %} through a {% {% data reusables.billing.billing-info %} -{% data reusables.copilot.dotcom-settings %} - ## Setting up a {% data variables.product.prodname_copilot %} trial or subscription for your personal account Before you can start using {% data variables.product.prodname_copilot_for_individuals %}, you will need to set up a free trial or subscription. diff --git a/content/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql.md b/content/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql.md index e04618bc1d..3dbc5661a1 100644 --- a/content/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql.md +++ b/content/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql.md @@ -42,7 +42,7 @@ There are two main ways to use {% data variables.product.prodname_codeql %} anal - Run the {% data variables.product.prodname_codeql_cli %} directly in an external CI system and upload the results to {% data variables.product.prodname_dotcom %}. For more information, see "[AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/using-code-scanning-with-your-existing-ci-system)." -{% ifversion ghes or ghae %} +{% ifversion ghes %} {% note %} On {% data variables.product.product_name %} {% ifversion ghes %}{{ allVersions[currentVersion].currentRelease }},{% endif %} the {% data variables.product.prodname_codeql %} action uses {% data variables.product.prodname_codeql_cli %} version {% data variables.product.codeql_cli_ghes_recommended_version %} by default. We recommend that you use the same version of the {% data variables.product.prodname_codeql_cli %} if you run analysis in an external CI system. diff --git a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-results-to-github.md b/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-results-to-github.md index 8b7e41fe5e..70a2a7aed7 100644 --- a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-results-to-github.md +++ b/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-results-to-github.md @@ -47,14 +47,14 @@ When you have decided on the most secure and reliable method for your configurat | codeql github upload-results \ --repository= \ --ref= --commit= \ - --sarif= {% ifversion ghes or ghae %}--github-url= \ + --sarif= {% ifversion ghes %}--github-url= \ {% endif %}--github-auth-stdin # {% data variables.product.prodname_github_app %} or {% data variables.product.pat_generic %} available in GITHUB_TOKEN codeql github upload-results \ --repository= \ --ref= --commit= \ - --sarif= {% ifversion ghes or ghae %}--github-url= \ + --sarif= {% ifversion ghes %}--github-url= \ {% endif %} ``` @@ -63,7 +63,7 @@ codeql github upload-results \ | --repository | {% octicon "check" aria-label="Required" %} | Specify the _OWNER/NAME_ of the repository to upload data to. The owner must be an organization within an enterprise that has a license for {% data variables.product.prodname_GH_advanced_security %} and {% data variables.product.prodname_GH_advanced_security %} must be enabled for the repository{% ifversion fpt or ghec %}, unless the repository is public{% endif %}. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)." | --ref | {% octicon "check" aria-label="Required" %} | Specify the name of the `ref` you checked out and analyzed so that the results can be matched to the correct code. For a branch use: `refs/heads/BRANCH-NAME`, for the head commit of a pull request use `refs/pull/NUMBER/head`, or for the {% data variables.product.prodname_dotcom %}-generated merge commit of a pull request use `refs/pull/NUMBER/merge`. | --commit | {% octicon "check" aria-label="Required" %} | Specify the full SHA of the commit you analyzed. -| --sarif | {% octicon "check" aria-label="Required" %} | Specify the SARIF file to load.{% ifversion ghes or ghae %} +| --sarif | {% octicon "check" aria-label="Required" %} | Specify the SARIF file to load.{% ifversion ghes %} | --github-url | {% octicon "check" aria-label="Required" %} | Specify the URL for {% data variables.product.product_name %}.{% endif %} | --github-auth-stdin | {% octicon "x" aria-label="Optional" %} | Pass the CLI the {% data variables.product.prodname_github_app %} or {% data variables.product.pat_generic %} created for authentication with {% data variables.product.company_short %}'s REST API from your secret store via standard input. This is not needed if the command has access to a `GITHUB_TOKEN` environment variable set with this token. @@ -83,7 +83,7 @@ The following example uploads results from the SARIF file `temp/example-repo-js. codeql github upload-results \ --repository=my-org/example-repo \ --ref=refs/heads/main --commit=deb275d2d5fe9a522a0b7bd8b6b6a1c939552718 \ - --sarif=/temp/example-repo-js.sarif {% ifversion ghes or ghae %}--github-url={% data variables.command_line.git_url_example %} \ + --sarif=/temp/example-repo-js.sarif {% ifversion ghes %}--github-url={% data variables.command_line.git_url_example %} \ {% endif %} ``` @@ -119,7 +119,7 @@ You can make this diagnostic information available on the {% data variables.code codeql github upload-results \ --repository=my-org/example-repo \ --ref=refs/heads/main --commit=deb275d2d5fe9a522a0b7bd8b6b6a1c939552718 \ - --sarif=/temp/example-repo-js.sarif {% ifversion ghes or ghae %}--github-url={% data variables.command_line.git_url_example %} \ + --sarif=/temp/example-repo-js.sarif {% ifversion ghes %}--github-url={% data variables.command_line.git_url_example %} \ {% endif %} ``` diff --git a/content/code-security/dependabot/dependabot-alerts/about-dependabot-alerts.md b/content/code-security/dependabot/dependabot-alerts/about-dependabot-alerts.md index ea60e3ee68..317cd2f475 100644 --- a/content/code-security/dependabot/dependabot-alerts/about-dependabot-alerts.md +++ b/content/code-security/dependabot/dependabot-alerts/about-dependabot-alerts.md @@ -1,6 +1,6 @@ --- title: About Dependabot alerts -intro: '{% data variables.product.product_name %} sends {% data variables.product.prodname_dependabot_alerts %} when we detect that your repository uses a vulnerable dependency{% ifversion GH-advisory-db-supports-malware %} or malware{% endif %}.' +intro: '{% data variables.product.product_name %} sends {% data variables.product.prodname_dependabot_alerts %} when we detect that your repository uses a vulnerable dependency.' product: '{% data reusables.gated-features.dependabot-alerts %}' redirect_from: - /articles/about-security-alerts-for-vulnerable-dependencies @@ -26,14 +26,12 @@ shortTitle: Dependabot alerts ## About {% data variables.product.prodname_dependabot_alerts %} -{% ifversion GH-advisory-db-supports-malware %} -{% data reusables.advisory-database.beta-malware-advisories %} -{% endif %} - {% data variables.product.prodname_dependabot_alerts %} tell you that your code depends on a package that is insecure. If your code depends on a package with a security vulnerability, this can cause a range of problems for your project or the people who use it. You should upgrade to a secure version of the package as soon as possible.{% ifversion GH-advisory-db-supports-malware %} If your code uses malware, you need to replace the package with a secure alternative.{% endif %} +{% data reusables.dependabot.no-dependabot-alerts-for-malware %} + {% data reusables.dependabot.quickstart-link %} ## Detection of insecure dependencies @@ -74,7 +72,7 @@ As {% data variables.product.prodname_dependabot_alerts %} rely on the dependenc {% data reusables.repositories.enable-security-alerts %} -{% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %} detects vulnerable dependencies and malware in _public_ repositories and displays the dependency graph, but does not generate {% data variables.product.prodname_dependabot_alerts %} by default. Repository owners or people with admin access can enable {% data variables.product.prodname_dependabot_alerts %} for public repositories. Owners of private repositories, or people with admin access, can enable {% data variables.product.prodname_dependabot_alerts %} by enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} for their repositories. +{% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %} detects vulnerable dependencies in _public_ repositories and displays the dependency graph, but does not generate {% data variables.product.prodname_dependabot_alerts %} by default. Repository owners or people with admin access can enable {% data variables.product.prodname_dependabot_alerts %} for public repositories. Owners of private repositories, or people with admin access, can enable {% data variables.product.prodname_dependabot_alerts %} by enabling the dependency graph and {% data variables.product.prodname_dependabot_alerts %} for their repositories. You can also enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories owned by your user account or organization. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts)." @@ -83,7 +81,7 @@ For information about access requirements for actions related to {% data variabl {% data variables.product.product_name %} starts generating the dependency graph immediately and generates alerts for any insecure dependencies as soon as they are identified. The graph is usually populated within minutes but this may take longer for repositories with many dependencies. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#enabling-or-disabling-security-and-analysis-features-for-private-repositories)." {% endif %} -When {% data variables.product.product_name %} identifies a vulnerable dependency{% ifversion GH-advisory-db-supports-malware %} or malware{% endif %}, we generate a {% data variables.product.prodname_dependabot %} alert and display it {% ifversion fpt or ghec or ghes %} on the **Security** tab for the repository and{% endif %} in the repository's dependency graph. The alert includes {% ifversion fpt or ghec or ghes %}a link to the affected file in the project, and {% endif %}information about a fixed version. +When {% data variables.product.product_name %} identifies a vulnerable dependency, we generate a {% data variables.product.prodname_dependabot %} alert and display it {% ifversion fpt or ghec or ghes %} on the **Security** tab for the repository and{% endif %} in the repository's dependency graph. The alert includes {% ifversion fpt or ghec or ghes %}a link to the affected file in the project, and {% endif %}information about a fixed version. {% data variables.product.product_name %} may also notify the maintainers of affected repositories about new alerts according to their notification preferences.{% ifversion dependabot-suppressed-notifications %} When {% data variables.product.prodname_dependabot %} is first enabled, {% data variables.product.product_name %} does not send notifications for all vulnerable dependencies found in your repository, only for new vulnerable dependencies identified after {% data variables.product.prodname_dependabot %} is enabled.{% endif %} For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts)." @@ -97,7 +95,7 @@ When {% data variables.product.product_name %} identifies a vulnerable dependenc {% warning %} -**Note**: {% data variables.product.product_name %}'s security features do not claim to catch all vulnerabilities{% ifversion GH-advisory-db-supports-malware %} and malware{% endif %}. We actively maintain {% data variables.product.prodname_advisory_database %} and generate alerts with the most up-to-date information. However, we cannot catch everything or tell you about known vulnerabilities within a guaranteed time frame. These features are not substitutes for human review of each dependency for potential vulnerabilities or any other issues, and we recommend consulting with a security service or conducting a thorough dependency review when necessary. +**Note**: {% data variables.product.product_name %}'s security features do not claim to catch all vulnerabilities. We actively maintain {% data variables.product.prodname_advisory_database %} and generate alerts with the most up-to-date information. However, we cannot catch everything or tell you about known vulnerabilities within a guaranteed time frame. These features are not substitutes for human review of each dependency for potential vulnerabilities or any other issues, and we recommend consulting with a security service or conducting a thorough dependency review when necessary. {% endwarning %} diff --git a/content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md b/content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md index 88bf303570..03947901a8 100644 --- a/content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md +++ b/content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md @@ -1,6 +1,6 @@ --- title: Configuring Dependabot alerts -intro: 'Enable {% data variables.product.prodname_dependabot_alerts %} to be generated when a new vulnerable dependency {% ifversion GH-advisory-db-supports-malware %}or malware {% endif %}is found in one of your repositories.' +intro: 'Enable {% data variables.product.prodname_dependabot_alerts %} to be generated when a new vulnerable dependency is found in one of your repositories.' shortTitle: Configure Dependabot alerts versions: fpt: '*' @@ -17,11 +17,11 @@ topics: - Repositories --- -## About {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies{% ifversion GH-advisory-db-supports-malware %} and malware{% endif %} +## About {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies {% data reusables.repositories.a-vulnerability-is %} -{% data variables.product.prodname_dependabot %} scans code when a new advisory is added to the {% data variables.product.prodname_advisory_database %} or the dependency graph for a repository changes. When vulnerable dependencies{% ifversion GH-advisory-db-supports-malware %} or malware{% endif %} are detected, {% data variables.product.prodname_dependabot_alerts %} are generated. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." +{% data variables.product.prodname_dependabot %} scans code when a new advisory is added to the {% data variables.product.prodname_advisory_database %} or the dependency graph for a repository changes. When vulnerable dependencies are detected, {% data variables.product.prodname_dependabot_alerts %} are generated. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." {% data reusables.dependabot.dependabot-alert-create-PR %} diff --git a/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md b/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md index 7f94d86b77..8ab3f481be 100644 --- a/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md +++ b/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md @@ -23,15 +23,17 @@ topics: ## About notifications for {% data variables.product.prodname_dependabot_alerts %} -When {% data variables.product.prodname_dependabot %} detects vulnerable dependencies{% ifversion GH-advisory-db-supports-malware %} or malware{% endif %} in your repositories, we generate a {% data variables.product.prodname_dependabot %} alert and display it on the **Security** tab for the repository. {% data variables.product.product_name %} notifies the maintainers of affected repositories about the new alert according to their notification preferences.{% ifversion fpt or ghec %} {% data variables.product.prodname_dependabot %} is enabled by default on all public repositories, and needs to be enabled on private repositories. By default, you will receive {% data variables.product.prodname_dependabot_alerts %} by email. You can override the default overall behavior by choosing the type of notifications you want to receive, or switching notifications off altogether in the settings page for your user notifications at [https://github.com/settings/notifications](https://github.com/settings/notifications). +When {% data variables.product.prodname_dependabot %} detects vulnerable dependencies in your repositories, we generate a {% data variables.product.prodname_dependabot %} alert and display it on the **Security** tab for the repository. {% data variables.product.product_name %} notifies the maintainers of affected repositories about the new alert according to their notification preferences.{% ifversion fpt or ghec %} {% data variables.product.prodname_dependabot %} is enabled by default on all public repositories, and needs to be enabled on private repositories. By default, you will receive {% data variables.product.prodname_dependabot_alerts %} by email. You can override the default overall behavior by choosing the type of notifications you want to receive, or switching notifications off altogether in the settings page for your user notifications at [https://github.com/settings/notifications](https://github.com/settings/notifications). {% endif %} +{% data reusables.dependabot.no-dependabot-alerts-for-malware %} + {% ifversion dependabot-suppressed-notifications %}Regardless of your notification preferences, when {% data variables.product.prodname_dependabot %} is first enabled, {% data variables.product.product_name %} does not send notifications for all vulnerable dependencies found in your repository. Instead, you will receive notifications for new vulnerable dependencies identified after {% data variables.product.prodname_dependabot %} is enabled, if your notification preferences allow it.{% endif %} {% ifversion fpt or ghec %}If you're an organization owner, you can enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories in your organization with one click. You can also set whether {% data variables.product.prodname_dependabot_alerts %} will be enabled or disabled for newly-created repositories. For more information, see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-new-repositories-when-they-are-added)." {% endif %} -{% ifversion ghes or ghae %} +{% ifversion ghes %} By default, if your enterprise owner has configured email for notifications on your enterprise, you will receive {% data variables.product.prodname_dependabot_alerts %} by email. Enterprise owners can also enable {% data variables.product.prodname_dependabot_alerts %} without notifications. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)." diff --git a/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md b/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md index c4e2dadad5..66b1c7cba4 100644 --- a/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md +++ b/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md @@ -38,6 +38,8 @@ You can enable automatic security updates for any repository that uses {% data v {% data variables.product.product_name %} generates {% data variables.product.prodname_dependabot_alerts %} when we detect that the default branch of your codebase is using dependencies with known security risks. For repositories where {% data variables.product.prodname_dependabot_security_updates %} are enabled, when {% data variables.product.product_name %} detects a vulnerable dependency in the default branch, {% data variables.product.prodname_dependabot %} creates a pull request to fix it. The pull request will upgrade the dependency to the minimum possible secure version needed to avoid the vulnerability. +{% data reusables.dependabot.no-dependabot-alerts-for-malware %} + Each {% data variables.product.prodname_dependabot %} alert has a unique numeric identifier and the {% data variables.product.prodname_dependabot_alerts %} tab lists an alert for every detected vulnerability. Legacy {% data variables.product.prodname_dependabot_alerts %} grouped vulnerabilities by dependency and generated a single alert per dependency. If you navigate to a legacy {% data variables.product.prodname_dependabot %} alert, you will be redirected to a {% data variables.product.prodname_dependabot_alerts %} tab filtered for that package. {% endif %} You can filter and sort {% data variables.product.prodname_dependabot_alerts %} using a variety of filters and sort options available on the user interface. For more information, see "[Prioritizing {% data variables.product.prodname_dependabot_alerts %}](#prioritizing-across--data-variablesproductprodname_dependabot_alerts-)" below. @@ -132,7 +134,7 @@ You can view all open and closed {% data variables.product.prodname_dependabot_a ## Reviewing and fixing alerts -It’s important to ensure that all of your dependencies are clean of any security weaknesses. When {% data variables.product.prodname_dependabot %} discovers vulnerabilities {% ifversion GH-advisory-db-supports-malware %}or malware{% endif %} in your dependencies, you should assess your project’s level of exposure and determine what remediation steps to take to secure your application. +It’s important to ensure that all of your dependencies are clean of any security weaknesses. When {% data variables.product.prodname_dependabot %} discovers vulnerabilities in your dependencies, you should assess your project’s level of exposure and determine what remediation steps to take to secure your application. {% ifversion fpt or ghec or ghes %} diff --git a/content/code-security/dependabot/working-with-dependabot/troubleshooting-dependabot-errors.md b/content/code-security/dependabot/working-with-dependabot/troubleshooting-dependabot-errors.md index 10f50cdf0e..99850f5104 100644 --- a/content/code-security/dependabot/working-with-dependabot/troubleshooting-dependabot-errors.md +++ b/content/code-security/dependabot/working-with-dependabot/troubleshooting-dependabot-errors.md @@ -50,9 +50,6 @@ When {% data variables.product.prodname_dependabot %} is blocked from creating a There are several reasons why an alert may have no pull request link: 1. {% data variables.product.prodname_dependabot_security_updates %} are not enabled for the repository. -{% ifversion GH-advisory-db-supports-malware %} -1. The alert is for malware and there is no secure version of the package. -{% endif %} 1. The alert is for an indirect or transitive dependency that is not explicitly defined in a lock file. 1. An error blocked {% data variables.product.prodname_dependabot %} from creating a pull request. @@ -112,6 +109,16 @@ If a security vulnerability is released for `B` versions `<2.0.0` and a patch is {% data variables.product.prodname_dependabot %} automatically generates a pull request that upgrades both the locked parent and child transitive dependencies.{% endif %} +### {% data variables.product.prodname_dependabot %} fails to close a open pull request for an update that has already been applied on the default branch + +{% data variables.product.prodname_dependabot %} will close pull requests for dependency updates, once it detects these updates have been committed to the default branch. However, in rare circumstances, the pull request may remain open. If you notice that you have committed an update to a dependency manually, and that the pull request for that same update is still open, you can use one of the following commands in a comment on the pull request: +- `@dependabot recreate`, or +- `@dependabot rebase`. + +Either comment will trigger {% data variables.product.prodname_dependabot %} to check if the dependency is no longer upgradable or vulnerable. If {% data variables.product.prodname_dependabot %} detects that the pull request is no longer required, it will close the pull request in this particular case. + +For more information about {% data variables.product.prodname_dependabot %} comment commands, see "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates#managing-dependabot-pull-requests-with-comment-commands)." + ### {% data variables.product.prodname_dependabot %} cannot update to the required version as there is already an open pull request for the latest version **Security updates only.** {% data variables.product.prodname_dependabot %} will not create a pull request to update the vulnerable dependency to a secure version because there is already an open pull request to update this dependency. You will see this error when a vulnerability is detected in a single dependency and there's already an open pull request to update the dependency to the latest version. diff --git a/content/code-security/dependabot/working-with-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies.md b/content/code-security/dependabot/working-with-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies.md index 40d4a30a8f..076baa966b 100644 --- a/content/code-security/dependabot/working-with-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies.md +++ b/content/code-security/dependabot/working-with-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies.md @@ -36,7 +36,7 @@ topics: - {% data variables.product.prodname_dependabot %} scans any push, to the default branch, that contains a manifest file. When a new advisory is added, it scans all existing repositories and generates an alert for each repository that is affected. {% data variables.product.prodname_dependabot_alerts %} are aggregated at the repository level, rather than creating one alert per advisory. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - {% ifversion fpt or ghec or ghes %}{% data variables.product.prodname_dependabot_security_updates %} are triggered when you receive an alert about a vulnerable dependency in your repository. Where possible, {% data variables.product.prodname_dependabot %} creates a pull request in your repository to upgrade the vulnerable dependency to the minimum possible secure version needed to avoid the vulnerability. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates)" and "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/troubleshooting-dependabot-errors)." - {% endif %}{% data variables.product.prodname_dependabot %} doesn't scan repositories on a schedule, but rather when something changes. For example, a scan is triggered when a new dependency is added ({% data variables.product.prodname_dotcom %} checks for this on every push), or when a new advisory is added to the database{% ifversion ghes or ghae %} and synchronized to {% data variables.location.product_location %}{% endif %}. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts#detection-of-insecure-dependencies)." + {% endif %}{% data variables.product.prodname_dependabot %} doesn't scan repositories on a schedule, but rather when something changes. For example, a scan is triggered when a new dependency is added ({% data variables.product.prodname_dotcom %} checks for this on every push), or when a new advisory is added to the database{% ifversion ghes %} and synchronized to {% data variables.location.product_location %}{% endif %}. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts#detection-of-insecure-dependencies)." ## Do {% data variables.product.prodname_dependabot_alerts %} only relate to insecure dependencies in manifests and lockfiles? diff --git a/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md b/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md index 2289412629..1f00d6d1a2 100644 --- a/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md +++ b/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md @@ -39,7 +39,7 @@ After someone reports a security vulnerability in your project, you can use {% d {% data reusables.repositories.github-security-lab %} {% endif %} -{% ifversion ghes or ghae %} +{% ifversion ghes %} By making security reporting instructions clearly available, you make it easy for your users to report any security vulnerabilities they find in your repository using your preferred communication channel. {% endif %} diff --git a/content/code-security/secret-scanning/about-secret-scanning.md b/content/code-security/secret-scanning/about-secret-scanning.md index e2cdd2e00b..a0ce1ad003 100644 --- a/content/code-security/secret-scanning/about-secret-scanning.md +++ b/content/code-security/secret-scanning/about-secret-scanning.md @@ -11,7 +11,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' type: overview topics: @@ -26,7 +25,7 @@ topics: If your project communicates with an external service, you might use a token or private key for authentication. Tokens and private keys are examples of secrets that a service provider can issue. If you check a secret into a repository, anyone who has read access to the repository can use the secret to access the external service with your privileges. We recommend that you store secrets in a dedicated, secure location outside of the repository for your project. -{% data variables.product.prodname_secret_scanning_caps %} will scan your entire Git history on all branches present in your {% data variables.product.prodname_dotcom %} repository for secrets{% ifversion ghec or ghes or ghae %}, even if the repository is archived{% endif %}.{% ifversion ghes < 3.11 %} {% data variables.product.prodname_secret_scanning_caps %} does not scan issues.{% endif %} +{% data variables.product.prodname_secret_scanning_caps %} will scan your entire Git history on all branches present in your {% data variables.product.prodname_dotcom %} repository for secrets{% ifversion ghec or ghes %}, even if the repository is archived{% endif %}.{% ifversion ghes < 3.11 %} {% data variables.product.prodname_secret_scanning_caps %} does not scan issues.{% endif %} {% data reusables.secret-scanning.what-is-scanned %} @@ -73,13 +72,13 @@ You cannot change the configuration of {% data variables.product.prodname_secret {% endif %} -## About {% data variables.secret-scanning.user_alerts %}{% ifversion ghes or ghae %} on {% data variables.product.product_name %}{% endif %} +## About {% data variables.secret-scanning.user_alerts %}{% ifversion ghes %} on {% data variables.product.product_name %}{% endif %} -{% ifversion ghes or ghae %}{% data variables.secret-scanning.user_alerts_caps %} is available on all organization-owned repositories as part of {% data variables.product.prodname_GH_advanced_security %}. The feature is not available on user-owned repositories.{% endif %}{% ifversion fpt or ghec %}{% data variables.secret-scanning.user_alerts_caps %} are available for free on all public repositories{% endif %}{% ifversion fpt %}.{% endif %}{%ifversion ghec %}, and for private and internal repositories that are owned by organizations using {% data variables.product.prodname_ghe_cloud %} with a license for {% data variables.product.prodname_GH_advanced_security %}.{% endif %} When you enable {% data variables.product.prodname_secret_scanning %} for a repository, {% data variables.product.prodname_dotcom %} scans the code for patterns that match secrets used by many service providers. {% ifversion secret-scanning-backfill-email %}When the scan is completed, {% data variables.product.prodname_dotcom %} sends an email alert to the enterprise and organization owners, even if no secrets were found.{% endif %} For more information about the repository content that is scanned, see "[About {% data variables.product.prodname_secret_scanning %}](#about--data-variablesproductprodname_secret_scanning)" above. +{% ifversion ghes %}{% data variables.secret-scanning.user_alerts_caps %} is available on all organization-owned repositories as part of {% data variables.product.prodname_GH_advanced_security %}. The feature is not available on user-owned repositories.{% endif %}{% ifversion fpt or ghec %}{% data variables.secret-scanning.user_alerts_caps %} are available for free on all public repositories{% endif %}{% ifversion fpt %}.{% endif %}{%ifversion ghec %}, and for private and internal repositories that are owned by organizations using {% data variables.product.prodname_ghe_cloud %} with a license for {% data variables.product.prodname_GH_advanced_security %}.{% endif %} When you enable {% data variables.product.prodname_secret_scanning %} for a repository, {% data variables.product.prodname_dotcom %} scans the code for patterns that match secrets used by many service providers. {% ifversion secret-scanning-backfill-email %}When the scan is completed, {% data variables.product.prodname_dotcom %} sends an email alert to the enterprise and organization owners, even if no secrets were found.{% endif %} For more information about the repository content that is scanned, see "[About {% data variables.product.prodname_secret_scanning %}](#about--data-variablesproductprodname_secret_scanning)" above. When a supported secret is leaked, {% data variables.product.product_name %} generates a {% data variables.product.prodname_secret_scanning %} alert. {% ifversion secret-scanning-backfills %}{% data variables.product.prodname_dotcom %} will also periodically run a full git history scan of existing content in {% ifversion fpt %}public{% else %}{% data variables.product.prodname_GH_advanced_security %}{% endif %} repositories where {% data variables.product.prodname_secret_scanning %} is enabled, and send alert notifications following the {% data variables.product.prodname_secret_scanning %} alert notification settings.{% endif %}{% ifversion secret-scanning-non-provider-patterns %} User alerts can be of two types: high confidence alerts, or non-provider alerts.{% endif %} For more information, see "{% ifversion fpt or ghec %}[About user alerts](/code-security/secret-scanning/secret-scanning-patterns#about-user--alerts){% else %}[{% data variables.product.prodname_secret_scanning_caps %} patterns](/code-security/secret-scanning/secret-scanning-patterns#about-user-secret-scanning-alerts){% endif %}." -If you're a repository administrator, you can enable {% data variables.secret-scanning.user_alerts %} for any {% ifversion fpt %}public{% endif %} repository{% ifversion ghec or ghes or ghae %}, including archived repositories{% endif %}. Organization owners can also enable {% data variables.secret-scanning.user_alerts %} for all {% ifversion fpt %}public {% endif %}repositories or for all new {% ifversion fpt %}public {% endif %}repositories within an organization. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)" and "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization)." +If you're a repository administrator, you can enable {% data variables.secret-scanning.user_alerts %} for any {% ifversion fpt %}public{% endif %} repository{% ifversion ghec or ghes %}, including archived repositories{% endif %}. Organization owners can also enable {% data variables.secret-scanning.user_alerts %} for all {% ifversion fpt %}public {% endif %}repositories or for all new {% ifversion fpt %}public {% endif %}repositories within an organization. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)" and "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization)." You can also define custom {% data variables.product.prodname_secret_scanning %} patterns for a repository, organization, or enterprise. For more information, see "[AUTOTITLE]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} @@ -88,7 +87,7 @@ You can also define custom {% data variables.product.prodname_secret_scanning %} ### Accessing {% data variables.secret-scanning.alerts %} -When you enable {% data variables.product.prodname_secret_scanning %} for a repository or push commits to a repository with {% data variables.product.prodname_secret_scanning %} enabled, {% data variables.product.prodname_dotcom %} scans the contents for secrets that match patterns defined by service providers{% ifversion ghes or ghae or ghec %} and any custom patterns defined in your enterprise, organization, or repository{% endif %}. +When you enable {% data variables.product.prodname_secret_scanning %} for a repository or push commits to a repository with {% data variables.product.prodname_secret_scanning %} enabled, {% data variables.product.prodname_dotcom %} scans the contents for secrets that match patterns defined by service providers{% ifversion ghes or ghec %} and any custom patterns defined in your enterprise, organization, or repository{% endif %}. When {% data variables.product.prodname_secret_scanning %} detects a secret, {% data variables.product.prodname_dotcom %} generates an alert. @@ -104,7 +103,7 @@ For more information on how to configure notifications for {% data variables.sec Repository administrators and organization owners can grant users and teams access to {% data variables.secret-scanning.alerts %}. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." -{% ifversion ghec or ghes or ghae > 3.4 %} +{% ifversion ghec or ghes %} You can use security overview to see an organization-level view of which repositories have enabled {% data variables.product.prodname_secret_scanning %} and the alerts found. For more information, see "[AUTOTITLE](/code-security/security-overview/about-security-overview)." {% endif %} diff --git a/content/code-security/secret-scanning/secret-scanning-partner-program.md b/content/code-security/secret-scanning/secret-scanning-partner-program.md index 8bf5935b89..6fe877465b 100644 --- a/content/code-security/secret-scanning/secret-scanning-partner-program.md +++ b/content/code-security/secret-scanning/secret-scanning-partner-program.md @@ -103,12 +103,12 @@ to validate the messages you receive are genuinely from {% data variables.produc The two HTTP headers to look for are: -- `GITHUB-PUBLIC-KEY-IDENTIFIER`: Which `key_identifier` to use from our API -- `GITHUB-PUBLIC-KEY-SIGNATURE`: Signature of the payload +- `Github-Public-Key-Identifier`: Which `key_identifier` to use from our API +- `Github-Public-Key-Signature`: Signature of the payload You can retrieve the {% data variables.product.prodname_dotcom %} secret scanning public key from https://api.github.com/meta/public_keys/secret_scanning and validate the message using the `ECDSA-NIST-P256V1-SHA256` algorithm. The endpoint will provide several `key_identifier` and public keys. You can determine which public -key to use based on the value of `GITHUB-PUBLIC-KEY-IDENTIFIER`. +key to use based on the value of `Github-Public-Key-Identifier`. {% note %} @@ -128,28 +128,14 @@ key to use based on the value of `GITHUB-PUBLIC-KEY-IDENTIFIER`. POST / HTTP/2 Host: HOST Accept: */* -content-type: application/json -GITHUB-PUBLIC-KEY-IDENTIFIER: f9525bf080f75b3506ca1ead061add62b8633a346606dc5fe544e29231c6ee0d -GITHUB-PUBLIC-KEY-SIGNATURE: MEUCIFLZzeK++IhS+y276SRk2Pe5LfDrfvTXu6iwKKcFGCrvAiEAhHN2kDOhy2I6eGkOFmxNkOJ+L2y8oQ9A2T9GGJo6WJY= -Content-Length: 83 +Content-Length: 104 +Content-Type: application/json +Github-Public-Key-Identifier: bcb53661c06b4728e59d897fb6165d5c9cda0fd9cdf9d09ead458168deb7518c +Github-Public-Key-Signature: MEQCIQDaMKqrGnE27S0kgMrEK0eYBmyG0LeZismAEz/BgZyt7AIfXt9fErtRS4XaeSt/AO1RtBY66YcAdjxji410VQV4xg== -[{"token":"some_token","type":"some_type","url":"some_url","source":"some_source"}] +[{"source":"commit","token":"some_token","type":"some_type","url":"https://example.com/base-repo-url/"}] ``` -{% note %} - -**Note**: The key id and signature from the example payload is derived from a test key. -The public key for them is: - -```shell ------BEGIN PUBLIC KEY----- -MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEsz9ugWDj5jK5ELBK42ynytbo38gP -HzZFI03Exwz8Lh/tCfL3YxwMdLjB+bMznsanlhK0RwcGP3IDb34kQDIo3Q== ------END PUBLIC KEY----- -``` - -{% endnote %} - The following code snippets demonstrate how you could perform signature validation. The code examples assume you've set an environment variable called `GITHUB_PRODUCTION_TOKEN` with a generated [{% data variables.product.pat_generic %}](https://github.com/settings/tokens) to avoid hitting rate limits. The {% data variables.product.pat_generic %} does not need any scopes/permissions. diff --git a/content/code-security/secret-scanning/secret-scanning-patterns.md b/content/code-security/secret-scanning/secret-scanning-patterns.md index 97ba408af7..66283bcfae 100644 --- a/content/code-security/secret-scanning/secret-scanning-patterns.md +++ b/content/code-security/secret-scanning/secret-scanning-patterns.md @@ -97,7 +97,7 @@ This table lists the secrets supported by {% data variables.product.prodname_sec - Applies to public repositories, and to private repositories where {% data variables.product.prodname_GH_advanced_security %}, {% data variables.product.prodname_secret_scanning %}. - Includes high confidence tokens, which relate to supported patterns and specified custom patterns, as well as non-provider tokens such as private keys, which usually have a higher ratio of false positives. - For {% data variables.product.prodname_secret_scanning %} to scan for non-provider patterns, the detection of non-provider patterns must be enabled for the repository or the organization. For more information, see "[AUTOTITLE](/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories)." - {% data reusables.secret-scanning.non-provider-patterns-beta %}{% endif %}{% endif %}{% ifversion ghes or ghae %} + {% data reusables.secret-scanning.non-provider-patterns-beta %}{% endif %}{% endif %}{% ifversion ghes %} - **{% data variables.product.prodname_secret_scanning_caps %} alert**—token for which leaks are reported to users on {% data variables.product.prodname_dotcom %}.{% ifversion secret-scanning-non-provider-patterns %} - Applies to private repositories where {% data variables.product.prodname_GH_advanced_security %} and {% data variables.product.prodname_secret_scanning %} are enabled. - Includes high confidence tokens, which relate to supported patterns and specified custom patterns, as well as non-provider tokens such as private keys, which often result in false positives.{% else %} Applies to private repositories where {% data variables.product.prodname_GH_advanced_security %} and {% data variables.product.prodname_secret_scanning %} enabled.{% endif %}{% endif %} @@ -176,28 +176,6 @@ Push protection and validity checks are not supported for non-provider patterns. {% endif %} - -{% ifversion ghae < 3.5 %} - -| Provider | Token | {% data variables.product.prodname_secret_scanning_caps %} alert | -|----|:----|:----:| -{%- for entry in secretScanningData %} -| {{ entry.provider }} | {{ entry.secretType }} | {% if entry.isPrivateWithGhas %}{% octicon "check" aria-label="Supported" %}{% else %}{% octicon "x" aria-label="Unsupported" %}{% endif %} | -{%- endfor %} - -{% endif %} - - -{% ifversion ghae = 3.5 or ghae > 3.5 %} - -| Provider | Token | {% data variables.product.prodname_secret_scanning_caps %} alert | Push protection | -|----|:----|:----:|:----:| -{%- for entry in secretScanningData %} -| {{ entry.provider }} | {{ entry.secretType }} | {% if entry.isPrivateWithGhas %}{% octicon "check" aria-label="Supported" %}{% else %}{% octicon "x" aria-label="Unsupported" %}{% endif %} | {% if entry.hasPushProtection %}{% octicon "check" aria-label="Supported" %}{% else %}{% octicon "x" aria-label="Unsupported" %}{% endif %} | -{%- endfor %} - -{% endif %} - ## Further reading - "[AUTOTITLE](/code-security/getting-started/securing-your-repository)" diff --git a/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories.md b/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories.md index 08d571b090..bd70a3fd50 100644 --- a/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories.md +++ b/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories.md @@ -20,9 +20,26 @@ redirect_from: {% ifversion fpt or ghec %}There are two types of advisories: global security advisories and repository security advisories. For more information about repository security advisories, see "[AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/about-repository-security-advisories)."{% endif %} -Global security advisories are grouped into two categories: {% data variables.product.company_short %}-reviewed advisories and unreviewed advisories. -- {% data variables.product.company_short %}-reviewed advisories are security vulnerabilities{% ifversion GH-advisory-db-supports-malware %} or malware{% endif %} that have been mapped to packages in ecosystems we support. -- Unreviewed advisories are security vulnerabilities that we publish automatically into the {% data variables.product.prodname_advisory_database %}, directly from the National Vulnerability Database feed. +Global security advisories are grouped into these categories: {% data variables.product.company_short %}-reviewed advisories,{% ifversion GH-advisory-db-supports-malware %} unreviewed advisories, and malware advisories{% else %} and unreviewed advisories{% endif %}. +- {% data reusables.advisory-database.github-reviewed-overview %} +- {% data reusables.advisory-database.unreviewed-overview %}{% ifversion GH-advisory-db-supports-malware %} +- {% data reusables.advisory-database.malware-overview %} + +{% note %} + +**Note:** {% data variables.product.prodname_dependabot %} doesn't generate {% data variables.product.prodname_dependabot_alerts %} for unreviewed and malware advisories. + +{% endnote %} + +{% else %} + +{% note %} + +**Note:** {% data variables.product.prodname_dependabot %} doesn't generate {% data variables.product.prodname_dependabot_alerts %} for unreviewed advisories. + +{% endnote %} + +{% endif %} For more information about the {% data variables.product.prodname_advisory_database %}, see "[AUTOTITLE](/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-the-github-advisory-database)." diff --git a/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-the-github-advisory-database.md b/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-the-github-advisory-database.md index 93ef341e23..6f6567d90f 100644 --- a/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-the-github-advisory-database.md +++ b/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-the-github-advisory-database.md @@ -1,6 +1,6 @@ --- title: About the GitHub Advisory database -intro: 'The {% data variables.product.prodname_advisory_database %} contains a list of known security vulnerabilities {% ifversion GH-advisory-db-supports-malware %}and malware, {% endif %}grouped in two categories: {% data variables.product.company_short %}-reviewed advisories and unreviewed advisories.' +intro: 'The {% data variables.product.prodname_advisory_database %} contains a list of known security vulnerabilities {% ifversion GH-advisory-db-supports-malware %}and malware, grouped in three categories: {% data variables.product.company_short %}-reviewed advisories, unreviewed advisories, and malware advisories.{% else %} grouped in two categories: {% data variables.product.company_short %}-reviewed advisories and unreviewed advisories.{% endif %}' versions: fpt: '*' ghec: '*' @@ -24,8 +24,6 @@ Security advisories are published as JSON files in the Open Source Vulnerability ## About types of security advisories -{% data reusables.advisory-database.beta-malware-advisories %} - Each advisory in the {% data variables.product.prodname_advisory_database %} is for a vulnerability in open source projects{% ifversion GH-advisory-db-supports-malware %} or for malicious open source software{% endif %}. {% data reusables.repositories.a-vulnerability-is %} Vulnerabilities in code are usually introduced by accident and fixed soon after they are discovered. You should update your code to use the fixed version of the dependency as soon as it is available. @@ -38,7 +36,7 @@ In contrast, malicious software, or malware, is code that is intentionally desig ### {% data variables.product.company_short %}-reviewed advisories -{% data variables.product.company_short %}-reviewed advisories are security vulnerabilities{% ifversion GH-advisory-db-supports-malware %} or malware{% endif %} that have been mapped to packages in ecosystems we support. We carefully review each advisory for validity and ensure that they have a full description, and contain both ecosystem and package information. +{% data reusables.advisory-database.github-reviewed-overview %} Generally, we name our supported ecosystems after the software programming language's associated package registry. We review advisories if they are for a vulnerability in a package that comes from a supported registry. @@ -58,14 +56,28 @@ Generally, we name our supported ecosystems after the software programming langu If you have a suggestion for a new ecosystem we should support, please open an [issue](https://github.com/github/advisory-database/issues) for discussion. -If you enable {% data variables.product.prodname_dependabot_alerts %} for your repositories, you are automatically notified when a new {% data variables.product.company_short %}-reviewed advisory reports a vulnerability {% ifversion GH-advisory-db-supports-malware %}or malware{% endif %} for a package you depend on. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." +If you enable {% data variables.product.prodname_dependabot_alerts %} for your repositories, you are automatically notified when a new {% data variables.product.company_short %}-reviewed advisory reports a vulnerability for a package you depend on. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." ### Unreviewed advisories -Unreviewed advisories are security vulnerabilities that we publish automatically into the {% data variables.product.prodname_advisory_database %}, directly from the National Vulnerability Database feed. +{% data reusables.advisory-database.unreviewed-overview %} {% data variables.product.prodname_dependabot %} doesn't create {% data variables.product.prodname_dependabot_alerts %} for unreviewed advisories as this type of advisory isn't checked for validity or completion. +{% ifversion GH-advisory-db-supports-malware %} + +### Malware advisories + +{% data reusables.advisory-database.beta-malware-advisories %} + +{% data reusables.advisory-database.malware-overview %} + +{% data variables.product.prodname_dependabot %} doesn't generate alerts when malware is detected as most of the vulnerabilities cannot be resolved by downstream users. You can view malware advisories by searching for `type:malware` in the {% data variables.product.prodname_advisory_database %}. + +Our malware advisories are mostly about substitution attacks. During this type of attack, an attacker publishes a package to the public registry with the same name as a dependency that users rely on from a third party or private registry, with the hope that the malicious version is consumed. {% data variables.product.prodname_dependabot %} doesn’t look at project configurations to determine if the packages are coming from a private registry, so we aren't sure if you're using the malicious version or a non-malicious version. Users who have their dependencies appropriately scoped should not be affected by malware. + +{% endif %} + ## About information in security advisories In this section, you can find more detailed information about security advisories in the {% data variables.product.prodname_advisory_database %}, such as: diff --git a/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/browsing-security-advisories-in-the-github-advisory-database.md b/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/browsing-security-advisories-in-the-github-advisory-database.md index e109bd74b4..63400847ae 100644 --- a/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/browsing-security-advisories-in-the-github-advisory-database.md +++ b/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/browsing-security-advisories-in-the-github-advisory-database.md @@ -59,7 +59,7 @@ You can search the database, and use qualifiers to narrow your search. For examp | Qualifier | Example | | ------------- | ------------- | | `type:reviewed`| [**type:reviewed**](https://github.com/advisories?query=type%3Areviewed) will show {% data variables.product.company_short %}-reviewed advisories for security vulnerabilities. | -{% ifversion GH-advisory-db-supports-malware %}| `type:malware` | [**type:malware**](https://github.com/advisories?query=type%3Amalware) will show {% data variables.product.company_short %}-reviewed advisories for malware. | +{% ifversion GH-advisory-db-supports-malware %}| `type:malware` | [**type:malware**](https://github.com/advisories?query=type%3Amalware) will show malware advisories. | {% endif %}| `type:unreviewed`| [**type:unreviewed**](https://github.com/advisories?query=type%3Aunreviewed) will show unreviewed advisories. | | `GHSA-ID`| [**GHSA-49wp-qq6x-g2rf**](https://github.com/advisories?query=GHSA-49wp-qq6x-g2rf) will show the advisory with this {% data variables.product.prodname_advisory_database %} ID. | | `CVE-ID`| [**CVE-2020-28482**](https://github.com/advisories?query=CVE-2020-28482) will show the advisory with this CVE ID number. | diff --git a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-code.md b/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-code.md index b5b9485cff..22178c2729 100644 --- a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-code.md +++ b/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-code.md @@ -96,7 +96,7 @@ You can configure {% data variables.product.prodname_secret_scanning %} to check Besides your code, you probably need to use secrets in other places. For example, to allow {% data variables.product.prodname_actions %} workflows, {% data variables.product.prodname_dependabot %}, or your {% data variables.product.prodname_github_codespaces %} development environment to communicate with other systems. For more information on how to securely store and use secrets, see "[AUTOTITLE](/actions/security-guides/encrypted-secrets)," "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#storing-credentials-for-dependabot-to-use)," and "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)." {% endif %} -{% ifversion ghes or ghae %} +{% ifversion ghes %} Besides your code, you probably need to use secrets in other places. For example, to allow {% data variables.product.prodname_actions %} workflows{% ifversion ghes %} or {% data variables.product.prodname_dependabot %}{% endif %} to communicate with other systems. For more information on how to securely store and use secrets, see "[AUTOTITLE](/actions/security-guides/encrypted-secrets){% ifversion ghes %}" and "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#storing-credentials-for-dependabot-to-use)."{% else %}."{% endif %} {% endif %} diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-supply-chain-security.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-supply-chain-security.md index 8c8a40717b..70908cf209 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-supply-chain-security.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-supply-chain-security.md @@ -41,7 +41,7 @@ The dependency graph is central to supply chain security. The dependency graph i Other supply chain features on {% data variables.product.prodname_dotcom %} rely on the information provided by the dependency graph. - Dependency review uses the dependency graph to identify dependency changes and help you understand the security impact of these changes when you review pull requests. -- {% data variables.product.prodname_dependabot %} cross-references dependency data provided by the dependency graph with the list of advisories published in the {% data variables.product.prodname_advisory_database %}, scans your dependencies and generates {% data variables.product.prodname_dependabot_alerts %} when a potential vulnerability {% ifversion GH-advisory-db-supports-malware %}or malware{% endif %} is detected. +- {% data variables.product.prodname_dependabot %} cross-references dependency data provided by the dependency graph with the list of advisories published in the {% data variables.product.prodname_advisory_database %}, scans your dependencies and generates {% data variables.product.prodname_dependabot_alerts %} when a potential vulnerability is detected. {% ifversion fpt or ghec or ghes %}- {% data variables.product.prodname_dependabot_security_updates %} use the dependency graph and {% data variables.product.prodname_dependabot_alerts %} to help you update dependencies with known vulnerabilities in your repository. {% data variables.product.prodname_dependabot_version_updates %} don't use the dependency graph and rely on the semantic versioning of dependencies instead. {% data variables.product.prodname_dependabot_version_updates %} help you keep your dependencies updated, even when they don’t have any vulnerabilities. @@ -110,7 +110,7 @@ The term "{% data variables.product.prodname_dependabot %}" encompasses the foll #### What are Dependabot alerts -{% data variables.product.prodname_dependabot_alerts %} highlight repositories affected by a newly discovered vulnerability based on the dependency graph and the {% data variables.product.prodname_advisory_database %}, which contains advisories for known vulnerabilities{% ifversion GH-advisory-db-supports-malware %} and malware{% endif %}. +{% data variables.product.prodname_dependabot_alerts %} highlight repositories affected by a newly discovered vulnerability based on the dependency graph and the {% data variables.product.prodname_advisory_database %}, which contains advisories for known vulnerabilities. - {% data variables.product.prodname_dependabot %} performs a scan to detect insecure dependencies and sends {% data variables.product.prodname_dependabot_alerts %} when: {% ifversion fpt or ghec %} @@ -167,7 +167,7 @@ Any repository type: - **{% data variables.product.prodname_dependabot_version_updates %}**—not enabled by default. People with write permissions to a repository can enable {% data variables.product.prodname_dependabot_version_updates %}. For information about enabling version updates, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates)." {% endif %} -{% ifversion ghes or ghae %} +{% ifversion ghes %} - **Dependency graph** and **{% data variables.product.prodname_dependabot_alerts %}**—not enabled by default. Both features are configured at an enterprise level by the enterprise owner. For more information, see {% ifversion ghes %}"[AUTOTITLE](/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise)" and {% endif %}"[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)." - **Dependency review**—available when dependency graph is enabled for {% data variables.location.product_location %} and {% data variables.product.prodname_advanced_security %} is enabled for the organization or repository. For more information, see "[AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security)." {% endif %} diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review.md index cab0e0c520..b6de115d2c 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review.md @@ -141,10 +141,10 @@ Notice that all of the examples use a short version number for the action (`v3`) {% ifversion dependency-review-action-licenses %} # You can only include one of these two options: `allow-licenses` and `deny-licenses` # ([String]). Only allow these licenses (optional) - # Possible values: Any `spdx_id` value(s) from https://docs.github.com/en/rest/licenses + # Possible values: Any SPDX-compliant license identifiers or expressions from https://spdx.org/licenses/ allow-licenses: GPL-3.0, BSD-3-Clause, MIT # ([String]). Block the pull request on these licenses (optional) - # Possible values: Any `spdx_id` value(s) from https://docs.github.com/en/rest/licenses + # Possible values: Any SPDX-compliant license identifiers or expressions from https://spdx.org/licenses/ deny-licenses: LGPL-2.0, BSD-2-Clause {% endif %} # ([String]). Skip these {% data variables.product.prodname_advisory_database %} IDs during detection (optional) @@ -205,13 +205,13 @@ Notice that all of the examples use a short version number for the action (`v3`) {% ifversion dependency-review-action-licenses %} # You can only include one of these two options: `allow-licenses` and `deny-licenses` # ([String]). Only allow these licenses (optional) - # Possible values: Any `spdx_id` value(s) from https://docs.github.com/en/rest/licenses + # Possible values: Any SPDX-compliant license identifiers or expressions from https://spdx.org/licenses/ allow-licenses: - GPL-3.0 - BSD-3-Clause - MIT # ([String]). Block the pull request on these licenses (optional) - # Possible values: Any `spdx_id` value(s) from https://docs.github.com/en/rest/licenses + # Possible values: Any SPDX-compliant license identifiers or expressions from https://spdx.org/licenses/ deny-licenses: - LGPL-2.0 - BSD-2-Clause diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md index fb845036a4..9091885642 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md @@ -50,7 +50,7 @@ Enterprise owners can configure the dependency graph at an enterprise level. For For each dependency, you can see its ecosystem, the manifest file in which it was found, and the license (where detected). Dependencies on private repositories, private packages, or unrecognized files are shown in plain text. If the package manager for the dependency is in a public repository, you can hover on the dependency name to display a pop-up with the associated repository information. {% endif %} -{% ifversion ghes or ghae %} +{% ifversion ghes %} Any direct and indirect dependencies that are specified in the repository's manifest or lock files are listed{% ifversion ghes > 3.9 or ghae > 3.9%}.{% else %}, grouped by ecosystem.{% endif %} {% endif %} @@ -60,7 +60,7 @@ Dependencies submitted to a project using the Dependency submission API (beta) w 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 %}. -{% ifversion ghes or ghae %} +{% ifversion ghes %} {% note %} **Note:** {% data variables.product.product_name %} does not populate the **Dependents** view. diff --git a/content/codespaces/getting-started/deep-dive.md b/content/codespaces/getting-started/deep-dive.md index e0ee174389..b563c88fa8 100644 --- a/content/codespaces/getting-started/deep-dive.md +++ b/content/codespaces/getting-started/deep-dive.md @@ -94,7 +94,7 @@ If a codespace times out it will stop running, but you can restart it from the b To stop your codespace you can - In the browser: on your list of codespaces at [https://github.com/codespaces](https://github.com/codespaces), click the ellipsis (**...**) to the right of the codespace you want to stop and click **Stop codespace**. -- In {% data variables.product.prodname_vscode_shortname %}: open the {% data variables.product.prodname_vscode_command_palette %} - for example, by pressing Ctrl+Shift+Enter (Windows/Linux) or Shift+Command+P (Mac) - type `Codespaces: stop` then press Enter. For more information, see "[AUTOTITLE](/codespaces/reference/using-the-vs-code-command-palette-in-codespaces#suspending-or-stopping-a-codespace)." +- In {% data variables.product.prodname_vscode_shortname %}: open the {% data variables.product.prodname_vscode_command_palette %} - for example, by pressing Ctrl+Shift+P (Windows/Linux) or Shift+Command+P (Mac) - type `Codespaces: stop` then press Enter. For more information, see "[AUTOTITLE](/codespaces/reference/using-the-vs-code-command-palette-in-codespaces#suspending-or-stopping-a-codespace)." - In the JetBrains client, click the stop button at the top of the {% data variables.product.prodname_github_codespaces %} tool window. For more information, see the "JetBrains IDEs" tab of "[AUTOTITLE](/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace)." - In a terminal window: use the {% data variables.product.prodname_cli %} command `gh codespace stop`. For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-with-github-cli#gh-commands-for-github-codespaces)." diff --git a/content/communities/documenting-your-project-with-wikis/about-wikis.md b/content/communities/documenting-your-project-with-wikis/about-wikis.md index 810564a1c3..61c169bd16 100644 --- a/content/communities/documenting-your-project-with-wikis/about-wikis.md +++ b/content/communities/documenting-your-project-with-wikis/about-wikis.md @@ -15,7 +15,7 @@ topics: - Community --- -Every repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} comes equipped with a section for hosting documentation, called a wiki. You can use your repository's wiki to share long-form content about your project, such as how to use it, how you designed it, or its core principles. A README file quickly tells what your project can do, while you can use a wiki to provide additional documentation. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)." +Every repository on {% data variables.location.product_location %} comes equipped with a section for hosting documentation, called a wiki. You can use your repository's wiki to share long-form content about your project, such as how to use it, how you designed it, or its core principles. A README file quickly tells what your project can do, while you can use a wiki to provide additional documentation. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)." With wikis, you can write content just like everywhere else on {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github)." We use [our open-source Markup library](https://github.com/github/markup) to convert different formats into HTML, so you can choose to write in Markdown or any other supported format. diff --git a/content/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis.md b/content/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis.md index 20453a1f69..178e1ec090 100644 --- a/content/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis.md +++ b/content/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis.md @@ -1,6 +1,6 @@ --- title: Changing access permissions for wikis -intro: 'Only repository collaborators can edit a {% ifversion fpt or ghec or ghes %}public{% endif %} repository''s wiki by default, but you can allow anyone with an account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} to edit your wiki.' +intro: 'Only repository collaborators can edit a {% ifversion fpt or ghec or ghes %}public{% endif %} repository''s wiki by default, but you can allow anyone with an account on {% data variables.location.product_location %} to edit your wiki.' product: '{% data reusables.gated-features.wikis %}' redirect_from: - /articles/changing-access-permissions-for-wikis diff --git a/content/contributing/style-guide-and-content-model/style-guide.md b/content/contributing/style-guide-and-content-model/style-guide.md index bd5440546d..1e8acee16b 100644 --- a/content/contributing/style-guide-and-content-model/style-guide.md +++ b/content/contributing/style-guide-and-content-model/style-guide.md @@ -254,7 +254,29 @@ Note that regardless of the identifier you use (letters, words), footnotes will Headers must adequately describe the content under them. Headers can either follow the guidelines for writing titles or can be written as questions. Use sentence casing for headers. Each header on a page must be unique. -Use H2 for headers and H3 for subheaders. If an article has headers, the headers must start with an H2 level header and cannot skip header levels. There must be text content between a header and subheader, such as an introduction. When referring to headers, surround the header name with quotation marks. +If an article has headers, the headers must start with an H2 level header. You can use H3 and H4 level headers to further organize content into related groups, but you cannot skip header levels. There must be text content between a header and subheader, such as an introduction. +- **Use:** + + ```markdown + ## HEADER (H2) + TEXT + + ### SUBHEADER (H3) + TEXT + + #### SUBHEADER (H4) + TEXT + ``` + +- **Avoid:** + + ```markdown + ## HEADER (H2) + + #### SUBHEADER (H4) + ``` + +When referring to headers, surround the header name with quotation marks. - **Use:** Under "User licenses," view your total licenses. For more information, see the "[AUTOTITLE](/contributing/style-guide-and-content-model/contents-of-a-github-docs-article)." diff --git a/content/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs.md b/content/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs.md index 108c70727f..e8235676ec 100644 --- a/content/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs.md +++ b/content/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs.md @@ -399,17 +399,17 @@ Because the site is dynamic, it does not build HTML files for each different ver For example, an article that is available in currently supported versions will have permalink URLs like the following: -- `/en/get-started/quickstart/set-up-git` -- `/en/enterprise-cloud@latest/get-started/quickstart/set-up-git` -- `/en/enterprise-server@3.10/get-started/quickstart/set-up-git` -- `/en/enterprise-server@3.9/get-started/quickstart/set-up-git` -- `/en/enterprise-server@3.8/get-started/quickstart/set-up-git` -- `/en/enterprise-server@3.7/get-started/quickstart/set-up-git` -- `/en/enterprise-server@3.6/get-started/quickstart/set-up-git` +- `/en/get-started/getting-started-with-git/set-up-git` +- `/en/enterprise-cloud@latest/get-started/getting-started-with-git/set-up-git` +- `/en/enterprise-server@3.10/get-started/getting-started-with-git/set-up-git` +- `/en/enterprise-server@3.9/get-started/getting-started-with-git/set-up-git` +- `/en/enterprise-server@3.8/get-started/getting-started-with-git/set-up-git` +- `/en/enterprise-server@3.7/get-started/getting-started-with-git/set-up-git` +- `/en/enterprise-server@3.6/get-started/getting-started-with-git/set-up-git` An article that is not available in {% data variables.product.prodname_ghe_server %} will have just one permalink: -- `/en/get-started/quickstart/set-up-git` +- `/en/get-started/getting-started-with-git/set-up-git` {% note %} diff --git a/content/copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment.md b/content/copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment.md index d22d40c1eb..583483dfd4 100644 --- a/content/copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment.md +++ b/content/copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment.md @@ -233,8 +233,7 @@ If you don't want to use the default keyboard shortcuts in {% data variables.pro If you use ReSharper, {% data variables.product.prodname_copilot %} may work best when you configure ReSharper to use {% data variables.product.prodname_copilot %}'s native IntelliSense. For more information about ReSharper, see the [ReSharper documentation](https://www.jetbrains.com/resharper/documentation/documentation.html) -1. In the {% data variables.product.prodname_vs %} menu bar, under **Tools**, click **Options**. - ![Screenshot of {% data variables.product.prodname_vs %} menu bar. In the "Tools" menu, the "Options" item is highlighted with an orange outline.](/assets/images/help/copilot/vs-toolbar-options.png) +1. In the {% data variables.product.prodname_vs %} menu bar, under **Extensions**, click **ReSharper**, then click **Options**. 1. In the "Options" dialog, under **Environment**, click **IntelliSense** and then click **General**. 1. Under "General" select **{% data variables.product.prodname_vs %}** and then click **Save**. diff --git a/content/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot.md b/content/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot.md index 6f4ae826ae..85a341b0c0 100644 --- a/content/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot.md +++ b/content/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot.md @@ -109,7 +109,7 @@ Kerberos is an authentication protocol that allows users and services to prove t Kerberos uses a service principal name (SPN) to uniquely identify a service instance. By default, the SPN is derived from the proxy URL. For example, if the proxy URL is `http://proxy.example.com:3128`, the SPN is `HTTP/proxy.example.com`. -If the default SPN isn't correct for your proxy, you can override the SPN in {% data variables.product.prodname_vscode_shortname %} and in JetBrains IDEs. You cannot currently override the default SPN in {% data variables.product.prodname_vs %}. +If the default SPN isn't correct for your proxy, you can override the SPN in {% data variables.product.prodname_vscode_shortname %} and in JetBrains IDEs. You cannot currently override the default SPN in {% data variables.product.prodname_vs %}. However, you can use the environment variable `AGENT_KERBEROS_SERVICE_PRINCIPAL` to override the SPN for {% data variables.product.prodname_vs %} and JetBrains IDEs. {% vscode %} diff --git a/content/copilot/github-copilot-enterprise/about-github-copilot-enterprise.md b/content/copilot/github-copilot-enterprise/about-github-copilot-enterprise.md index 73721cebcc..a458330fb1 100644 --- a/content/copilot/github-copilot-enterprise/about-github-copilot-enterprise.md +++ b/content/copilot/github-copilot-enterprise/about-github-copilot-enterprise.md @@ -10,12 +10,6 @@ topics: - Copilot --- -{% note %} - -{% data variables.product.prodname_copilot_enterprise %} is in beta, and functionality and documentation are subject to change. You can nominate an organization or enterprise for the beta using the [{% data variables.product.prodname_copilot_enterprise_short %} waitlist form](https://github.com/github-copilot/copilot_enterprise_waitlist_signup/join). - -{% endnote %} - ## About the {% data variables.product.prodname_copilot_enterprise_short %} beta {% data variables.product.prodname_copilot_enterprise %} is a {% data variables.product.prodname_copilot_short %} plan available for enterprises that use {% data variables.product.prodname_ghe_cloud %}. {% data variables.product.prodname_copilot_enterprise_short %} is currently in beta and available to a limited number of customers. diff --git a/content/copilot/github-copilot-enterprise/enabling-github-copilot-enterprise.md b/content/copilot/github-copilot-enterprise/enabling-github-copilot-enterprise.md index ddae301000..d2b9ac376d 100644 --- a/content/copilot/github-copilot-enterprise/enabling-github-copilot-enterprise.md +++ b/content/copilot/github-copilot-enterprise/enabling-github-copilot-enterprise.md @@ -10,12 +10,6 @@ topics: - Copilot --- -{% note %} - -{% data variables.product.prodname_copilot_enterprise %} is in beta, and functionality and documentation are subject to change. You can nominate an organization or enterprise for the beta using the [{% data variables.product.prodname_copilot_enterprise_short %} waitlist form](https://github.com/github-copilot/copilot_enterprise_waitlist_signup/join). - -{% endnote %} - ## About {% data variables.product.prodname_copilot_enterprise_short %} features To use {% data variables.product.prodname_copilot_enterprise %} features, you can nominate an organization or enterprise that you're a member of for the [{% data variables.product.prodname_copilot_enterprise_short %} waitlist](https://github.com/github-copilot/copilot_enterprise_waitlist_signup/join). To join the waitlist, the organization or enterprise must use {% data variables.product.prodname_ghe_cloud %} and have an active {% data variables.product.prodname_copilot_for_business %} subscription. For more information, see "[AUTOTITLE](/copilot/github-copilot-enterprise/about-github-copilot-enterprise)." diff --git a/content/discussions/quickstart.md b/content/discussions/quickstart.md index 28299ba6ad..8f3e647fdd 100644 --- a/content/discussions/quickstart.md +++ b/content/discussions/quickstart.md @@ -10,7 +10,7 @@ shortTitle: Quickstart ## Introduction -{% data variables.product.prodname_discussions %} is a collaborative communication forum for the community around an open source or internal project. Discussions are for conversations that need to be transparent and accessible but do not need to be tracked on a project board and are not related to code, unlike {% data variables.product.prodname_github_issues %}. Discussions enable fluid, open conversation in a public forum. +{% data variables.product.prodname_discussions %} is a collaborative communication forum for the community around an open source or internal project. Discussions are for conversations that need to be transparent and accessible but do not need to be tracked on a project and are not related to code, unlike {% data variables.product.prodname_github_issues %}. Discussions enable fluid, open conversation in a public forum. Discussions give a space for more collaborative conversations by connecting and giving a more centralized area to connect and find information. diff --git a/content/get-started/accessibility/github-command-palette.md b/content/get-started/accessibility/github-command-palette.md index 9bb23ab963..b1ad5b1a25 100644 --- a/content/get-started/accessibility/github-command-palette.md +++ b/content/get-started/accessibility/github-command-palette.md @@ -144,9 +144,9 @@ These commands are available from all scopes. |`Import repository`|Create a new repository by importing a project from another version control system. For more information, see "[AUTOTITLE](/migrations/importing-source-code/using-github-importer/importing-a-repository-with-github-importer)." | |`New gist`|Open a new gist. For more information, see "[AUTOTITLE](/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists)." | |`New organization`|Create a new organization. For more information, see "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)." | -|`New project`|Create a new project board. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project)." | +|`New project`|Create a new project. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project)." | |`New repository`|Create a new repository from scratch. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/creating-a-new-repository)." | -|`Switch theme to `|Change directly to a different theme for the UI. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-theme-settings)." | +|`Switch theme to `|Change directly to a different theme for the UI. For more information, see "[AUTOTITLE](/get-started/accessibility/managing-your-theme-settings)." | ### Organization commands diff --git a/content/get-started/accessibility/keyboard-shortcuts.md b/content/get-started/accessibility/keyboard-shortcuts.md index 8925ea94e0..5680c2f0f9 100644 --- a/content/get-started/accessibility/keyboard-shortcuts.md +++ b/content/get-started/accessibility/keyboard-shortcuts.md @@ -20,7 +20,7 @@ versions: Typing ? on {% data variables.product.prodname_dotcom %} brings up a dialog box that lists the keyboard shortcuts available for that page. You can use these keyboard shortcuts to perform actions across the site without using your mouse to navigate. {% ifversion keyboard-shortcut-accessibility-setting %} -You can disable character key shortcuts, while still allowing shortcuts that use modifier keys, in your accessibility settings. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-accessibility-settings)."{% endif %} +You can disable character key shortcuts, while still allowing shortcuts that use modifier keys, in your accessibility settings. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-accessibility-settings)."{% endif %} {% ifversion command-palette %} The {% data variables.product.prodname_command_palette %} also gives you quick access to a wide range of actions, without the need to remember keyboard shortcuts. For more information, see "[AUTOTITLE](/get-started/accessibility/github-command-palette)."{% endif %} diff --git a/content/get-started/archiving-your-github-personal-account-and-public-repositories/requesting-an-archive-of-your-personal-accounts-data.md b/content/get-started/archiving-your-github-personal-account-and-public-repositories/requesting-an-archive-of-your-personal-accounts-data.md index bc8ba4d04e..8b27d5b220 100644 --- a/content/get-started/archiving-your-github-personal-account-and-public-repositories/requesting-an-archive-of-your-personal-accounts-data.md +++ b/content/get-started/archiving-your-github-personal-account-and-public-repositories/requesting-an-archive-of-your-personal-accounts-data.md @@ -21,7 +21,7 @@ For more information about the data {% data variables.product.product_name %} st When you request an export of your personal data through settings on {% data variables.product.prodname_dotcom_the_website %}, {% data variables.product.product_name %} packages your personal data in a `tar.gz` file and sends you an email to your primary email address with a download link. -By default, the download link expires after seven days. At any time before the download link expires, you can disable the link from your user settings. For more information, see "[AUTOTITLE](/get-started/privacy-on-github/requesting-an-archive-of-your-personal-accounts-data#deleting-access-to-an-archive-of-your-personal-accounts-data)." +By default, the download link expires after seven days. At any time before the download link expires, you can disable the link from your user settings. For more information, see "[AUTOTITLE](/get-started/archiving-your-github-personal-account-and-public-repositories/requesting-an-archive-of-your-personal-accounts-data#deleting-access-to-an-archive-of-your-personal-accounts-data)." If your operating system cannot natively unpack the `tar.gz` file, you can use a third-party tool to extract the archived files. For more information, see "[How to unzip a tar.gz file](https://opensource.com/article/17/7/how-unzip-targz-file)" on Opensource.com. diff --git a/content/get-started/exploring-integrations/about-building-integrations.md b/content/get-started/exploring-integrations/about-building-integrations.md index 8d0d74de53..0a3d16214a 100644 --- a/content/get-started/exploring-integrations/about-building-integrations.md +++ b/content/get-started/exploring-integrations/about-building-integrations.md @@ -1,6 +1,6 @@ --- title: About building integrations -intro: "You can build integrations to extend {% data variables.product.company_short %}'s functionality." +intro: 'You can build integrations to extend {% data variables.product.company_short %}''s functionality.' versions: fpt: '*' ghes: '*' @@ -18,10 +18,10 @@ Many integrations are {% data variables.product.prodname_github_apps %}, {% data Your integration can use {% data variables.product.company_short %}'s API to fetch data and make changes to data on {% data variables.product.company_short %}. {% data variables.product.company_short %} has a REST API and a GraphQL API. For more information, see: -- "[AUTOTITLE](/rest/overview/about-githubs-apis)" +- "[AUTOTITLE](/rest/about-the-rest-api/comparing-githubs-rest-api-and-graphql-api)" - "[AUTOTITLE](/rest)" - "[AUTOTITLE](/graphql)" -Your integration can use webhooks to learn when specific events happen on {% data variables.product.company_short %}. For more information, see "[AUTOTITLE](/webhooks-and-events/webhooks/about-webhooks)." +Your integration can use webhooks to learn when specific events happen on {% data variables.product.company_short %}. For more information, see "[AUTOTITLE](/webhooks/about-webhooks)." -{% ifversion fpt or ghec %} If your integration is a {% data variables.product.prodname_github_app %} or custom action, you can publish your integration on {% data variables.product.prodname_marketplace %}. For more information, see "[AUTOTITLE](/apps/publishing-apps-to-github-marketplace/github-marketplace-overview/about-github-marketplace)" and "[AUTOTITLE](/actions/creating-actions/publishing-actions-in-github-marketplace)."{% endif %} +{% ifversion fpt or ghec %} If your integration is a {% data variables.product.prodname_github_app %} or custom action, you can publish your integration on {% data variables.product.prodname_marketplace %}. For more information, see "[AUTOTITLE](/apps/github-marketplace/github-marketplace-overview/about-github-marketplace-for-apps)" and "[AUTOTITLE](/actions/creating-actions/publishing-actions-in-github-marketplace)."{% endif %} diff --git a/content/get-started/exploring-integrations/about-using-integrations.md b/content/get-started/exploring-integrations/about-using-integrations.md index 2b3bb0487f..3d980e8b5c 100644 --- a/content/get-started/exploring-integrations/about-using-integrations.md +++ b/content/get-started/exploring-integrations/about-using-integrations.md @@ -23,7 +23,7 @@ Integrations are tools that extend {% data variables.product.company_short %}'s You can discover many integrations in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace). {% data variables.product.prodname_marketplace %} includes {% data variables.product.prodname_github_apps %}, {% data variables.product.prodname_oauth_apps %}, and custom actions that you can use in {% data variables.product.prodname_actions %} workflows. You can also get integrations directly from the integration creator. -{% ifversion fpt or ghec or ghes %} For a list of featured {% data variables.product.company_short %} integrations, see "[AUTOTITLE](/get-started/exploring-integrations/github-extensions-and-integrations)."{% endif %} +{% ifversion fpt or ghec or ghes %} For a list of featured {% data variables.product.company_short %} integrations, see "[AUTOTITLE](/get-started/exploring-integrations/featured-github-integrations)."{% endif %} {% ifversion ghes %} diff --git a/content/get-started/exploring-projects-on-github/contributing-to-a-project.md b/content/get-started/exploring-projects-on-github/contributing-to-a-project.md index 995f0dfa7e..e372b8a48e 100644 --- a/content/get-started/exploring-projects-on-github/contributing-to-a-project.md +++ b/content/get-started/exploring-projects-on-github/contributing-to-a-project.md @@ -104,7 +104,7 @@ gh repo fork REPOSITORY --clone=true ## Creating a branch to work on -Before making changes to the project, you should create a new branch and check it out. By keeping changes in their own branch, you follow GitHub Flow and ensure that it will be easier to contribute to the same project again in the future. For more information, see "[AUTOTITLE](/get-started/quickstart/github-flow#following-github-flow)." +Before making changes to the project, you should create a new branch and check it out. By keeping changes in their own branch, you follow GitHub Flow and ensure that it will be easier to contribute to the same project again in the future. For more information, see "[AUTOTITLE](/get-started/using-github/github-flow#following-github-flow)." {% webui %} diff --git a/content/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github.md b/content/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github.md index e3db05cdeb..170f4bc69f 100644 --- a/content/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github.md +++ b/content/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github.md @@ -24,7 +24,7 @@ If there's a particular topic that interests you, visit `github.com/topics/` element with the `prefers-color-scheme` media feature, you can add an image that changes depending on whether a visitor is using light or dark mode. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-theme-settings)." +By using the HTML `` element with the `prefers-color-scheme` media feature, you can add an image that changes depending on whether a visitor is using light or dark mode. For more information, see "[AUTOTITLE](/get-started/accessibility/managing-your-theme-settings)." 1. Copy and paste the following markup into your {% ifversion ghae %}`about-me.md`{% else %}`README.md`{% endif %} file. @@ -245,4 +245,4 @@ Committing directly to the `main` branch will make your changes visible to any v ## Next steps - Continue to learn about advanced formatting features. For example, see {% ifversion fpt or ghec %}"[AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams)" and {% endif %}"[AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks)." -- Use your new skills as you communicate across GitHub, in issues, pull requests, and discussions. For more information, see "[AUTOTITLE](/get-started/quickstart/communicating-on-github)." +- Use your new skills as you communicate across GitHub, in issues, pull requests, and discussions. For more information, see "[AUTOTITLE](/get-started/using-github/communicating-on-github)." diff --git a/content/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists.md b/content/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists.md index 057e7f31ee..04715354fc 100644 --- a/content/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists.md +++ b/content/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists.md @@ -17,7 +17,7 @@ topics: {% ifversion projects-v2-tasklists %} {% note %} -**Note:** For more information about the new iteration of tasklists, which is currently in beta, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/about-tasklists)." +**Note:** For more information about the new iteration of tasklists, which is currently in beta, see "[AUTOTITLE](/issues/managing-your-tasks-with-tasklists/creating-a-tasklist)." {% endnote %} {% endif %} diff --git a/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md b/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md index e50a622dca..3db184a546 100644 --- a/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md +++ b/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md @@ -17,7 +17,7 @@ Mathematical expressions rendering is available in {% data variables.product.pro ## Writing inline expressions {% ifversion math-backtick-syntax %} -There are two options for delimiting a math expression inline with your text. You can either surround the expression with dollar symbols (`$`), or start the expression with $\` and end it with \`$. The latter syntax is useful when the expression you are writing contains characters that overlap with markdown syntax. For more information, see "[Basic writing and formatting syntax](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." +There are two options for delimiting a math expression inline with your text. You can either surround the expression with dollar symbols (`$`), or start the expression with $\` and end it with \`$. The latter syntax is useful when the expression you are writing contains characters that overlap with markdown syntax. For more information, see "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." {% else %} To include a math expression inline within your text, delimit the expression with dollar symbols `$`. {% endif %} diff --git a/content/graphql/guides/managing-enterprise-accounts.md b/content/graphql/guides/managing-enterprise-accounts.md index 078ad7e99d..54f5296186 100644 --- a/content/graphql/guides/managing-enterprise-accounts.md +++ b/content/graphql/guides/managing-enterprise-accounts.md @@ -59,7 +59,7 @@ For some example queries, see "[An example query using the Enterprise Accounts A The enterprise account specific scopes are: - `admin:enterprise`: Gives full control of enterprises (includes `manage_runners:enterprise`, `manage_billing:enterprise` and `read:enterprise`) - - `manage_billing:enterprise`: Read and write enterprise billing data.{% ifversion ghes or ghae %} + - `manage_billing:enterprise`: Read and write enterprise billing data.{% ifversion ghes %} - `manage_runners:enterprise`: Access to manage GitHub Actions enterprise runners and runner-groups.{% endif %} - `read:enterprise`: Read enterprise profile data. diff --git a/content/index.md b/content/index.md index 40337ec863..74b67ef40f 100644 --- a/content/index.md +++ b/content/index.md @@ -2,7 +2,7 @@ title: '{% data variables.product.product_name %}{% ifversion fpt or ghec%}.com{% endif %} Help Documentation' featuredLinks: gettingStarted: - - /get-started/quickstart/set-up-git + - /get-started/getting-started-with-git/set-up-git - /authentication/connecting-to-github-with-ssh - /repositories/creating-and-managing-repositories - /get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax @@ -169,4 +169,3 @@ externalProducts: href: 'https://docs.npmjs.com/' external: true --- - diff --git a/content/issues/index.md b/content/issues/index.md index ff003b8aa7..cdf3809fe1 100644 --- a/content/issues/index.md +++ b/content/issues/index.md @@ -16,7 +16,7 @@ featuredLinks: guideCards: - /issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view - /issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue - - '{% ifversion ghes or ghae %}/issues/organizing-your-work-with-project-boards/managing-project-boards/configuring-automation-for-project-boards{% endif %}' + - '{% ifversion ghes %}/issues/organizing-your-work-with-project-boards/managing-project-boards/configuring-automation-for-project-boards{% endif %}' - /issues/planning-and-tracking-with-projects/automating-your-project/automating-projects-using-actions popular: - /issues/tracking-your-work-with-issues/about-issues @@ -26,7 +26,7 @@ featuredLinks: - /communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates - /issues/using-labels-and-milestones-to-track-work/managing-labels - /issues/tracking-your-work-with-issues/viewing-all-of-your-issues-and-pull-requests - - '{% ifversion ghes or ghae %}/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards{% endif %}' + - '{% ifversion ghes %}/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards{% endif %}' layout: product-landing beta_product: false versions: @@ -69,4 +69,3 @@ redirect_from: - /linking-a-pull-request-to-an-issue - /about-duplicate-issues-and-pull-requests --- - diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md index ea7a52d5fb..f74a5f1cca 100644 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md +++ b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md @@ -21,7 +21,7 @@ allowTitleToDifferFromFilename: true You can create notes within columns to serve as task reminders, references to issues and pull requests from any repository on {% data variables.location.product_location %}, or to add information related to the {% data variables.projects.projects_v1_board %}. You can create a reference card for another {% data variables.projects.projects_v1_board %} by adding a link to a note. If the note isn't sufficient for your needs, you can convert it to an issue. For more information on converting notes to issues, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board)." -Types of project boards: +Types of {% data variables.projects.projects_v1_boards %}: - **User-owned {% data variables.projects.projects_v1_board %}** can contain issues and pull requests from any personal repository. - **Organization-wide {% data variables.projects.projects_v1_board %}** can contain issues and pull requests from any repository that belongs to an organization. {% data reusables.project-management.link-repos-to-project-board %} For more information, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/linking-a-repository-to-a-project-board)." diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility.md index 16593291ad..b555058bb8 100644 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility.md +++ b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility.md @@ -25,7 +25,7 @@ allowTitleToDifferFromFilename: true {% endnote %} -1. Navigate to the project board you want to make {% ifversion ghae %}internal{% else %}public{% endif %} or private. +1. Navigate to the {% data variables.projects.projects_v1_board %} you want to make {% ifversion ghae %}internal{% else %}public{% endif %} or private. {% data reusables.project-management.click-menu %} {% data reusables.project-management.access-collaboration-settings %} {% data reusables.project-management.choose-visibility %} diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/copying-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/copying-a-project-board.md index 7a460d923b..73312a9cfb 100644 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/copying-a-project-board.md +++ b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/copying-a-project-board.md @@ -26,9 +26,9 @@ A {% data variables.projects.projects_v1_board %}'s automation is also enabled b {% data reusables.project-management.click-menu %} 1. Click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **Copy**. ![Screenshot showing a project menu. The copy option is highlighted with an orange outline.](/assets/images/help/projects/project-board-copy-setting.png) -1. Under "Owner", use the drop-down menu and click the repository or organization where you want to copy the project board. -1. Optionally, under "Project board name", type the name of the copied {% data variables.projects.projects_v1_board %}. -1. Optionally, under "Description", type a description of the copied project board that other people will see. +1. Under "Owner", use the drop-down menu and click the repository or organization where you want to copy the {% data variables.projects.projects_v1_board %}. +1. Optionally, under "{% data variables.projects.projects_v1_board_caps %} name", type the name of the copied {% data variables.projects.projects_v1_board %}. +1. Optionally, under "Description", type a description of the copied {% data variables.projects.projects_v1_board %} that other people will see. 1. Optionally, under "Automation settings", select whether you want to copy the configured automatic workflows. This option is enabled by default. For more information, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-automation-for-project-boards)." {% data reusables.project-management.choose-visibility %} 1. Click **Copy project**. diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board.md index 4dd563353b..aa3f90494c 100644 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board.md +++ b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/deleting-a-project-board.md @@ -24,7 +24,7 @@ allowTitleToDifferFromFilename: true {% data reusables.project-management.click-menu %} {% data reusables.project-management.click-edit-sidebar-menu-project-board %} 1. Click **Delete project**. -1. To confirm that you want to delete the project board, click **OK**. +1. To confirm that you want to delete the {% data variables.projects.projects_v1_board %}, click **OK**. ## Further reading diff --git a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md index 7bf3603a7a..0ef2165f11 100644 --- a/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md +++ b/content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board.md @@ -24,7 +24,7 @@ You can put a maximum of 2,500 cards into each project column. If a column has r {% note %} -**Note:** You can also add notes to your project board to serve as task reminders, references to issues and pull requests from any repository on {% data variables.product.product_name %}, or to add related information to your {% data variables.projects.projects_v1_board %}. For more information, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board)." +**Note:** You can also add notes to your {% data variables.projects.projects_v1_board %} to serve as task reminders, references to issues and pull requests from any repository on {% data variables.product.product_name %}, or to add related information to your {% data variables.projects.projects_v1_board %}. For more information, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-notes-to-a-project-board)." {% endnote %} diff --git a/content/issues/planning-and-tracking-with-projects/creating-projects/migrating-from-projects-classic.md b/content/issues/planning-and-tracking-with-projects/creating-projects/migrating-from-projects-classic.md index 9b07ac8a3a..8b6d309e8f 100644 --- a/content/issues/planning-and-tracking-with-projects/creating-projects/migrating-from-projects-classic.md +++ b/content/issues/planning-and-tracking-with-projects/creating-projects/migrating-from-projects-classic.md @@ -26,9 +26,9 @@ allowTitleToDifferFromFilename: true ## About project migration -You can migrate your project boards to the new {% data variables.product.prodname_projects_v2 %} experience and try out tables, multiple views, new automation options, and powerful field types. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." +You can migrate your {% data variables.projects.projects_v1_boards %} to the new {% data variables.product.prodname_projects_v2 %} experience and try out tables, multiple views, new automation options, and powerful field types. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." -## Migrating an organization project board +## Migrating an organization {% data variables.projects.projects_v1_board %} {% data reusables.projects.enable-migration %} {% data reusables.profile.access_org %} @@ -37,7 +37,7 @@ You can migrate your project boards to the new {% data variables.product.prodnam 1. In the left sidebar, click **Projects (classic)**. {% data reusables.projects.migrate-project-steps %} -## Migrating a user project board +## Migrating a user {% data variables.projects.projects_v1_board %} {% data reusables.projects.enable-migration %} 1. In the upper-right corner of {% data variables.product.prodname_dotcom_the_website %}, select your profile photo, then click **Your projects**. @@ -49,11 +49,11 @@ You can migrate your project boards to the new {% data variables.product.prodnam 1. Above the list of projects, click **Projects (classic)**. {% data reusables.projects.migrate-project-steps %} -## Migrating a repository project board +## Migrating a repository {% data variables.projects.projects_v1_board %} {% note %} -**Note:** {% data variables.projects.projects_v2_caps %} does not support repository level projects. When you migrate a repository project board, it will migrate to either the organization or personal account that owns the repository project, and the migrated project will be pinned to the original repository. +**Note:** {% data variables.projects.projects_v2_caps %} does not support repository level projects. When you migrate a repository {% data variables.projects.projects_v1_board %}, it will migrate to either the organization or personal account that owns the repository project, and the migrated project will be pinned to the original repository. {% endnote %} diff --git a/content/issues/planning-and-tracking-with-projects/index.md b/content/issues/planning-and-tracking-with-projects/index.md index 36d8794c99..c232de9adf 100644 --- a/content/issues/planning-and-tracking-with-projects/index.md +++ b/content/issues/planning-and-tracking-with-projects/index.md @@ -22,3 +22,7 @@ redirect_from: --- {% data reusables.projects.projects-beta %} + +A project is an adaptable collection of items that you can view as a table{% ifversion projects-v2-roadmaps %}, a kanban board, or a roadmap{% else %} or a kanban board{% endif %} and that stays up-to-date with {% data variables.product.company_short %} data. Your projects can track issues, pull requests, and ideas that you note down. + +You can create and customize multiple views by filtering, sorting, and grouping issues and pull requests,{% ifversion projects-v2-insights %} visualize work with configurable charts,{% endif %} and add custom fields to track metadata specific to your team. Rather than enforcing a specific methodology, a project provides flexible features you can customize to your team’s needs and processes. diff --git a/content/issues/planning-and-tracking-with-projects/learning-about-projects/best-practices-for-projects.md b/content/issues/planning-and-tracking-with-projects/learning-about-projects/best-practices-for-projects.md index c3c0533ceb..99be1f3e50 100644 --- a/content/issues/planning-and-tracking-with-projects/learning-about-projects/best-practices-for-projects.md +++ b/content/issues/planning-and-tracking-with-projects/learning-about-projects/best-practices-for-projects.md @@ -25,7 +25,7 @@ To track how smaller issues fit into the larger goal, use {% ifversion task-list Issues and pull requests include built-in features to let you easily communicate with your collaborators. Use @mentions to alert a person or entire team about a comment. Assign collaborators to issues to communicate responsibility. Link to related issues or pull requests to communicate how they are connected. -## Make use of the description and README +## Make use of the description{% ifversion projects-v2-status-updates %}, README, and status updates{% else %} and README{% endif %} Use your project's description and README to share information about the project. @@ -35,9 +35,13 @@ For example: - Describing the project views and how to use them. - Including relevant links and people to contact for more information. -Project READMEs support Markdown which allows you to use images and advanced formatting such as links, lists, and headers. +Project READMEs support Markdown which allows you to use images and advanced formatting such as links, lists, and headers. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project)." -For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project)." +{% ifversion projects-v2-status-updates %} + +You can also share high-level updates with other users of your project by posting status updates. Status updates allow you to mark the project with a status, such as "On track" or "At risk", set start and target dates, and share written updates with your team. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/sharing-project-updates)." + +{% endif %} ## Use views diff --git a/content/issues/planning-and-tracking-with-projects/learning-about-projects/index.md b/content/issues/planning-and-tracking-with-projects/learning-about-projects/index.md index e78511b6be..cd5f835d6c 100644 --- a/content/issues/planning-and-tracking-with-projects/learning-about-projects/index.md +++ b/content/issues/planning-and-tracking-with-projects/learning-about-projects/index.md @@ -11,5 +11,6 @@ children: - /quickstart-for-projects - /best-practices-for-projects - /finding-your-projects + - /sharing-project-updates allowTitleToDifferFromFilename: true --- diff --git a/content/issues/planning-and-tracking-with-projects/learning-about-projects/sharing-project-updates.md b/content/issues/planning-and-tracking-with-projects/learning-about-projects/sharing-project-updates.md new file mode 100644 index 0000000000..6d81815073 --- /dev/null +++ b/content/issues/planning-and-tracking-with-projects/learning-about-projects/sharing-project-updates.md @@ -0,0 +1,29 @@ +--- +title: 'Sharing {% data variables.projects.project_v2 %} updates' +intro: 'You can post updates to your {% data variables.projects.projects_v2 %} that share the current status, start date, and target date of the {% data variables.projects.project_v2 %} itself.' +allowTitleToDifferFromFilename: true +versions: + feature: projects-v2-status-updates +type: overview +permissions: 'Anyone with write access for a project can add a status update. Anyone with read access for a project can view status updates and subscribe.' +topics: + - Projects +--- + +## About status updates + +You can keep your team up to date and share high-level overviews, which people can use to determine the status of your project. You can set a status, such as "On track" or "At risk", to allow people to quickly determine the current state of the project. You can also set start dates and target dates. Your status update can also contain a message that supports formatting with Markdown. + +Status updates can be found on your project's side panel, below the description and README. You can read the most recent update at the top and the full history of updates beneath. Once you've added a status update, the current status is also shown in the project's header and in lists when you're browsing projects. + +## Adding new status updates + +You can add status updates to any project you have write access for. You can't add status updates to a project that is set as a template. When you start creating a new status update, the form will default to the previous update's status, start date, and target date. + +1. Navigate to your project. +1. In the top-right, click {% octicon "sidebar-expand" aria-label="Project details" %} to open the side panel. +1. Next to "Status updates", click **Add update**. +1. To change the status, click **Status**, and then select the status that best reflects the state of the project. +1. To change the dates shown in your status update, click either **Start date** or **Target date**, and select a new date. +1. Optionally, in the comment field, type a message to include in your status update. You can use Markdown to format your message. +1. Click **Save update**. diff --git a/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects.md b/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects.md index f92ec50f1c..cfba95efcd 100644 --- a/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects.md +++ b/content/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects.md @@ -10,7 +10,7 @@ type: tutorial topics: - Projects allowTitleToDifferFromFilename: true -permissions: Organization owners can manage the visibility of project boards in their organization. Organization owners can also allow collaborators with admin permissions to manage project visibility. Visibility of user projects can be managed by the owner of the project and collaborators with admin permissions. +permissions: Organization owners can manage the visibility of {% data variables.projects.projects_v1_boards %} in their organization. Organization owners can also allow collaborators with admin permissions to manage project visibility. Visibility of user projects can be managed by the owner of the project and collaborators with admin permissions. --- ## About project visibility diff --git a/content/issues/tracking-your-work-with-issues/about-issues.md b/content/issues/tracking-your-work-with-issues/about-issues.md index 3eaf5bd13c..c1341fdcfc 100644 --- a/content/issues/tracking-your-work-with-issues/about-issues.md +++ b/content/issues/tracking-your-work-with-issues/about-issues.md @@ -58,7 +58,7 @@ You can @mention collaborators who have access to your repository in an issue to ### Comparing issues and discussions -Some conversations are more suitable for {% data variables.product.prodname_discussions %}. {% data reusables.discussions.you-can-use-discussions %} For guidance on when to use an issue or a discussion, see "[AUTOTITLE](/get-started/quickstart/communicating-on-github)." +Some conversations are more suitable for {% data variables.product.prodname_discussions %}. {% data reusables.discussions.you-can-use-discussions %} For guidance on when to use an issue or a discussion, see "[AUTOTITLE](/get-started/using-github/communicating-on-github)." {% ifversion converting-issues-to-discussions %}When a conversation in an issue is better suited for a discussion, you can convert the issue to a discussion.{% endif %} {% endif %} diff --git a/content/issues/tracking-your-work-with-issues/creating-an-issue.md b/content/issues/tracking-your-work-with-issues/creating-an-issue.md index 7a9e6499d4..709eae733b 100644 --- a/content/issues/tracking-your-work-with-issues/creating-an-issue.md +++ b/content/issues/tracking-your-work-with-issues/creating-an-issue.md @@ -165,7 +165,7 @@ Query parameter | Example `labels` | `https://github.com/octo-org/octo-repo/issues/new?labels=help+wanted,bug` creates an issue with the labels "help wanted" and "bug". `milestone` | `https://github.com/octo-org/octo-repo/issues/new?milestone=testing+milestones` creates an issue with the milestone "testing milestones." `assignees` | `https://github.com/octo-org/octo-repo/issues/new?assignees=octocat` creates an issue and assigns it to @octocat. -`projects` | `https://github.com/octo-org/octo-repo/issues/new?title=Bug+fix&projects=octo-org/1` creates an issue with the title "Bug fix" and adds it to the organization's project board 1. {% ifversion projects-v2 and projects-v1 %}{% ifversion projects-in-issue-forms %}{% else %}Only {% data variables.projects.projects_v1_boards %} can currently be specified in URL queries.{% endif %}{% endif %} +`projects` | `https://github.com/octo-org/octo-repo/issues/new?title=Bug+fix&projects=octo-org/1` creates an issue with the title "Bug fix" and adds it to the organization's project 1. {% ifversion projects-v2 and projects-v1 %}{% ifversion projects-in-issue-forms %}{% else %}Only {% data variables.projects.projects_v1_boards %} can currently be specified in URL queries.{% endif %}{% endif %} `template` | `https://github.com/octo-org/octo-repo/issues/new?template=issue_template.md` creates an issue with a template in the issue body. The `template` query parameter works with templates stored in an `ISSUE_TEMPLATE` subdirectory within the root, `docs/` or `.github/` directory in a repository. For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests)." {% ifversion fpt or ghec %} diff --git a/content/issues/tracking-your-work-with-issues/planning-and-tracking-work-for-your-team-or-project.md b/content/issues/tracking-your-work-with-issues/planning-and-tracking-work-for-your-team-or-project.md index e3e11a5dd0..52f7e85693 100644 --- a/content/issues/tracking-your-work-with-issues/planning-and-tracking-work-for-your-team-or-project.md +++ b/content/issues/tracking-your-work-with-issues/planning-and-tracking-work-for-your-team-or-project.md @@ -13,9 +13,9 @@ topics: --- ## Introduction -You can use {% data variables.product.prodname_dotcom %} repositories, issues, project boards, and other tools to plan and track your work, whether working on an individual project or cross-functional team. +You can use {% data variables.product.prodname_dotcom %} repositories, issues, projects, and other tools to plan and track your work, whether working on an individual project or cross-functional team. -In this guide, you will learn how to create and set up a repository for collaborating with a group of people, create issue templates{% ifversion issue-forms %} and forms{% endif %}, open issues and use task lists to break down work, and establish a project board for organizing and tracking issues. +In this guide, you will learn how to create and set up a repository for collaborating with a group of people, create issue templates{% ifversion issue-forms %} and forms{% endif %}, open issues and use task lists to break down work, and establish a {% data variables.projects.projects_v1_board %} for organizing and tracking issues. ## Creating a repository @@ -88,7 +88,7 @@ Below we have added a task list to our Project Octocat issue, breaking it down i ## Making decisions as a team -You can use issues and discussions to communicate and make decisions as a team on planned improvements or priorities for your project. Issues are useful when you create them for discussion of specific details, such as bug or performance reports, planning for the next quarter, or design for a new initiative. Discussions are useful for open-ended brainstorming or feedback, outside the codebase and across repositories. For more information, see "[AUTOTITLE](/get-started/quickstart/communicating-on-github#which-discussion-tool-should-i-use)." +You can use issues and discussions to communicate and make decisions as a team on planned improvements or priorities for your project. Issues are useful when you create them for discussion of specific details, such as bug or performance reports, planning for the next quarter, or design for a new initiative. Discussions are useful for open-ended brainstorming or feedback, outside the codebase and across repositories. For more information, see "[AUTOTITLE](/get-started/using-github/communicating-on-github#which-discussion-tool-should-i-use)." As a team, you can also communicate updates on day-to-day tasks within issues so that everyone knows the status of work. For example, you can create an issue for a large feature that multiple people are working on, and each team member can add updates with their status or open questions in that issue. @@ -112,7 +112,7 @@ Below is an example of a `front-end` label that we created and added to the issu ![Screenshot of an issue called "Front-end work for Project Octocat." In the right sidebar, in the "Labels" section, the "front-end" label is applied.](/assets/images/help/issues/quickstart-add-label-to-issue.png) -## Adding issues to a project board +## Adding issues to a {% data variables.projects.projects_v1_board %} {% ifversion projects-v2 %} @@ -131,13 +131,13 @@ We can also view the same project as a board. {% endif %} {% ifversion projects-v1 %} -You can {% ifversion projects-v2 %} also use the existing{% else %} use{% endif %} {% data variables.product.prodname_projects_v1 %} on {% data variables.product.prodname_dotcom %} to plan and track your or your team's work. Project boards are made up of issues, pull requests, and notes that are categorized as cards in columns of your choosing. You can create project boards for feature work, high-level roadmaps, or even release checklists. For more information, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." +You can {% ifversion projects-v2 %} also use the existing{% else %} use{% endif %} {% data variables.product.prodname_projects_v1 %} on {% data variables.product.prodname_dotcom %} to plan and track your or your team's work. {% data variables.projects.projects_v1_boards_caps %} are made up of issues, pull requests, and notes that are categorized as cards in columns of your choosing. You can create {% data variables.projects.projects_v1_boards %} for feature work, high-level roadmaps, or even release checklists. For more information, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." -### Project board example +### {% data variables.projects.projects_v1_board_caps %} example -Below is a project board for our example Project Octocat with the issue we created, and the smaller issues we broke it down into, added to it. +Below is a {% data variables.projects.projects_v1_board %} for our example Project Octocat with the issue we created, and the smaller issues we broke it down into, added to it. -![Screenshot of a project board called "Project Octocat Board," with issues organized into columns for "To do", "In progress," and "Done."](/assets/images/help/issues/quickstart-project-board.png) +![Screenshot of a {% data variables.projects.projects_v1_board %} called "Project Octocat Board," with issues organized into columns for "To do", "In progress," and "Done."](/assets/images/help/issues/quickstart-project-board.png) {% endif %} @@ -152,4 +152,4 @@ You have now learned about the tools {% data variables.product.prodname_dotcom % - "[AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists)" for learning more about task lists{% endif %} {% ifversion projects-v2 %} - "[AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)" for learning more about projects - "[AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view)" for learning how to customize views for projects{% endif %} -{% ifversion projects-v1 %}- "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)" for learning how to manage project boards{% endif %} +{% ifversion projects-v1 %}- "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)" for learning how to manage {% data variables.projects.projects_v1_boards %}{% endif %} diff --git a/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md b/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md index fdada85eb6..f315d5e852 100644 --- a/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md +++ b/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md @@ -23,7 +23,7 @@ To transfer an open issue to another repository, you must have write access to t {% endnote %} -When you transfer an issue, comments and assignees are retained. Labels and milestones are also retained if they're present in the target repository, with labels matching by name and milestones matching by both name and due date. This issue will stay on any user-owned or organization-wide project boards and be removed from any repository project boards. For more information, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." +When you transfer an issue, comments and assignees are retained. Labels and milestones are also retained if they're present in the target repository, with labels matching by name and milestones matching by both name and due date. This issue will stay on any user-owned or organization-wide {% data variables.projects.projects_v1_boards %} and be removed from any repository {% data variables.projects.projects_v1_boards %}. For more information, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." People or teams who are mentioned in the issue will receive a notification letting them know that the issue has been transferred to a new repository. The original URL redirects to the new issue's URL. People who don't have read permissions in the new repository will see a banner letting them know that the issue has been transferred to a new repository that they can't access. diff --git a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github.md b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github.md index 7d8ceeda77..7acda639e1 100644 --- a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github.md +++ b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github.md @@ -11,7 +11,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' shortTitle: Local code --- @@ -92,7 +91,7 @@ Before you can add your local repository to {% data variables.product.prodname_d {% mac %} {% data reusables.migrations.create-empty-repo %} -1. At the top of your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}'s Quick Setup page, click {% octicon "copy" aria-label="Copy to clipboard" %} to copy the remote repository URL. +1. At the top of your repository on {% data variables.location.product_location %}'s Quick Setup page, click {% octicon "copy" aria-label="Copy to clipboard" %} to copy the remote repository URL. ![Screenshot of the "Quick Setup" header in a repository. Next to the remote URL, an icon of two overlapping squares is highlighted with an orange outline.](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) @@ -124,7 +123,7 @@ Before you can add your local repository to {% data variables.product.prodname_d {% windows %} {% data reusables.migrations.create-empty-repo %} -1. At the top of your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}'s Quick Setup page, click {% octicon "copy" aria-label="Copy to clipboard" %} to copy the remote repository URL. +1. At the top of your repository on {% data variables.location.product_location %}'s Quick Setup page, click {% octicon "copy" aria-label="Copy to clipboard" %} to copy the remote repository URL. ![Screenshot of the "Quick Setup" header in a repository. Next to the remote URL, an icon of two overlapping squares is highlighted with an orange outline.](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) {% data reusables.command_line.open_the_multi_os_terminal %} @@ -155,7 +154,7 @@ Before you can add your local repository to {% data variables.product.prodname_d {% linux %} {% data reusables.migrations.create-empty-repo %} -1. At the top of your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}'s Quick Setup page, click {% octicon "copy" aria-label="Copy to clipboard" %} to copy the remote repository URL. +1. At the top of your repository on {% data variables.location.product_location %}'s Quick Setup page, click {% octicon "copy" aria-label="Copy to clipboard" %} to copy the remote repository URL. ![Screenshot of the "Quick Setup" header in a repository. Next to the remote URL, an icon of two overlapping squares is highlighted with an orange outline.](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) {% data reusables.command_line.open_the_multi_os_terminal %} diff --git a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line.md b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line.md index 43c2241f60..3484c7871c 100644 --- a/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line.md +++ b/content/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line.md @@ -26,7 +26,7 @@ For purposes of demonstration, we'll use: - An external account named **extuser** - An external Git host named `https://external-host.com` - A {% data variables.product.product_name %} personal account named **ghuser** -- A repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} named **repo.git** +- A repository on {% data variables.location.product_location %} named **repo.git** {% endtip %} @@ -43,7 +43,7 @@ For purposes of demonstration, we'll use: ```shell $ cd REPO.git $ git push --mirror https://{% data variables.command_line.codeblock %}/USER/REPO.git - # Pushes the mirror to the new repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} + # Pushes the mirror to the new repository on {% data variables.location.product_location %} ``` 1. Remove the temporary local repository. diff --git a/content/migrations/overview/migration-paths-to-github.md b/content/migrations/overview/migration-paths-to-github.md index 646ecd1d5d..5ceffb5574 100644 --- a/content/migrations/overview/migration-paths-to-github.md +++ b/content/migrations/overview/migration-paths-to-github.md @@ -94,7 +94,7 @@ Migrations from {% data variables.product.prodname_dotcom_the_website %} include - **Tooling**: Git CLI or GitHub Importer - **More information**: - "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line)" - - "[AUTOTITLE]({% ifversion ghes or ghae %}/free-pro-team@latest{% endif %}/migrations/importing-source-code/using-github-importer/about-github-importer)" + - "[AUTOTITLE]({% ifversion ghes %}/free-pro-team@latest{% endif %}/migrations/importing-source-code/using-github-importer/about-github-importer)" ### Bitbucket Server or Bitbucket Data Center to {% data variables.product.prodname_dotcom_the_website %} @@ -122,7 +122,7 @@ Migrations from {% data variables.product.prodname_dotcom_the_website %} include - **Tooling**: Git CLI or GitHub Importer if the repository is accessible over the public internet - **More information**: - "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line)" - - "[AUTOTITLE]({% ifversion ghes or ghae %}/free-pro-team@latest{% endif %}/migrations/importing-source-code/using-github-importer/about-github-importer)" + - "[AUTOTITLE]({% ifversion ghes %}/free-pro-team@latest{% endif %}/migrations/importing-source-code/using-github-importer/about-github-importer)" ### Any Mercurial repository to {% data variables.product.prodname_dotcom_the_website %} diff --git a/content/migrations/using-ghe-migrator/about-ghe-migrator.md b/content/migrations/using-ghe-migrator/about-ghe-migrator.md index 25a2f17e00..0cb3e67ea2 100644 --- a/content/migrations/using-ghe-migrator/about-ghe-migrator.md +++ b/content/migrations/using-ghe-migrator/about-ghe-migrator.md @@ -46,7 +46,7 @@ The items in the table below can be migrated with a repository. Any items not sh | Wikis | All wiki data is migrated. | Teams | **@mentions** of teams are rewritten to match the target. | Milestones | Timestamps are preserved. -| {% data variables.product.prodname_projects_v1_caps %} boards | Project boards associated with the repository and with the organization that owns the repository are migrated. {% data variables.product.prodname_projects_v2 %}, the all-new projects experience, is not supported. +| {% data variables.product.prodname_projects_v1_caps %} boards | {% data variables.projects.projects_v1_boards_caps %} associated with the repository and with the organization that owns the repository are migrated. {% data variables.product.prodname_projects_v2 %}, the all-new projects experience, is not supported. | Issues | Issue references and timestamps are preserved. | Issue comments | Cross-references to comments are rewritten for the target instance. | Pull requests | Cross-references to pull requests are rewritten to match the target. Timestamps are preserved. diff --git a/content/migrations/using-ghe-migrator/migrating-data-to-github-enterprise-server.md b/content/migrations/using-ghe-migrator/migrating-data-to-github-enterprise-server.md index 700ae03c3f..2f24a0f9e4 100644 --- a/content/migrations/using-ghe-migrator/migrating-data-to-github-enterprise-server.md +++ b/content/migrations/using-ghe-migrator/migrating-data-to-github-enterprise-server.md @@ -195,7 +195,7 @@ The record types match those found in the [migrated data](/migrations/using-ghe- | Repositories | `repository` | Teams | `team` | Milestones | `milestone` -| Project boards | `project` +| {% data variables.projects.projects_v1_boards_caps %} | `project` | Issues | `issue` | Issue comments | `issue_comment` | Pull requests | `pull_request` diff --git a/content/migrations/using-github-enterprise-importer/migrating-between-github-products/overview-of-a-migration-between-github-products.md b/content/migrations/using-github-enterprise-importer/migrating-between-github-products/overview-of-a-migration-between-github-products.md index 6eba448ac7..c75826c1b1 100644 --- a/content/migrations/using-github-enterprise-importer/migrating-between-github-products/overview-of-a-migration-between-github-products.md +++ b/content/migrations/using-github-enterprise-importer/migrating-between-github-products/overview-of-a-migration-between-github-products.md @@ -177,9 +177,9 @@ If you were using {% data variables.actions.hosted_runner %}s, self-hosted runne - To use runners at the organization or enterprise level, update your workflows. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/using-self-hosted-runners-in-a-workflow)." 1. If you use {% data variables.actions.hosted_runner %}s, reconfigure your runners. - - Configure runner groups to control access to your runners. For more information, see "[AUTOTITLE]({% ifversion ghes or ghae %}/enterprise-cloud@latest{% endif %}/actions/using-github-hosted-runners/controlling-access-to-larger-runners)." - - Set up your {% data variables.actions.hosted_runner %}s. For more information, see "[AUTOTITLE]({% ifversion ghes or ghae %}/enterprise-cloud@latest{% endif %}/actions/using-github-hosted-runners/managing-larger-runners)." - - Update your workflows to point to your runners. For more information, see "[AUTOTITLE]({% ifversion ghes or ghae %}/enterprise-cloud@latest{% endif %}/actions/using-github-hosted-runners/running-jobs-on-larger-runners)." + - Configure runner groups to control access to your runners. For more information, see "[AUTOTITLE]({% ifversion ghes %}/enterprise-cloud@latest{% endif %}/actions/using-github-hosted-runners/controlling-access-to-larger-runners)." + - Set up your {% data variables.actions.hosted_runner %}s. For more information, see "[AUTOTITLE]({% ifversion ghes %}/enterprise-cloud@latest{% endif %}/actions/using-github-hosted-runners/managing-larger-runners)." + - Update your workflows to point to your runners. For more information, see "[AUTOTITLE]({% ifversion ghes %}/enterprise-cloud@latest{% endif %}/actions/using-github-hosted-runners/running-jobs-on-larger-runners)." 1. Re-add any encrypted secrets. - To use the browser, see "[AUTOTITLE](/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository)." diff --git a/content/organizations/collaborating-with-groups-in-organizations/about-organizations.md b/content/organizations/collaborating-with-groups-in-organizations/about-organizations.md index 2847a712d8..fb737563ff 100644 --- a/content/organizations/collaborating-with-groups-in-organizations/about-organizations.md +++ b/content/organizations/collaborating-with-groups-in-organizations/about-organizations.md @@ -20,7 +20,7 @@ topics: You can invite an unlimited number of people to join your organization, then give these organization members a variety of roles that grant different levels of access to the organization and its data. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." -In addition to managing access to the organization itself, you can separately manage access to your organization's repositories, project boards, and apps. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization)", "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization)", and "[AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization)." +In addition to managing access to the organization itself, you can separately manage access to your organization's repositories, projects, and apps. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization)", "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization)", and "[AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization)." To simplify access management and enhance collaboration, you can create nested teams that reflect your group's structure, with cascading access permissions and mentions. For more information, see "[AUTOTITLE](/organizations/organizing-members-into-teams/about-teams)." diff --git a/content/organizations/collaborating-with-groups-in-organizations/about-your-organizations-news-feed.md b/content/organizations/collaborating-with-groups-in-organizations/about-your-organizations-news-feed.md index 7de2eb7666..a9860c937d 100644 --- a/content/organizations/collaborating-with-groups-in-organizations/about-your-organizations-news-feed.md +++ b/content/organizations/collaborating-with-groups-in-organizations/about-your-organizations-news-feed.md @@ -30,7 +30,7 @@ An organization's news feed shows other people's activity on repositories owned ## Accessing your organization's news feed -1. {% data variables.product.signin_link %} to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}. +1. {% data variables.product.signin_link %} to your account on {% data variables.location.product_location %}. 1. Open your {% data reusables.user-settings.personal_dashboard %}. 1. In the upper-left corner of the page, select the dropdown menu that switches account context, then select an organization. diff --git a/content/organizations/collaborating-with-your-team/about-team-discussions.md b/content/organizations/collaborating-with-your-team/about-team-discussions.md index fc6d706537..9699a74c0a 100644 --- a/content/organizations/collaborating-with-your-team/about-team-discussions.md +++ b/content/organizations/collaborating-with-your-team/about-team-discussions.md @@ -48,7 +48,7 @@ You can also use organization discussions to facilitate conversations across you ## Further reading -- "[AUTOTITLE](/get-started/quickstart/communicating-on-github)" +- "[AUTOTITLE](/get-started/using-github/communicating-on-github)" - "[AUTOTITLE](/organizations/organizing-members-into-teams/about-teams)" - "[AUTOTITLE](/organizations/collaborating-with-your-team/creating-a-team-discussion)" - "[AUTOTITLE](/organizations/collaborating-with-your-team/editing-or-deleting-a-team-discussion)" diff --git a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md index bc01d164be..cf5e9b0418 100644 --- a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md @@ -8,7 +8,6 @@ redirect_from: versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Organizations @@ -77,7 +76,7 @@ To search for specific events, use the `action` qualifier in your query. Actions | `payment_method` | Contains all activities related to how your organization pays for GitHub.{% endif %}{% ifversion pat-v2%} | `personal_access_token` | Contains activities related to {% data variables.product.pat_v2 %}s in your organization. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)."{% endif %} | `profile_picture`| Contains all activities related to your organization's profile picture. -| `project` | Contains all activities related to project boards. +| `project` | Contains all activities related to {% data variables.projects.projects_v1_boards %}. | `protected_branch` | Contains all activities related to protected branches. | `repo` | Contains activities related to the repositories owned by your organization.{% ifversion fpt or ghec %} | `repository_advisory` | Contains repository-level activities related to security advisories in the {% data variables.product.prodname_advisory_database %}. For more information, see "[AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/about-repository-security-advisories)." diff --git a/content/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization.md b/content/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization.md index 7e2d1e355e..a0c2b6483e 100644 --- a/content/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization.md +++ b/content/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization.md @@ -27,9 +27,9 @@ There are three levels of permissions to a {% data variables.projects.projects_v Organization owners and people with admin permissions can give a person access to an organization {% data variables.projects.projects_v1_board %} individually, as an outside collaborator or organization member, or through their membership in a team or organization. An outside collaborator is someone who is not an organization member but given permissions to collaborate in your organization. Organization owners and people with admin permissions to a {% data variables.projects.projects_v1_board %} can also: -- Set default project board permissions for all organization members. -- Manage access to the project board for organization members, teams, and outside collaborators. For more information, see "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/managing-team-access-to-an-organization-project-board)", "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/managing-an-individuals-access-to-an-organization-project-board)", or "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/managing-access-to-a-project-board-for-organization-members)." -- Manage project board visibility. For more information, see "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/managing-access-to-a-project-board-for-organization-members)." +- Set default {% data variables.projects.projects_v1_board %} permissions for all organization members. +- Manage access to the {% data variables.projects.projects_v1_board %} for organization members, teams, and outside collaborators. For more information, see "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/managing-team-access-to-an-organization-project-board)", "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/managing-an-individuals-access-to-an-organization-project-board)", or "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/managing-access-to-a-project-board-for-organization-members)." +- Manage {% data variables.projects.projects_v1_board %} visibility. For more information, see "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/managing-access-to-a-project-board-for-organization-members)." ## Cascading permissions for {% data variables.projects.projects_v1_boards %} diff --git a/content/organizations/managing-organization-settings/deleting-an-organization-account.md b/content/organizations/managing-organization-settings/deleting-an-organization-account.md index 95f5f25c86..e13f3082fd 100644 --- a/content/organizations/managing-organization-settings/deleting-an-organization-account.md +++ b/content/organizations/managing-organization-settings/deleting-an-organization-account.md @@ -50,7 +50,7 @@ You can also archive an organization, instead of deleting it. Archiving an organ ## Backing up your organization content -{% ifversion not ghes %} After you delete an organization, {% data variables.product.company_short %} **cannot restore your content**. Therefore, before{% else %}Before{% endif %} you delete your organization, make sure you have a copy of all repositories, wikis, issues, and project boards from the account. +{% ifversion not ghes %} After you delete an organization, {% data variables.product.company_short %} **cannot restore your content**. Therefore, before{% else %}Before{% endif %} you delete your organization, make sure you have a copy of all repositories, wikis, issues, and projects from the account. {% ifversion ghes %} {% note %} diff --git a/content/organizations/managing-organization-settings/disabling-project-boards-in-your-organization.md b/content/organizations/managing-organization-settings/disabling-project-boards-in-your-organization.md index 51f94b5faa..6d1aa66585 100644 --- a/content/organizations/managing-organization-settings/disabling-project-boards-in-your-organization.md +++ b/content/organizations/managing-organization-settings/disabling-project-boards-in-your-organization.md @@ -1,6 +1,6 @@ --- -title: 'Disabling {% ifversion projects-v2 %}projects{% else %}project boards{% endif %} in your organization' -intro: 'Organization owners can turn off {% ifversion projects-v2 %}organization-wide {% data variables.projects.projects_v2 %}, organization-wide {% data variables.projects.projects_v1_boards %}, and repository-level {% data variables.projects.projects_v1_boards %}{% else %}organization-wide project boards and repository project boards{% endif %} in an organization.' +title: 'Disabling {% ifversion projects-v2 %}projects{% else %}{% data variables.projects.projects_v1_boards %}{% endif %} in your organization' +intro: 'Organization owners can turn off {% ifversion projects-v2 %}organization-wide {% data variables.projects.projects_v2 %}, organization-wide {% data variables.projects.projects_v1_boards %}, and repository-level {% data variables.projects.projects_v1_boards %}{% else %}organization-wide {% data variables.projects.projects_v1_boards %} and repository {% data variables.projects.projects_v1_boards %}{% endif %} in an organization.' redirect_from: - /github/managing-your-work-on-github/managing-project-boards/disabling-project-boards-in-your-organization - /articles/disabling-project-boards-in-your-organization @@ -21,7 +21,7 @@ After you disable organization-wide projects, it won’t be possible to create n After you disable repository-level {% data variables.projects.projects_v1_boards %} in an organization, it won't be possible to create new {% data variables.projects.projects_v1_boards %} in any repositories in the organization, and any existing {% data variables.projects.projects_v1_boards %} in repositories in the organization will become inaccessible at their previous URLs. {% data variables.projects.projects_v1_boards_caps %} at the organization level are not affected. -When {% data variables.projects.projects_v1_boards %} are disabled, you will no longer see project board information in timelines or [audit logs](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization). +When {% data variables.projects.projects_v1_boards %} are disabled, you will no longer see {% data variables.projects.projects_v1_board %} information in timelines or [audit logs](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization). {% endif %} @@ -47,8 +47,8 @@ You can control whether organization members can create {% data variables.projec {% data reusables.profile.org_settings %} 1. In the "Code planning, and automation" section of the sidebar, click **{% octicon "table" aria-label="The table icon" %} Projects**. 1. Decide whether to allow members to create {% data variables.projects.projects_v1_boards %} in repositories in your organization. Then, under **Projects (classic) only**: - - To enable project boards in repositories, select **Allow members to enable Projects (classic) for all repositories**. - - To disable project boards in repositories, unselect **Allow members to enable Projects (classic) for all repositories**. + - To enable {% data variables.projects.projects_v1_boards %} in repositories, select **Allow members to enable {% data variables.product.prodname_projects_v1_caps %} for all repositories**. + - To disable {% data variables.projects.projects_v1_boards %} in repositories, unselect **Allow members to enable {% data variables.product.prodname_projects_v1_caps %} for all repositories**. 1. Click **Save**. {% endif %} diff --git a/content/organizations/managing-organization-settings/integrating-jira-with-your-organization-project-board.md b/content/organizations/managing-organization-settings/integrating-jira-with-your-organization-project-board.md index 96644c2c90..e7bcf620a5 100644 --- a/content/organizations/managing-organization-settings/integrating-jira-with-your-organization-project-board.md +++ b/content/organizations/managing-organization-settings/integrating-jira-with-your-organization-project-board.md @@ -1,5 +1,5 @@ --- -title: Integrating Jira with your organization project board +title: 'Integrating Jira with your organization {% data variables.projects.projects_v1_board %}' intro: 'You can integrate Jira Cloud with your organization account to scan commits and pull requests, creating relevant metadata and hyperlinks in any mentioned Jira issues.' redirect_from: - /articles/integrating-jira-with-your-organization-project-board @@ -8,9 +8,10 @@ versions: ghes: '*' ghae: '*' shortTitle: Integrate Jira +allowTitleToDifferFromFilename: true --- -{% ifversion ghes or ghae %} +{% ifversion ghes %} {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} 1. In the left sidebar, select **{% octicon "code" aria-hidden="true" %} Developer settings**, then click **OAuth Apps**. diff --git a/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md index 0f7e16fa45..144586237d 100644 --- a/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md @@ -45,7 +45,7 @@ Organization owners have complete administrative access to your organization. Th ### Organization members -The default, non-administrative role for people in an organization is the organization member. By default, organization members have a number of permissions, including the ability to create repositories and project boards. +The default, non-administrative role for people in an organization is the organization member. By default, organization members have a number of permissions, including the ability to create repositories and projects. {% ifversion fpt or ghec %} @@ -112,7 +112,7 @@ Some of the features listed below are limited to organizations using {% data var | Delete the organization account, including all repositories | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | | Create teams (see "[AUTOTITLE](/organizations/managing-organization-settings/setting-team-creation-permissions-in-your-organization)") | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | | [Move teams in an organization's hierarchy](/organizations/organizing-members-into-teams/moving-a-team-in-your-organizations-hierarchy) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | -| Create project boards (see "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization)") | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | +| Create projects (see "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization)") | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | | See all organization members and teams | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | | @mention any visible team | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | | Can be made a _team maintainer_ | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |{% ifversion ghec %} @@ -186,7 +186,7 @@ Some of the features listed below are limited to organizations using {% data var | View the security overview for the organization (see "[AUTOTITLE](/code-security/security-overview/about-the-security-overview)") | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |{% endif %}{% ifversion ghes %} | Manage {% data variables.product.prodname_dependabot_security_updates %} (see "[AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates)") | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |{% endif %} | Manage an organization's SSH certificate authorities (see "[AUTOTITLE](/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities)") | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | -| Create project boards (see "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization)") | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |{% ifversion team-discussions %} +| Create {% data variables.projects.projects_v1_boards %} (see "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization)") | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |{% ifversion team-discussions %} | View and post public team discussions to **all teams** (see "[AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions)") | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | | View and post private team discussions to **all teams** (see "[AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions)") | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | | Edit and delete team discussions in **all teams** (for more information, see "[AUTOTITLE](/communities/moderating-comments-and-conversations/managing-disruptive-comments)) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} |{% endif %} @@ -233,7 +233,7 @@ Some of the features listed below are limited to organizations using {% data var | Can be made a _team maintainer_ | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | | Transfer repositories | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | | Manage an organization's SSH certificate authorities (see "[AUTOTITLE](/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities)") | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | -| Create project boards (see "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization)") | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} |{% ifversion team-discussions %} +| Create {% data variables.projects.projects_v1_boards %} (see "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization)") | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} |{% ifversion team-discussions %} | View and post public team discussions to **all teams** (see "[AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions)") | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | | View and post private team discussions to **all teams** (see "[AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions)") | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | | Edit and delete team discussions in **all teams** (for more information, see "[AUTOTITLE](/communities/moderating-comments-and-conversations/managing-disruptive-comments)) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} |{% endif %} diff --git a/content/organizations/managing-programmatic-access-to-your-organization/about-programmatic-access-in-your-organization.md b/content/organizations/managing-programmatic-access-to-your-organization/about-programmatic-access-in-your-organization.md index 15876f6132..8353fdd206 100644 --- a/content/organizations/managing-programmatic-access-to-your-organization/about-programmatic-access-in-your-organization.md +++ b/content/organizations/managing-programmatic-access-to-your-organization/about-programmatic-access-in-your-organization.md @@ -53,7 +53,7 @@ If their organization uses SAML, organization owners can see each {% data variab {% endif %} -{% ifversion ghes or ghae %} +{% ifversion ghes %} Site administrators can use the REST API to manage {% data variables.product.pat_generic %}s in their enterprise. For more information, see "[AUTOTITLE](/rest/enterprise-admin/users)" in the REST API documentation. diff --git a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization.md b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization.md index 11d3451601..f7e5525d4c 100644 --- a/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization.md +++ b/content/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization.md @@ -108,7 +108,7 @@ Some of the features listed below are limited to organizations using {% data var | [Delete and restore packages](/packages/learn-github-packages/deleting-and-restoring-a-package) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% endif %} | Manage [topics](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | | Enable wikis and restrict wiki editors | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | -| Enable project boards | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | +| Enable {% data variables.projects.projects_v1_boards %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | | Configure [pull request merges](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | | Configure [a publishing source for {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |{% ifversion copilot %} | View [content exclusion settings](/copilot/managing-copilot-business/configuring-content-exclusions-for-github-copilot) for {% data variables.product.prodname_copilot %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |{% endif %} diff --git a/content/packages/learn-github-packages/installing-a-package.md b/content/packages/learn-github-packages/installing-a-package.md index 5b5ec21aa0..8529be0bca 100644 --- a/content/packages/learn-github-packages/installing-a-package.md +++ b/content/packages/learn-github-packages/installing-a-package.md @@ -19,7 +19,7 @@ versions: ## About package installation -You can search on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} to find packages in {% data variables.product.prodname_registry %} that you can install in your own project. For more information, see "[AUTOTITLE](/search-github/searching-on-github/searching-for-packages)." +You can search on {% data variables.location.product_location %} to find packages in {% data variables.product.prodname_registry %} that you can install in your own project. For more information, see "[AUTOTITLE](/search-github/searching-on-github/searching-for-packages)." After you find a package, you can read the package's description and installation and usage instructions on the package page. diff --git a/content/packages/learn-github-packages/introduction-to-github-packages.md b/content/packages/learn-github-packages/introduction-to-github-packages.md index bb0fe232fa..2666957915 100644 --- a/content/packages/learn-github-packages/introduction-to-github-packages.md +++ b/content/packages/learn-github-packages/introduction-to-github-packages.md @@ -106,7 +106,7 @@ You can delete a package in the {% data variables.product.product_name %} user i When you use the GraphQL API to query and delete private packages, you must use the same {% data variables.product.pat_v1 %} you use to authenticate to {% data variables.product.prodname_registry %}. -For more information, see {% ifversion ghes or ghae %}"[AUTOTITLE](/packages/learn-github-packages/deleting-and-restoring-a-package)" and {% endif %}"[AUTOTITLE](/graphql/guides/forming-calls-with-graphql)." +For more information, see {% ifversion ghes %}"[AUTOTITLE](/packages/learn-github-packages/deleting-and-restoring-a-package)" and {% endif %}"[AUTOTITLE](/graphql/guides/forming-calls-with-graphql)." You can configure webhooks to subscribe to package-related events, such as when a package is published or updated. For more information, see the "[AUTOTITLE](/webhooks-and-events/webhooks/webhook-events-and-payloads#package)." diff --git a/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md b/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md index ff8a829a02..e14bd348e4 100644 --- a/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md +++ b/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md @@ -159,7 +159,7 @@ jobs: # This job publishes the package. `needs: run-npm-test` makes this job dependent on the `run-npm-test` job. build-and-push-image: runs-on: ubuntu-latest - needs: run-npm-test {% ifversion ghes or ghae %} + needs: run-npm-test {% ifversion ghes %} # Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job. permissions: contents: read diff --git a/content/packages/quickstart.md b/content/packages/quickstart.md index 6e5f820441..4b1156e121 100644 --- a/content/packages/quickstart.md +++ b/content/packages/quickstart.md @@ -22,7 +22,7 @@ In this guide, you'll create a {% data variables.product.prodname_actions %} wor 1. Clone the repository to your local machine. ```shell - git clone https://{% ifversion ghes or ghae %}YOUR-HOSTNAME{% else %}github.com{% endif %}/YOUR-USERNAME/YOUR-REPOSITORY.git + git clone https://{% ifversion ghes %}YOUR-HOSTNAME{% else %}github.com{% endif %}/YOUR-USERNAME/YOUR-REPOSITORY.git cd YOUR-REPOSITORY ``` @@ -40,7 +40,7 @@ In this guide, you'll create a {% data variables.product.prodname_actions %} wor package name: @YOUR-USERNAME/YOUR-REPOSITORY ... test command: exit 0 - ... + ... ``` 1. Run `npm install` to generate the `package-lock.json` file, then commit and push your changes to {% data variables.product.prodname_dotcom %}. @@ -53,7 +53,7 @@ In this guide, you'll create a {% data variables.product.prodname_actions %} wor ``` 1. Create a `.github/workflows` directory. In that directory, create a file named `release-package.yml`. -1. Copy the following YAML content into the `release-package.yml` file{% ifversion ghes or ghae %}, replacing `YOUR-HOSTNAME` with the name of your enterprise{% endif %}. +1. Copy the following YAML content into the `release-package.yml` file{% ifversion ghes %}, replacing `YOUR-HOSTNAME` with the name of your enterprise{% endif %}. ```yaml copy name: Node.js Package @@ -84,7 +84,7 @@ In this guide, you'll create a {% data variables.product.prodname_actions %} wor - uses: {% data reusables.actions.action-setup-node %} with: node-version: 16 - registry-url: {% ifversion ghes or ghae %}https://npm.YOUR-HOSTNAME.com/{% else %}https://npm.pkg.github.com/{% endif %} + registry-url: {% ifversion ghes %}https://npm.YOUR-HOSTNAME.com/{% else %}https://npm.pkg.github.com/{% endif %} - run: npm ci - run: npm publish env: diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md index a16d40e2b5..d26480405f 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md @@ -35,7 +35,7 @@ You can authenticate to {% data variables.product.prodname_registry %} with Apac In the `servers` tag, add a child `server` tag with an `id`, replacing USERNAME with your {% data variables.product.prodname_dotcom %} username, and TOKEN with your {% data variables.product.pat_generic %}. -In the `repositories` tag, configure a repository by mapping the `id` of the repository to the `id` you added in the `server` tag containing your credentials. Replace {% ifversion ghes or ghae %}HOSTNAME with the host name of {% data variables.location.product_location %}, and{% endif %} OWNER with the name of the personal account or organization that owns the repository. Because uppercase letters aren't supported, you must use lowercase letters for the repository owner even if the {% data variables.product.prodname_dotcom %} user or organization name contains uppercase letters. +In the `repositories` tag, configure a repository by mapping the `id` of the repository to the `id` you added in the `server` tag containing your credentials. Replace {% ifversion ghes %}HOSTNAME with the host name of {% data variables.location.product_location %}, and{% endif %} OWNER with the name of the personal account or organization that owns the repository. Because uppercase letters aren't supported, you must use lowercase letters for the repository owner even if the {% data variables.product.prodname_dotcom %} user or organization name contains uppercase letters. If you want to interact with multiple repositories, you can add each repository to separate `repository` children in the `repositories` tag, mapping the `id` of each to the credentials in the `servers` tag. @@ -136,7 +136,7 @@ If you would like to publish multiple packages to the same repository, you can i For more information on creating a package, see the [maven.apache.org documentation](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html). -1. Edit the `distributionManagement` element of the _pom.xml_ file located in your package directory, replacing {% ifversion ghes or ghae %}HOSTNAME with the host name of {% data variables.location.product_location %}, {% endif %}`OWNER` with the name of the personal account or organization that owns the repository and `REPOSITORY` with the name of the repository containing your project.{% ifversion ghes %} +1. Edit the `distributionManagement` element of the _pom.xml_ file located in your package directory, replacing {% ifversion ghes %}HOSTNAME with the host name of {% data variables.location.product_location %}, {% endif %}`OWNER` with the name of the personal account or organization that owns the repository and `REPOSITORY` with the name of the repository containing your project.{% ifversion ghes %} If your instance has subdomain isolation enabled:{% endif %} diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md index 105e3060de..e698fdd6be 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md @@ -60,7 +60,7 @@ cat ~/TOKEN.txt | docker login https://docker.pkg.github.com -u USERNAME --passw {% endraw %} {% endif %} -{% ifversion ghes or ghae %} +{% ifversion ghes %} {% ifversion ghes %} If your instance has subdomain isolation enabled: {% endif %} @@ -85,7 +85,7 @@ cat ~/TOKEN.txt | docker login HOSTNAME -u USERNAME --password-stdin {% endif %} -To use this example login command, replace `USERNAME` with your {% data variables.product.product_name %} username{% ifversion ghes or ghae %}, `HOSTNAME` with the URL for {% data variables.location.product_location %},{% endif %} and `~/TOKEN.txt` with the file path to your {% data variables.product.pat_generic %} for {% data variables.product.product_name %}. +To use this example login command, replace `USERNAME` with your {% data variables.product.product_name %} username{% ifversion ghes %}, `HOSTNAME` with the URL for {% data variables.location.product_location %},{% endif %} and `~/TOKEN.txt` with the file path to your {% data variables.product.pat_generic %} for {% data variables.product.product_name %}. For more information, see "[Docker login](https://docs.docker.com/engine/reference/commandline/login/#provide-a-password-using-stdin)." @@ -112,7 +112,7 @@ For more information, see "[Docker login](https://docs.docker.com/engine/referen > IMAGE_NAME VERSION IMAGE_ID 4 weeks ago 1.11MB ``` -1. Using the Docker image ID, tag the docker image, replacing OWNER with the name of the personal account or organization that owns the repository, REPOSITORY with the name of the repository containing your project, IMAGE_NAME with name of the package or image,{% ifversion ghes or ghae %} HOSTNAME with the hostname of {% data variables.location.product_location %},{% endif %} and VERSION with package version at build time. +1. Using the Docker image ID, tag the docker image, replacing OWNER with the name of the personal account or organization that owns the repository, REPOSITORY with the name of the repository containing your project, IMAGE_NAME with name of the package or image,{% ifversion ghes %} HOSTNAME with the hostname of {% data variables.location.product_location %},{% endif %} and VERSION with package version at build time. {% ifversion fpt or ghec %} ```shell @@ -137,7 +137,7 @@ For more information, see "[Docker login](https://docs.docker.com/engine/referen {% endif %} {% endif %} -1. If you haven't already built a docker image for the package, build the image, replacing OWNER with the name of the personal account or organization that owns the repository, REPOSITORY with the name of the repository containing your project, IMAGE_NAME with name of the package or image, VERSION with package version at build time,{% ifversion ghes or ghae %} HOSTNAME with the hostname of {% data variables.location.product_location %},{% endif %} and PATH to the image if it isn't in the current working directory. +1. If you haven't already built a docker image for the package, build the image, replacing OWNER with the name of the personal account or organization that owns the repository, REPOSITORY with the name of the repository containing your project, IMAGE_NAME with name of the package or image, VERSION with package version at build time,{% ifversion ghes %} HOSTNAME with the hostname of {% data variables.location.product_location %},{% endif %} and PATH to the image if it isn't in the current working directory. {% ifversion fpt or ghec %} ```shell @@ -263,7 +263,7 @@ $ docker push docker.HOSTNAME/octocat/octo-app/monalisa:1.0 {% data reusables.package_registry.docker_registry_deprecation_status %} -You can use the `docker pull` command to install a docker image from {% data variables.product.prodname_registry %}, replacing OWNER with the name of the personal account or organization that owns the repository, REPOSITORY with the name of the repository containing your project, IMAGE_NAME with name of the package or image,{% ifversion ghes or ghae %} HOSTNAME with the host name of {% data variables.location.product_location %}, {% endif %} and TAG_NAME with tag for the image you want to install. +You can use the `docker pull` command to install a docker image from {% data variables.product.prodname_registry %}, replacing OWNER with the name of the personal account or organization that owns the repository, REPOSITORY with the name of the repository containing your project, IMAGE_NAME with name of the package or image,{% ifversion ghes %} HOSTNAME with the host name of {% data variables.location.product_location %}, {% endif %} and TAG_NAME with tag for the image you want to install. {% ifversion fpt or ghec %} diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md index c3e202bbf9..3b43c3324b 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md @@ -28,9 +28,9 @@ shortTitle: npm registry 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. -In the future, to improve performance of the service, you won't be able to publish more than 1,000 versions of a package on {% data variables.product.prodname_dotcom %}. Any versions published before hitting this limit will still be readable. +In the future, to improve the performance of the service, you won't be able to publish more than 1,000 versions of a package on {% data variables.product.prodname_dotcom %}. Any versions published before hitting this limit will still be readable. -If you reach this limit, consider deleting package versions or contact Support for help. When this limit is enforced, our documentation will be updated with a way to work around this limit. For more information, see "[AUTOTITLE](/packages/learn-github-packages/deleting-and-restoring-a-package)" or "[AUTOTITLE](/packages/learn-github-packages/introduction-to-github-packages#contacting-support)." +If you reach this limit, consider deleting package versions or contacting support for help. When this limit is enforced, our documentation will be updated with a way to work around it. For more information, see "[AUTOTITLE](/packages/learn-github-packages/deleting-and-restoring-a-package)" or "[AUTOTITLE](/packages/learn-github-packages/introduction-to-github-packages#contacting-support)." {% endif %} ## Authenticating to {% data variables.product.prodname_registry %} @@ -52,7 +52,7 @@ This registry supports granular permissions. {% data reusables.package_registry. You can authenticate to {% data variables.product.prodname_registry %} with npm by either editing your per-user _~/.npmrc_ file to include your {% data variables.product.pat_v1 %} or by logging in to npm on the command line using your username and {% data variables.product.pat_generic %}. -To authenticate by adding your {% data variables.product.pat_v1 %} to your _~/.npmrc_ file, edit the _~/.npmrc_ file for your project to include the following line, replacing {% ifversion ghes or ghae %}HOSTNAME with the host name of {% data variables.location.product_location %} and {% endif %}TOKEN with your {% data variables.product.pat_generic %}. Create a new _~/.npmrc_ file if one doesn't exist. +To authenticate by adding your {% data variables.product.pat_v1 %} to your _~/.npmrc_ file, edit the _~/.npmrc_ file for your project to include the following line, replacing {% ifversion ghes %}HOSTNAME with the host name of {% data variables.location.product_location %} and {% endif %}TOKEN with your {% data variables.product.pat_generic %}. Create a new _~/.npmrc_ file if one doesn't exist. {% ifversion ghes %} If your instance has subdomain isolation enabled: @@ -142,7 +142,7 @@ You can use an _.npmrc_ file to configure the scope mapping for your project. In {% data reusables.package_registry.authenticate-step %} {% data reusables.package_registry.create-npmrc-owner-step %} {% data reusables.package_registry.add-npmrc-to-repo-step %} -1. Verify the name of your package in your project's `package.json`. The `name` field must contain the scope and the name of the package. For example, if your package is called "test", and you are publishing to the "My-org" {% data variables.product.prodname_dotcom %} organization, the `name` field in your `package.json` should be `@my-org/test`. +1. Verify the name of your package in your project's `package.json`. The `name` field must contain the scope and the name of the package. For example, if your package is called "test", and you are publishing it to the "My-org" {% data variables.product.prodname_dotcom %} organization, the `name` field in your `package.json` should be `@my-org/test`. {% data reusables.package_registry.verify_repository_field %} {% data reusables.package_registry.publish_package %} @@ -225,7 +225,7 @@ By default, you can only use npm packages hosted on your enterprise, and you wil ### Installing packages from other organizations -By default, you can only use {% data variables.product.prodname_registry %} packages from one organization. If you'd like to route package requests to multiple organizations and users, you can add additional lines to your _.npmrc_ file, replacing {% ifversion ghes or ghae %}`HOSTNAME` with the host name of {% data variables.location.product_location %} and {% endif %}`NAMESPACE` with the name of the personal account or organization {% ifversion packages-npm-v2 %}to which the package is scoped{% else %}that owns the repository containing the project{% endif %}. +By default, you can only use {% data variables.product.prodname_registry %} packages from one organization. If you'd like to route package requests to multiple organizations and users, you can add additional lines to your _.npmrc_ file, replacing {% ifversion ghes %}`HOSTNAME` with the host name of {% data variables.location.product_location %} and {% endif %}`NAMESPACE` with the name of the personal account or organization {% ifversion packages-npm-v2 %}to which the package is scoped{% else %}that owns the repository containing the project{% endif %}. {% ifversion ghes %} If your instance has subdomain isolation enabled: diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md index 7ba4c73f00..dffc013b7e 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md @@ -58,7 +58,7 @@ To authenticate to {% data variables.product.prodname_registry %} with the `dotn You must replace: - `USERNAME` with the name of your personal account on {% data variables.product.prodname_dotcom %}. - `TOKEN` with your {% data variables.product.pat_v1 %}. -- `NAMESPACE` with the name of the personal account or organization {% ifversion packages-nuget-v2 %}to which your packages are scoped{% else %}that owns the repository where your packages are hosted{% endif %}.{% ifversion ghes or ghae %} +- `NAMESPACE` with the name of the personal account or organization {% ifversion packages-nuget-v2 %}to which your packages are scoped{% else %}that owns the repository where your packages are hosted{% endif %}.{% ifversion ghes %} - `HOSTNAME` with the host name for {% data variables.location.product_location %}.{% endif %} {% ifversion ghes %}If your instance has subdomain isolation enabled: @@ -117,7 +117,7 @@ If you specify a `RepositoryURL` in your `nuget.config` file, the published pack ### Publishing a package using a GitHub {% data variables.product.pat_generic %} as your API key -If you don't already have a {% data variables.product.pat_generic %} to use for your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." +If you don't already have a {% data variables.product.pat_generic %} to use for your account on {% data variables.location.product_location %}, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." 1. Create a new project. Replace `PROJECT_NAME` with the name you'd like to give the project. @@ -156,7 +156,7 @@ When publishing, {% ifversion packages-nuget-v2 %}if you are linking your packag - `1.0.0` with the version number of the package. - `OWNER` with the name of the personal account or organization that owns the repository to which you want to {% ifversion packages-nuget-v2 %}link your package{% else %}publish your package{% endif %}. - - `REPOSITORY` with the name of the repository to which you want to connect your package.{% ifversion ghes or ghae %} + - `REPOSITORY` with the name of the repository to which you want to connect your package.{% ifversion ghes %} - `HOSTNAME` with the host name for {% data variables.location.product_location %}.{% endif %} ``` xml diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md index 3d2de53666..c11e09540d 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md @@ -132,7 +132,7 @@ For information on linking a published package with a repository, see "[AUTOTITL ## Publishing multiple packages to the same repository -To publish multiple gems to the same repository, you can include the URL to the {% data variables.product.prodname_dotcom %} repository in the `github_repo` field in `gem.metadata`. If you include this field, {% data variables.product.prodname_dotcom %} matches the repository based on this value, instead of using the gem name.{% ifversion ghes or ghae %} Replace HOSTNAME with the host name of {% data variables.location.product_location %}.{% endif %} +To publish multiple gems to the same repository, you can include the URL to the {% data variables.product.prodname_dotcom %} repository in the `github_repo` field in `gem.metadata`. If you include this field, {% data variables.product.prodname_dotcom %} matches the repository based on this value, instead of using the gem name.{% ifversion ghes %} Replace HOSTNAME with the host name of {% data variables.location.product_location %}.{% endif %} ```ruby gem.metadata = { "github_repo" => "ssh://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/OWNER/REPOSITORY" } diff --git a/content/pages/getting-started-with-github-pages/about-github-pages.md b/content/pages/getting-started-with-github-pages/about-github-pages.md index f6512a1217..bc7698e536 100644 --- a/content/pages/getting-started-with-github-pages/about-github-pages.md +++ b/content/pages/getting-started-with-github-pages/about-github-pages.md @@ -1,6 +1,6 @@ --- title: About GitHub Pages -intro: 'You can use {% data variables.product.prodname_pages %} to host a website about yourself, your organization, or your project directly from a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}.' +intro: 'You can use {% data variables.product.prodname_pages %} to host a website about yourself, your organization, or your project directly from a repository on {% data variables.location.product_location %}.' redirect_from: - /articles/what-are-github-pages - /articles/what-is-github-pages @@ -14,7 +14,6 @@ product: '{% data reusables.gated-features.pages %}' versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - Pages @@ -40,11 +39,11 @@ Organization owners can disable the publication of {% data variables.product.pro ## Types of {% data variables.product.prodname_pages %} sites -There are three types of {% data variables.product.prodname_pages %} sites: project, user, and organization. Project sites are connected to a specific project hosted on {% data variables.product.product_name %}, such as a JavaScript library or a recipe collection. User and organization sites are connected to a specific account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}. +There are three types of {% data variables.product.prodname_pages %} sites: project, user, and organization. Project sites are connected to a specific project hosted on {% data variables.product.product_name %}, such as a JavaScript library or a recipe collection. User and organization sites are connected to a specific account on {% data variables.location.product_location %}. -To publish a user site, you must create a repository owned by your personal account that's named {% ifversion fpt or ghec %}`.github.io`{% else %}`.`{% endif %}. To publish an organization site, you must create a repository owned by an organization that's named {% ifversion fpt or ghec %}`.github.io`{% else %}`.`{% endif %}. {% ifversion fpt or ghec %}Unless you're using a custom domain, user and organization sites are available at `http(s)://.github.io` or `http(s)://.github.io`.{% elsif ghae %}User and organization sites are available at `http(s)://pages./` or `http(s)://pages./`.{% endif %} +To publish a user site, you must create a repository owned by your personal account that's named {% ifversion fpt or ghec %}`.github.io`{% else %}`.`{% endif %}. To publish an organization site, you must create a repository owned by an organization that's named {% ifversion fpt or ghec %}`.github.io`{% else %}`.`{% endif %}. {% ifversion fpt or ghec %}Unless you're using a custom domain, user and organization sites are available at `http(s)://.github.io` or `http(s)://.github.io`.{% endif %} -The source files for a project site are stored in the same repository as their project. {% ifversion fpt or ghec %}Unless you're using a custom domain, project sites are available at `http(s)://.github.io/` or `http(s)://.github.io/`.{% elsif ghae %}Project sites are available at `http(s)://pages.///` or `http(s)://pages.///`.{% endif %} +The source files for a project site are stored in the same repository as their project. {% ifversion fpt or ghec %}Unless you're using a custom domain, project sites are available at `http(s)://.github.io/` or `http(s)://.github.io/`.{% endif %} {% ifversion ghec %} If you publish your site privately, the URL for your site will be different. For more information, see "[AUTOTITLE](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site)." diff --git a/content/pages/index.md b/content/pages/index.md index 248ed26cd1..c6a0f02835 100644 --- a/content/pages/index.md +++ b/content/pages/index.md @@ -1,7 +1,7 @@ --- title: "{% data variables.product.prodname_pages %} documentation" shortTitle: "{% data variables.product.prodname_pages %}" -intro: 'Learn how to create a website directly from a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}. Explore website building tools like Jekyll and troubleshoot issues with your {% data variables.product.prodname_pages %} site.' +intro: 'Learn how to create a website directly from a repository on {% data variables.location.product_location %}. Explore website building tools like Jekyll and troubleshoot issues with your {% data variables.product.prodname_pages %} site.' introLinks: quickstart: /pages/quickstart overview: /pages/getting-started-with-github-pages/about-github-pages @@ -10,17 +10,17 @@ featuredLinks: - /pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site - /pages/getting-started-with-github-pages/creating-a-github-pages-site - '{% ifversion fpt or ghec %}/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site{% endif %}' - - '{% ifversion ghes or ghae %}/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll{% endif %}' + - '{% ifversion ghes %}/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll{% endif %}' - '{% ifversion ghec %}/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site{% endif %}' - - '{% ifversion ghes or ghae %}/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll{% endif %}' + - '{% ifversion ghes %}/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll{% endif %}' popular: - '{% ifversion fpt or ghec %}/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages{% endif %}' - /pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll - '{% ifversion fpt or ghec %}/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages{% endif %}' - '{% ifversion fpt or ghec %}/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https{% endif %}' - - '{% ifversion ghes or ghae %}/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site{% endif %}' - - '{% ifversion ghes or ghae %}/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll{% endif %}' - - '{% ifversion ghes or ghae %}/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll{% endif %}' + - '{% ifversion ghes %}/pages/getting-started-with-github-pages/unpublishing-a-github-pages-site{% endif %}' + - '{% ifversion ghes %}/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll{% endif %}' + - '{% ifversion ghes %}/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll{% endif %}' guideCards: - /pages/getting-started-with-github-pages/creating-a-custom-404-page-for-your-github-pages-site - /pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md index f4512db255..f8945450c3 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md @@ -20,7 +20,7 @@ shortTitle: Create site with Jekyll ## Prerequisites -Before you can use Jekyll to create a {% data variables.product.prodname_pages %} site, you must install Jekyll and Git. For more information, see [Installation](https://jekyllrb.com/docs/installation/) in the Jekyll documentation and "[AUTOTITLE](/get-started/quickstart/set-up-git)." +Before you can use Jekyll to create a {% data variables.product.prodname_pages %} site, you must install Jekyll and Git. For more information, see [Installation](https://jekyllrb.com/docs/installation/) in the Jekyll documentation and "[AUTOTITLE](/get-started/getting-started-with-git/set-up-git)." {% data reusables.pages.recommend-bundler %} @@ -119,7 +119,7 @@ Before you can use Jekyll to create a {% data variables.product.prodname_pages % git commit -m 'Initial GitHub pages site with Jekyll' ``` -1. Add your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} as a remote, replacing {% ifversion ghes or ghae %}HOSTNAME with your enterprise's hostname,{% endif %} USER with the account that owns the repository{% ifversion ghes or ghae %},{% endif %} and REPOSITORY with the name of the repository. +1. Add your repository on {% data variables.location.product_location %} as a remote, replacing {% ifversion ghes %}HOSTNAME with your enterprise's hostname,{% endif %} USER with the account that owns the repository{% ifversion ghes %},{% endif %} and REPOSITORY with the name of the repository. ```shell {% ifversion fpt or ghec %} diff --git a/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md b/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md index 737e61d1a3..d5b51c28b4 100644 --- a/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md +++ b/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github.md @@ -18,7 +18,7 @@ shortTitle: Resolve merge conflicts --- You can only resolve merge conflicts on {% data variables.product.product_name %} that are caused by competing line changes, such as when people make different changes to the same line of the same file on different branches in your Git repository. For all other types of merge conflicts, you must resolve the conflict locally on the command line. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line)." -{% ifversion ghes or ghae %} +{% ifversion ghes %} If a site administrator disables the merge conflict editor for pull requests between repositories, you cannot use the conflict editor on {% data variables.product.product_name %} and must resolve merge conflicts on the command line. For example, if the merge conflict editor is disabled, you cannot use it on a pull request between a fork and upstream repository. {% endif %} @@ -36,7 +36,7 @@ If a site administrator disables the merge conflict editor for pull requests bet {% note %} - **Note:** If the **Resolve conflicts** button is deactivated, your pull request's merge conflict is too complex to resolve on {% data variables.product.product_name %}{% ifversion ghes or ghae %} or the site administrator has disabled the conflict editor for pull requests between repositories{% endif %}. You must resolve the merge conflict using an alternative Git client, or by using Git on the command line. For more information see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line)." + **Note:** If the **Resolve conflicts** button is deactivated, your pull request's merge conflict is too complex to resolve on {% data variables.product.product_name %}{% ifversion ghes %} or the site administrator has disabled the conflict editor for pull requests between repositories{% endif %}. You must resolve the merge conflict using an alternative Git client, or by using Git on the command line. For more information see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line)." {% endnote %} diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/using-query-parameters-to-create-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/using-query-parameters-to-create-a-pull-request.md index b80f22d39d..c95975b0d4 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/using-query-parameters-to-create-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/using-query-parameters-to-create-a-pull-request.md @@ -32,5 +32,5 @@ Query parameter | Example `labels` | `https://github.com/octo-org/octo-repo/compare/main...my-branch?quick_pull=1&labels=help+wanted,bug` creates a pull request with the labels "help wanted" and "bug". `milestone` | `https://github.com/octo-org/octo-repo/compare/main...my-branch?quick_pull=1&milestone=testing+milestones` creates a pull request with the milestone "testing milestones." `assignees` | `https://github.com/octo-org/octo-repo/compare/main...my-branch?quick_pull=1&assignees=octocat` creates a pull request and assigns it to @octocat. -`projects` | `https://github.com/octo-org/octo-repo/compare/main...my-branch?quick_pull=1&title=Bug+fix&projects=octo-org/1` creates a pull request with the title "Bug fix" and adds it to the organization's project board 1. +`projects` | `https://github.com/octo-org/octo-repo/compare/main...my-branch?quick_pull=1&title=Bug+fix&projects=octo-org/1` creates a pull request with the title "Bug fix" and adds it to the organization's project 1. `template` | `https://github.com/octo-org/octo-repo/compare/main...my-branch?quick_pull=1&template=issue_template.md` creates a pull request with a template in the pull request body. The `template` query parameter works with templates stored in a `PULL_REQUEST_TEMPLATE` subdirectory within the root, `docs/` or `.github/` directory in a repository. For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests)." diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/detaching-a-fork.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/detaching-a-fork.md index 63421ed482..f079965a50 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/detaching-a-fork.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/detaching-a-fork.md @@ -5,13 +5,25 @@ versions: fpt: '*' ghes: '*' ghec: '*' - ghae: '*' topics: - Pull requests permissions: People with admin access for a forked repository can delete the forked repository. --- -To turn your fork into a standalone repository, you can clone the fork, use the clone to create a new repository, and then delete the fork. The new repository will no longer automatically sync with changes from the original repository. This is useful when you want to take the work you are doing in a different direction or maintain distinct versions. +## About detaching forks + +To turn your fork into a standalone repository, you can clone the fork, use the clone to create a new repository, and then delete the fork. This is useful when you want to take the work you are doing in a different direction or maintain distinct versions. + +The new repository will no longer automatically sync with changes from the original repository. + +{% note %} + +**Notes:** + +- The new repository will not retain any of its issues, pull requests, wikis, stars, watchers, comments, child forks, or other metadata that may currently be associated with your current fork. +- All commit metadata will be preserved. Commits may become eligible to be counted as contributions, if they meet certain criteria. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile#your-local-git-commit-email-isnt-connected-to-your-account)." + +{% endnote %} {% ifversion ghes %} diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo.md index cdc1fc4447..34ada22ea9 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo.md @@ -49,7 +49,7 @@ When creating your public repository from a fork of someone's project, make sure ## Prerequisites -If you haven't yet, first set up Git and authentication with {% data variables.location.product_location %} from Git. For more information, see "[AUTOTITLE](/get-started/quickstart/set-up-git)." +If you haven't yet, first set up Git and authentication with {% data variables.location.product_location %} from Git. For more information, see "[AUTOTITLE](/get-started/getting-started-with-git/set-up-git)." ## Forking a repository @@ -234,6 +234,11 @@ Fork a repository to start contributing to a project. {% data reusables.reposito You have now forked a repository, practiced cloning your fork, and configured an upstream repository. +<<<<<<< HEAD:content/get-started/quickstart/fork-a-repo.md +- For more information about cloning the fork and syncing the changes in a forked repository from your computer, see "[AUTOTITLE](/get-started/getting-started-with-git/set-up-git)." + +======= +>>>>>>> main:content/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo.md - You can also create a new repository where you can put all your projects and share the code on {% data variables.product.prodname_dotcom %}. {% data reusables.getting-started.create-a-repository %}" - {% data reusables.getting-started.being-social %} diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md index 4d72b3983a..e9c50a3c0f 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md @@ -42,7 +42,7 @@ If a public repository is made private, its public forks are split off into a ne In other words, a public repository's forks will remain public in their own separate repository network even after the upstream repository is made private. This allows the fork owners to continue to work and collaborate without interruption. If public forks were not moved into a separate network in this way, the owners of those forks would need to get the appropriate [access permissions](/get-started/learning-about-github/access-permissions-on-github) to pull changes from and submit pull requests to the (now private) upstream repository—even though they didn't need those permissions before. -{% ifversion ghes or ghae %} +{% ifversion ghes %} If a public repository has anonymous Git read access enabled and the repository is made private, all of the repository's forks will lose anonymous Git read access and return to the default disabled setting. If a forked repository is made public, repository administrators can re-enable anonymous Git read access. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository)." {% endif %} diff --git a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md index f5f8243981..a111e58803 100644 --- a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md +++ b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md @@ -1,6 +1,6 @@ --- title: Creating a commit with multiple authors -intro: 'You can attribute a commit to more than one author by adding one or more `Co-authored-by` trailers to the commit''s message. Co-authored commits are visible on {% data variables.product.product_name %}{% ifversion ghes or ghae %} and can be included in the profile contributions graph and the repository''s statistics{% endif %}.' +intro: 'You can attribute a commit to more than one author by adding one or more `Co-authored-by` trailers to the commit''s message. Co-authored commits are visible on {% data variables.product.product_name %}{% ifversion ghes %} and can be included in the profile contributions graph and the repository''s statistics{% endif %}.' redirect_from: - /articles/creating-a-commit-with-multiple-authors - /github/committing-changes-to-your-project/creating-a-commit-with-multiple-authors @@ -14,7 +14,7 @@ shortTitle: With multiple authors --- ## Required co-author information -Before you can add a co-author to a commit, you must know the appropriate email to use for each co-author. For the co-author's commit to count as a contribution, you must use the email associated with their account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}. +Before you can add a co-author to a commit, you must know the appropriate email to use for each co-author. For the co-author's commit to count as a contribution, you must use the email associated with their account on {% data variables.location.product_location %}. {% ifversion fpt or ghec %} @@ -82,7 +82,7 @@ The new commit and message will appear on {% data variables.location.product_loc ## Further reading -{% ifversion ghes or ghae %} +{% ifversion ghes %} - "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile)" - "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile)"{% endif %} - "[AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors)" diff --git a/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/why-are-my-commits-linked-to-the-wrong-user.md b/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/why-are-my-commits-linked-to-the-wrong-user.md index 2246e015db..e387da2392 100644 --- a/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/why-are-my-commits-linked-to-the-wrong-user.md +++ b/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/why-are-my-commits-linked-to-the-wrong-user.md @@ -21,7 +21,7 @@ shortTitle: Linked to wrong user ## Commits are linked to another user -If your commits are linked to another user, that means the email address in your local Git configuration settings is connected to that user's account on {% data variables.product.product_name %}. In this case, you can change the email in your local Git configuration settings{% ifversion ghae %} to the address associated with your account on {% data variables.product.product_name %} to link your future commits. Old commits will not be linked. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-in-git)."{% else %} and add the new email address to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} account to link future commits to your account. +If your commits are linked to another user, that means the email address in your local Git configuration settings is connected to that user's account on {% data variables.product.product_name %}. In this case, you can change the email in your local Git configuration settings{% ifversion ghae %} to the address associated with your account on {% data variables.product.product_name %} to link your future commits. Old commits will not be linked. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-in-git)."{% else %} and add the new email address to your account on {% data variables.location.product_location %} account to link future commits to your account. 1. To change the email address in your local Git configuration, follow the steps in "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-in-git)". If you work on multiple machines, you will need to change this setting on each one. 1. Add the email address from step 2 to your account settings by following the steps in "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account)".{% endif %} diff --git a/content/repositories/archiving-a-github-repository/referencing-and-citing-content.md b/content/repositories/archiving-a-github-repository/referencing-and-citing-content.md index c28460607c..566cd6b9bb 100644 --- a/content/repositories/archiving-a-github-repository/referencing-and-citing-content.md +++ b/content/repositories/archiving-a-github-repository/referencing-and-citing-content.md @@ -14,7 +14,7 @@ shortTitle: Reference & cite content --- ## Issuing a persistent identifier for your repository with Zenodo -To make your repositories easier to reference in academic literature, you can create persistent identifiers, also known as Digital Object Identifiers (DOIs). You can use the data archiving tool [Zenodo](https://about.zenodo.org/) to archive a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} and issue a DOI for the archive. +To make your repositories easier to reference in academic literature, you can create persistent identifiers, also known as Digital Object Identifiers (DOIs). You can use the data archiving tool [Zenodo](https://about.zenodo.org/) to archive a repository on {% data variables.location.product_location %} and issue a DOI for the archive. {% tip %} diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md index b6a1ed7d76..041a025573 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches.md @@ -221,7 +221,7 @@ If someone force pushes to a branch, the force push may mean commits that other Enabling force pushes will not override any other branch protection rules. For example, if a branch requires a linear commit history, you cannot force push merge commits to that branch. -{% ifversion ghes or ghae %}You cannot enable force pushes for a protected branch if a site administrator has blocked force pushes to all branches in your repository. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise)." +{% ifversion ghes %}You cannot enable force pushes for a protected branch if a site administrator has blocked force pushes to all branches in your repository. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise)." If a site administrator has blocked force pushes to the default branch only, you can still enable force pushes for any other protected branch.{% endif %} diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets.md index 08f455c07c..58abb8ef8a 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets.md @@ -140,7 +140,7 @@ If someone force pushes to a branch or tag, commits that other collaborators hav Enabling force pushes will not override any other rules. For example, if a branch requires a linear commit history, you cannot force push merge commits to that branch. -{% ifversion ghes or ghae %}You cannot enable force pushes for a branch if a site administrator has blocked force pushes to all branches in your repository. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise)." +{% ifversion ghes %}You cannot enable force pushes for a branch if a site administrator has blocked force pushes to all branches in your repository. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise)." If a site administrator has blocked force pushes to the default branch only, you can still enable force pushes for any other branch or tag.{% endif %} diff --git a/content/repositories/creating-and-managing-repositories/about-repositories.md b/content/repositories/creating-and-managing-repositories/about-repositories.md index 52b89db938..d39bba944d 100644 --- a/content/repositories/creating-and-managing-repositories/about-repositories.md +++ b/content/repositories/creating-and-managing-repositories/about-repositories.md @@ -56,7 +56,7 @@ You can use repositories to manage your work and collaborate with others. - You can use issues to collect user feedback, report software bugs, and organize tasks you'd like to accomplish. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/about-issues)."{% ifversion fpt or ghec %} - {% data reusables.discussions.you-can-use-discussions %}{% endif %} - You can use pull requests to propose changes to a repository. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." -- You can use project boards to organize and prioritize your issues and pull requests. For more information, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." +- You can use {% data variables.product.prodname_projects_v2 %} to organize and prioritize your issues and pull requests. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." {% ifversion fpt or ghec %} With {% data variables.product.prodname_free_team %} for personal accounts and organizations, you can work with unlimited collaborators on unlimited public repositories with a full feature set, or unlimited private repositories with a limited feature set. To get advanced tooling for private repositories, you can upgrade to {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, or {% data variables.product.prodname_ghe_cloud %}. {% data reusables.gated-features.more-info %} diff --git a/content/repositories/creating-and-managing-repositories/deleting-a-repository.md b/content/repositories/creating-and-managing-repositories/deleting-a-repository.md index ff8c6edbe3..cb4fe480f2 100644 --- a/content/repositories/creating-and-managing-repositories/deleting-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/deleting-a-repository.md @@ -28,7 +28,7 @@ topics: {% endwarning %} -Some deleted repositories can be restored within 90 days of deletion. {% ifversion ghes or ghae %}Your site administrator may be able to restore a deleted repository for you. For more information, see "[AUTOTITLE](/admin/user-management/managing-repositories-in-your-enterprise/restoring-a-deleted-repository)." {% else %}For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/restoring-a-deleted-repository)."{% endif %} +Some deleted repositories can be restored within 90 days of deletion. {% ifversion ghes %}Your site administrator may be able to restore a deleted repository for you. For more information, see "[AUTOTITLE](/admin/user-management/managing-repositories-in-your-enterprise/restoring-a-deleted-repository)." {% else %}For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/restoring-a-deleted-repository)."{% endif %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} diff --git a/content/repositories/creating-and-managing-repositories/quickstart-for-repositories.md b/content/repositories/creating-and-managing-repositories/quickstart-for-repositories.md index 87da8931ae..ed9118369e 100644 --- a/content/repositories/creating-and-managing-repositories/quickstart-for-repositories.md +++ b/content/repositories/creating-and-managing-repositories/quickstart-for-repositories.md @@ -119,7 +119,7 @@ You have now created a repository, including a _README_ file, and created your f {% webui %} -- You can now clone a {% data variables.product.prodname_dotcom %} repository to create a local copy on your computer. From your local repository you can commit, and create a pull request to update the changes in the upstream repository. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/cloning-a-repository)" and "[AUTOTITLE](/get-started/quickstart/set-up-git)." +- You can now clone a {% data variables.product.prodname_dotcom %} repository to create a local copy on your computer. From your local repository you can commit, and create a pull request to update the changes in the upstream repository. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/cloning-a-repository)" and "[AUTOTITLE](/get-started/getting-started-with-git/set-up-git)." {% endwebui %} diff --git a/content/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md b/content/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md index f151ca28ef..28ac3a28a4 100644 --- a/content/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md +++ b/content/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md @@ -1,7 +1,7 @@ --- title: Restoring a deleted repository -intro: '{% ifversion ghes or ghae %}An enterprise owner{% elsif fpt or ghec %}You{% endif %} can restore some deleted repositories to recover their contents.' -permissions: '{% ifversion ghes or ghae %}{% elsif fpt or ghec %}Anyone can restore deleted repositories that were owned by their own personal account. Organization owners can restore deleted repositories that were owned by the organization.{% endif %}' +intro: '{% ifversion ghes %}An enterprise owner{% elsif fpt or ghec %}You{% endif %} can restore some deleted repositories to recover their contents.' +permissions: '{% ifversion ghes %}{% elsif fpt or ghec %}Anyone can restore deleted repositories that were owned by their own personal account. Organization owners can restore deleted repositories that were owned by the organization.{% endif %}' redirect_from: - /articles/restoring-a-deleted-repository - /github/administering-a-repository/restoring-a-deleted-repository @@ -16,7 +16,7 @@ topics: shortTitle: Restore deleted repository --- -{% ifversion ghes or ghae %} +{% ifversion ghes %} Usually, deleted repositories can be restored within 90 days by an enterprise owner{% ifversion ghes %} on {% data variables.location.product_location %}{% endif %}. For more information, see "[AUTOTITLE](/admin/user-management/managing-repositories-in-your-enterprise/restoring-a-deleted-repository)." diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md index 73414445eb..4d497da0d5 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md @@ -69,12 +69,12 @@ A CODEOWNERS file uses a pattern that follows most of the same rules used in [gi If you want to match two or more code owners with the same pattern, all the code owners must be on the same line. If the code owners are not on the same line, the pattern matches only the last mentioned code owner. -{% ifversion fpt or ghec%}In most cases, you{% else %}You{% endif %} can also refer to a user by an email address that has been added to their account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}, for example `user@example.com`. {% ifversion fpt or ghec %} You cannot use an email address to refer to a {% data variables.enterprise.prodname_managed_user %}. For more information about {% data variables.enterprise.prodname_managed_users %}, see "[AUTOTITLE](/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %}{% endif %} +{% ifversion fpt or ghec%}In most cases, you{% else %}You{% endif %} can also refer to a user by an email address that has been added to their account on {% data variables.location.product_location %}, for example `user@example.com`. {% ifversion fpt or ghec %} You cannot use an email address to refer to a {% data variables.enterprise.prodname_managed_user %}. For more information about {% data variables.enterprise.prodname_managed_users %}, see "[AUTOTITLE](/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %}{% endif %} CODEOWNERS paths are case sensitive, because {% data variables.product.prodname_dotcom %} uses a case sensitive file system. Since CODEOWNERS are evaluated by {% data variables.product.prodname_dotcom %}, even systems that are case insensitive (for example, macOS) must use paths and files that are cased correctly in the CODEOWNERS file. {% ifversion codeowners-errors %} -If any line in your CODEOWNERS file contains invalid syntax, that line will be skipped. When you navigate to the CODEOWNERS file in your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}, you can see any errors highlighted. A list of errors in a repository's CODEOWNERS file is also accessible via the API. For more information, see "[AUTOTITLE](/rest/repos#list-codeowners-errors)" in the REST API documentation. +If any line in your CODEOWNERS file contains invalid syntax, that line will be skipped. When you navigate to the CODEOWNERS file in your repository on {% data variables.location.product_location %}, you can see any errors highlighted. A list of errors in a repository's CODEOWNERS file is also accessible via the API. For more information, see "[AUTOTITLE](/rest/repos#list-codeowners-errors)" in the REST API documentation. {% else %} If any line in your CODEOWNERS file contains invalid syntax, the file will not be detected and will not be used to request reviews. {% endif %} diff --git a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-projects-in-a-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-projects-in-a-repository.md index 1a8d743b16..987872cf45 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-projects-in-a-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-projects-in-a-repository.md @@ -32,7 +32,7 @@ When you disable {% data variables.projects.projects_v2 %} in a repository, link {% endif %} -When you disable {% data variables.projects.projects_v1_boards %} in a repository, existing {% data variables.projects.projects_v1_boards %} are inaccessible at their previous URLs. If you decide to re-enable project boards, any project boards that were previously added will be available. +When you disable {% data variables.projects.projects_v1_boards %} in a repository, existing {% data variables.projects.projects_v1_boards %} are inaccessible at their previous URLs. If you decide to re-enable {% data variables.projects.projects_v1_boards %}, any {% data variables.projects.projects_v1_boards %} that were previously added will be available. After you disable {% data variables.projects.projects_v1_boards %}, you will no longer see {% data variables.projects.projects_v1_board %} information in timelines or audit logs. diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md index 31a760709a..f270970cb5 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md @@ -34,7 +34,7 @@ Members of an {% data variables.enterprise.prodname_emu_enterprise %} can only s We recommend reviewing the following caveats before you change the visibility of a repository. -{% ifversion ghes or ghae %} +{% ifversion ghes %} {% warning %} diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md index 9a4b8c2aea..d438008f08 100644 --- a/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors.md @@ -19,7 +19,7 @@ shortTitle: View project contributors --- ## About contributors -You can view the top 100 contributors to a repository{% ifversion ghes or ghae %}, including commit co-authors,{% endif %} in the contributors graph. Merge commits and empty commits aren't counted as contributions for this graph. +You can view the top 100 contributors to a repository{% ifversion ghes %}, including commit co-authors,{% endif %} in the contributors graph. Merge commits and empty commits aren't counted as contributions for this graph. {% ifversion fpt or ghec %} You can also see a list of people who have contributed to the project's Python dependencies. To access this list of community contributors, visit `https://github.com/REPO-OWNER/REPO-NAME/graphs/contributors`. diff --git a/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md b/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md index 068aca1c6d..85109e3b93 100644 --- a/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md +++ b/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md @@ -43,7 +43,7 @@ Files that you add to a repository via a browser are limited to {% data variable ## Adding a file to a repository using the command line -You can upload an existing file to a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} using the command line. +You can upload an existing file to a repository on {% data variables.location.product_location %} using the command line. {% tip %} diff --git a/content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md index 392ac6156a..f5a57541f2 100644 --- a/content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md @@ -17,7 +17,7 @@ If there are existing files in your repository that you'd like to use {% data va {% data reusables.large_files.resolving-upload-failures %} -{% ifversion ghes or ghae %} +{% ifversion ghes %} {% tip %} diff --git a/content/repositories/working-with-files/using-files/working-with-non-code-files.md b/content/repositories/working-with-files/using-files/working-with-non-code-files.md index 15200f0f36..640fdcdc29 100644 --- a/content/repositories/working-with-files/using-files/working-with-non-code-files.md +++ b/content/repositories/working-with-files/using-files/working-with-non-code-files.md @@ -49,7 +49,7 @@ shortTitle: Working with non-code files ### Viewing images -You can directly browse and view images in your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}. +You can directly browse and view images in your repository on {% data variables.location.product_location %}. SVGs don't currently support inline scripting or animation. @@ -129,7 +129,7 @@ You can embed ASCII STL syntax directly in Markdown. For more information, see " ![Screenshot of a rendered CSV file, with data shown in a table format.](/assets/images/help/repository/rendered-csv.png) -When viewed, any _.csv_ or _.tsv_ file committed to a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} automatically renders as an interactive table, complete with headers and row numbering. By default, we'll always assume the first row is your header row. +When viewed, any _.csv_ or _.tsv_ file committed to a repository on {% data variables.location.product_location %} automatically renders as an interactive table, complete with headers and row numbering. By default, we'll always assume the first row is your header row. You can link to a particular row by clicking the row number, or select multiple rows by holding down the shift key. Just copy the URL and send it to a friend. diff --git a/content/rest/apps/oauth-applications.md b/content/rest/apps/oauth-applications.md index c890964578..92fd6a82ff 100644 --- a/content/rest/apps/oauth-applications.md +++ b/content/rest/apps/oauth-applications.md @@ -17,7 +17,7 @@ autogenerated: rest ## About {% data variables.product.prodname_oauth_apps %} and OAuth authorizations of {% data variables.product.prodname_github_apps %} -You can use these endpoints to manage the OAuth tokens that {% data variables.product.prodname_oauth_apps %} or {% data variables.product.prodname_github_apps %} use to access people's accounts on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}. +You can use these endpoints to manage the OAuth tokens that {% data variables.product.prodname_oauth_apps %} or {% data variables.product.prodname_github_apps %} use to access people's accounts on {% data variables.location.product_location %}. Tokens for {% data variables.product.prodname_oauth_apps %} have the prefix `gho_`, while OAuth tokens for {% data variables.product.prodname_github_apps %}, used for authenticating on behalf of the user, have the prefix `ghu_`. You can use the following endpoints for both types of OAuth tokens. diff --git a/content/rest/authentication/authenticating-to-the-rest-api.md b/content/rest/authentication/authenticating-to-the-rest-api.md index ec3135ce78..9c6cc119b3 100644 --- a/content/rest/authentication/authenticating-to-the-rest-api.md +++ b/content/rest/authentication/authenticating-to-the-rest-api.md @@ -106,7 +106,7 @@ If this is not possible, you can store your token as a secret and use the name o To make an authenticated request to the API in a {% data variables.product.prodname_actions %} workflow using {% data variables.product.prodname_cli %}, you can store the value of `GITHUB_TOKEN` as an environment variable, and use the `run` keyword to execute the {% data variables.product.prodname_cli %} `api` subcommand. For more information about the `run` keyword, see "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." -In the following example workflow, replace `PATH` with the path of the endpoint. For more information about the path, see "[AUTOTITLE](/rest/guides/getting-started-with-the-rest-api?tool=cli#path)."{% ifversion ghes or ghae %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} +In the following example workflow, replace `PATH` with the path of the endpoint. For more information about the path, see "[AUTOTITLE](/rest/guides/getting-started-with-the-rest-api?tool=cli#path)."{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} ```yaml jobs: @@ -124,7 +124,7 @@ jobs: To make an authenticated request to the API in a {% data variables.product.prodname_actions %} workflow using `curl`, you can store the value of `GITHUB_TOKEN` as an environment variable, and use the `run` keyword to execute a `curl` request to the API. For more information about the `run` keyword, see "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." -In the following example workflow, replace `PATH` with the path of the endpoint. For more information about the path, see "[AUTOTITLE](/rest/guides/getting-started-with-the-rest-api?tool=cli#path)."{% ifversion ghes or ghae %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} +In the following example workflow, replace `PATH` with the path of the endpoint. For more information about the path, see "[AUTOTITLE](/rest/guides/getting-started-with-the-rest-api?tool=cli#path)."{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} ```yaml copy jobs: diff --git a/content/rest/enterprise-admin/scim.md b/content/rest/enterprise-admin/scim.md index 566596318e..0975c9d200 100644 --- a/content/rest/enterprise-admin/scim.md +++ b/content/rest/enterprise-admin/scim.md @@ -9,12 +9,12 @@ topics: autogenerated: rest --- +{% data reusables.scim.ghec-open-scim-beta-note %} + ## About SCIM {% ifversion ghec %} -{% data reusables.scim.ghec-open-scim-beta-note %} - {% data reusables.enterprise_user_management.about-scim-provisioning %} If you don't use a partner IdP with an existing integration, you can integrate using the following API endpoints. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/provisioning-user-accounts-for-enterprise-managed-users/provisioning-users-with-scim-using-the-rest-api)." ### Base URL diff --git a/content/rest/gitignore/gitignore.md b/content/rest/gitignore/gitignore.md index 0779e5826d..a97d936959 100644 --- a/content/rest/gitignore/gitignore.md +++ b/content/rest/gitignore/gitignore.md @@ -17,7 +17,7 @@ autogenerated: rest ## About gitignore -When you create a new repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} via the API, you can specify a [.gitignore template](/get-started/getting-started-with-git/ignoring-files) to apply to the repository upon creation. You can use the REST API to get .gitignore templates from the {% data variables.product.product_name %} [.gitignore repository](https://github.com/github/gitignore). +When you create a new repository on {% data variables.location.product_location %} via the API, you can specify a [.gitignore template](/get-started/getting-started-with-git/ignoring-files) to apply to the repository upon creation. You can use the REST API to get .gitignore templates from the {% data variables.product.product_name %} [.gitignore repository](https://github.com/github/gitignore). You can use the `application/vnd.github.raw` custom media type when getting a gitignore template. For more information, see "[AUTOTITLE](/rest/overview/media-types)." diff --git a/content/rest/guides/scripting-with-the-rest-api-and-javascript.md b/content/rest/guides/scripting-with-the-rest-api-and-javascript.md index 63e3a10eb3..a5fd9a8832 100644 --- a/content/rest/guides/scripting-with-the-rest-api-and-javascript.md +++ b/content/rest/guides/scripting-with-the-rest-api-and-javascript.md @@ -41,12 +41,12 @@ If {% ifversion ghec or fpt %}these options are not possible{% else %}this is no If you want to use the {% data variables.product.company_short %} REST API for personal use, you can create a {% data variables.product.pat_generic %}. For more information about creating a {% data variables.product.pat_generic %}, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." -First, import `Octokit` from `octokit`. Then, pass your {% data variables.product.pat_generic %} when you create an instance of `Octokit`. In the following example, replace `YOUR-TOKEN` with a reference to your {% data variables.product.pat_generic %}.{% ifversion ghes or ghae %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} +First, import `Octokit` from `octokit`. Then, pass your {% data variables.product.pat_generic %} when you create an instance of `Octokit`. In the following example, replace `YOUR-TOKEN` with a reference to your {% data variables.product.pat_generic %}.{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} ```javascript copy import { Octokit } from "octokit"; -const octokit = new Octokit({ {% ifversion ghes or ghae %} +const octokit = new Octokit({ {% ifversion ghes %} baseUrl: "{% data variables.product.api_url_code %}",{% endif %} auth: 'YOUR-TOKEN', }); @@ -56,14 +56,14 @@ const octokit = new Octokit({ {% ifversion ghes or ghae %} If you want to use the API on behalf of an organization or another user, {% data variables.product.company_short %} recommends that you use a {% data variables.product.prodname_github_app %}. If an endpoint is available to {% data variables.product.prodname_github_apps %}, the REST reference documentation for that endpoint will say "Works with {% data variables.product.prodname_github_apps %}." For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app)," "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app)," and "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/identifying-and-authorizing-users-for-github-apps)." -Instead of importing `Octokit` from `octokit`, import `App`. In the following example, replace `APP_ID` with a reference to your app's ID. Replace `PRIVATE_KEY` with a reference to your app's private key. Replace `INSTALLATION_ID` with the ID of the installation of your app that you want to authenticate on behalf of. You can find your app's ID and generate a private key on the settings page for your app. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps)." You can get an installation ID with the `GET /users/{username}/installation`, `GET /repos/{owner}/{repo}/installation`, or `GET /orgs/{org}/installation` endpoints. For more information, see "[AUTOTITLE](/rest/apps/apps)" in the REST reference documentation.{% ifversion ghes or ghae %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} +Instead of importing `Octokit` from `octokit`, import `App`. In the following example, replace `APP_ID` with a reference to your app's ID. Replace `PRIVATE_KEY` with a reference to your app's private key. Replace `INSTALLATION_ID` with the ID of the installation of your app that you want to authenticate on behalf of. You can find your app's ID and generate a private key on the settings page for your app. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps)." You can get an installation ID with the `GET /users/{username}/installation`, `GET /repos/{owner}/{repo}/installation`, or `GET /orgs/{org}/installation` endpoints. For more information, see "[AUTOTITLE](/rest/apps/apps)" in the REST reference documentation.{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} ```javascript copy import { App } from "octokit"; const app = new App({ appId: APP_ID, - privateKey: PRIVATE_KEY,{% ifversion ghes or ghae %} + privateKey: PRIVATE_KEY,{% ifversion ghes %} Octokit: Octokit.defaults({ baseUrl: "{% data variables.product.api_url_code %}", }),{% endif %} @@ -95,7 +95,7 @@ The script that the workflow runs uses `process.env.TOKEN` to authenticate: ```javascript copy import { Octokit } from "octokit"; -const octokit = new Octokit({ {% ifversion ghes or ghae %} +const octokit = new Octokit({ {% ifversion ghes %} baseUrl: "{% data variables.product.api_url_code %}",{% endif %} auth: process.env.TOKEN, }); @@ -103,12 +103,12 @@ const octokit = new Octokit({ {% ifversion ghes or ghae %} ### Instantiating without authentication -You can use the REST API without authentication, although you will have a lower rate limit and will not be able to use some endpoints. To create an instance of `Octokit` without authenticating, do not pass the `auth` argument.{% ifversion ghes or ghae %} Set the base URL to `{% data variables.product.api_url_code %}`. Replace `[hostname]` with the name of {% data variables.location.product_location %}.{% endif %} +You can use the REST API without authentication, although you will have a lower rate limit and will not be able to use some endpoints. To create an instance of `Octokit` without authenticating, do not pass the `auth` argument.{% ifversion ghes %} Set the base URL to `{% data variables.product.api_url_code %}`. Replace `[hostname]` with the name of {% data variables.location.product_location %}.{% endif %} ```javascript copy import { Octokit } from "octokit"; -const octokit = new Octokit({ {% ifversion ghes or ghae %} +const octokit = new Octokit({ {% ifversion ghes %} baseUrl: "{% data variables.product.api_url_code %}", {% endif %}}); ``` @@ -364,7 +364,7 @@ The `getChangedFiles` function gets all of the files changed for a pull request. ```javascript copy import { Octokit } from "octokit"; -const octokit = new Octokit({ {% ifversion ghes or ghae %} +const octokit = new Octokit({ {% ifversion ghes %} baseUrl: "{% data variables.product.api_url_code %}",{% endif %} auth: 'YOUR-TOKEN', }); diff --git a/content/rest/guides/scripting-with-the-rest-api-and-ruby.md b/content/rest/guides/scripting-with-the-rest-api-and-ruby.md index e26509a91b..2d0acd4c67 100644 --- a/content/rest/guides/scripting-with-the-rest-api-and-ruby.md +++ b/content/rest/guides/scripting-with-the-rest-api-and-ruby.md @@ -53,7 +53,7 @@ octokit = Octokit::Client.new(access_token: 'YOUR-TOKEN') If you want to use the API on behalf of an organization or another user, {% data variables.product.company_short %} recommends that you use a {% data variables.product.prodname_github_app %}. If an endpoint is available to {% data variables.product.prodname_github_apps %}, the REST reference documentation for that endpoint will say "Works with {% data variables.product.prodname_github_app %}." For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app)," "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app)," and "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/identifying-and-authorizing-users-for-github-apps)." -Instead of requiring `octokit`, create an instance of `Octokit::Client` by passing your {% data variables.product.prodname_github_app %}'s information as options. In the following example, replace `APP_ID` with your app's ID, `PRIVATE_KEY` with your app's private key, and `INSTALLATION_ID` with the ID of the installation of your app that you want to authenticate on behalf of. You can find your app's ID and generate a private key on the settings page for your app. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps)." You can get an installation ID with the `GET /users/{username}/installation`, `GET /repos/{owner}/{repo}/installation`, or `GET /orgs/{org}/installation` endpoints. For more information, see "[AUTOTITLE](/rest/apps/apps)" in the REST reference documentation.{% ifversion ghes or ghae %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} +Instead of requiring `octokit`, create an instance of `Octokit::Client` by passing your {% data variables.product.prodname_github_app %}'s information as options. In the following example, replace `APP_ID` with your app's ID, `PRIVATE_KEY` with your app's private key, and `INSTALLATION_ID` with the ID of the installation of your app that you want to authenticate on behalf of. You can find your app's ID and generate a private key on the settings page for your app. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps)." You can get an installation ID with the `GET /users/{username}/installation`, `GET /repos/{owner}/{repo}/installation`, or `GET /orgs/{org}/installation` endpoints. For more information, see "[AUTOTITLE](/rest/apps/apps)" in the REST reference documentation.{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} ```ruby copy require 'octokit' diff --git a/content/rest/quickstart.md b/content/rest/quickstart.md index 69f38ec7cc..99ed1b6cf5 100644 --- a/content/rest/quickstart.md +++ b/content/rest/quickstart.md @@ -5,7 +5,6 @@ allowTitleToDifferFromFilename: true versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' shortTitle: Quickstart topics: @@ -43,7 +42,7 @@ You can also use {% data variables.product.prodname_cli %} in your {% data varia Instead of using the `gh auth login` command, pass an access token as an environment variable called `GH_TOKEN`. {% data variables.product.prodname_dotcom %} recommends that you use the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[AUTOTITLE](/actions/security-guides/automatic-token-authentication)." For more information about secrets, see "[AUTOTITLE](/actions/security-guides/encrypted-secrets)." -The following example workflow uses the "[List repository issues](/rest/issues/issues#list-repository-issues)" endpoint, and requests a list of issues in {% ifversion ghes or ghae %}a repository you specify{% else %}the `octocat/Spoon-Knife` repository{% endif %}.{% ifversion ghes or ghae %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}. Replace `REPO-OWNER` with the name of the account that owns the repository. Replace `REPO-NAME` with the name of the repository.{% endif %} +The following example workflow uses the "[List repository issues](/rest/issues/issues#list-repository-issues)" endpoint, and requests a list of issues in {% ifversion ghes %}a repository you specify{% else %}the `octocat/Spoon-Knife` repository{% endif %}.{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}. Replace `REPO-OWNER` with the name of the account that owns the repository. Replace `REPO-NAME` with the name of the repository.{% endif %} ```yaml copy on: @@ -119,10 +118,10 @@ You can use Octokit.js to interact with the {% data variables.product.prodname_d 1. Install `octokit`. For example, `npm install octokit`. For other ways to install or load `octokit`, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). 1. Import `octokit` in your script. For example, `import { Octokit } from "octokit";`. For other ways to import `octokit`, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). -1. Create an instance of `Octokit` with your token.{% ifversion ghes or ghae %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} Replace `YOUR-TOKEN` with your token. +1. Create an instance of `Octokit` with your token.{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} Replace `YOUR-TOKEN` with your token. ```javascript copy - const octokit = new Octokit({ {% ifversion ghes or ghae %} + const octokit = new Octokit({ {% ifversion ghes %} baseUrl: "{% data variables.product.api_url_code %}",{% endif %} auth: 'YOUR-TOKEN' }); @@ -130,12 +129,12 @@ You can use Octokit.js to interact with the {% data variables.product.prodname_d 1. Use `octokit.request` to execute your request. Send the HTTP method and path as the first argument. Specify any path, query, and body parameters in an object as the second argument. For more information about parameters, see "[AUTOTITLE](/rest/guides/getting-started-with-the-rest-api#using-parameters)." - For example, in the following request the HTTP method is `GET`, the path is `/repos/{owner}/{repo}/issues`, and the parameters are {% ifversion ghes or ghae %}`owner: "REPO-OWNER"` and `repo: "REPO-NAME"`{% else %}`owner: "octocat"` and `repo: "Spoon-Knife"`{% endif %}.{% ifversion ghes or ghae %} Replace `REPO-OWNER` with the name of the account that owns the repository, and `REPO-NAME` with the name of the repository.{% endif %} + For example, in the following request the HTTP method is `GET`, the path is `/repos/{owner}/{repo}/issues`, and the parameters are {% ifversion ghes %}`owner: "REPO-OWNER"` and `repo: "REPO-NAME"`{% else %}`owner: "octocat"` and `repo: "Spoon-Knife"`{% endif %}.{% ifversion ghes %} Replace `REPO-OWNER` with the name of the account that owns the repository, and `REPO-NAME` with the name of the repository.{% endif %} ```javascript copy await octokit.request("GET /repos/{owner}/{repo}/issues", { - owner: "{% ifversion ghes or ghae %}REPO-OWNER{% else %}octocat{% endif %}", - repo: "{% ifversion ghes or ghae %}REPO-NAME{% else %}Spoon-Knife{% endif %}", + owner: "{% ifversion ghes %}REPO-OWNER{% else %}octocat{% endif %}", + repo: "{% ifversion ghes %}REPO-NAME{% else %}Spoon-Knife{% endif %}", }); ``` @@ -182,20 +181,20 @@ jobs: TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} ``` -The following is an example JavaScript script with the file path `.github/actions-scripts/use-the-api.mjs`.{% ifversion ghes or ghae %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}. Replace `REPO-OWNER` with the name of the account that owns the repository. Replace `REPO-NAME` with the name of the repository.{% endif %} +The following is an example JavaScript script with the file path `.github/actions-scripts/use-the-api.mjs`.{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}. Replace `REPO-OWNER` with the name of the account that owns the repository. Replace `REPO-NAME` with the name of the repository.{% endif %} ```javascript import { Octokit } from "octokit" -const octokit = new Octokit({ {% ifversion ghes or ghae %} +const octokit = new Octokit({ {% ifversion ghes %} baseUrl: "{% data variables.product.api_url_code %}",{% endif %} auth: process.env.TOKEN }); try { const result = await octokit.request("GET /repos/{owner}/{repo}/issues", { - owner: "{% ifversion ghes or ghae %}REPO-OWNER{% else %}octocat{% endif %}", - repo: "{% ifversion ghes or ghae %}REPO-NAME{% else %}Spoon-Knife{% endif %}", + owner: "{% ifversion ghes %}REPO-OWNER{% else %}octocat{% endif %}", + repo: "{% ifversion ghes %}REPO-NAME{% else %}Spoon-Knife{% endif %}", }); const titleAndAuthor = result.data.map(issue => {title: issue.title, authorID: issue.user.id}) @@ -284,7 +283,7 @@ If you are authenticating with a {% data variables.product.prodname_github_app % {% endwarning %} -1. Use the `curl` command to make your request. Pass your token in an `Authorization` header.{% ifversion ghes or ghae %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}. Replace `REPO-OWNER` with the name of the account that owns the repository. Replace `REPO-NAME` with the name of the repository.{% endif %} Replace `YOUR-TOKEN` with your token. +1. Use the `curl` command to make your request. Pass your token in an `Authorization` header.{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}. Replace `REPO-OWNER` with the name of the account that owns the repository. Replace `REPO-NAME` with the name of the repository.{% endif %} Replace `YOUR-TOKEN` with your token. ```shell copy curl --request GET \ @@ -307,7 +306,7 @@ You can also use `curl` commands in your {% data variables.product.prodname_acti {% data variables.product.prodname_dotcom %} recommends that you use the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[AUTOTITLE](/actions/security-guides/automatic-token-authentication)." For more information about secrets, see "[AUTOTITLE](/actions/security-guides/encrypted-secrets)." -{% ifversion ghes or ghae %}In the following example, replace `HOSTNAME` with the name of {% data variables.location.product_location %}. Replace `REPO-OWNER` with the name of the account that owns the repository. Replace `REPO-NAME` with the name of the repository.{% endif %} +{% ifversion ghes %}In the following example, replace `HOSTNAME` with the name of {% data variables.location.product_location %}. Replace `REPO-OWNER` with the name of the account that owns the repository. Replace `REPO-NAME` with the name of the repository.{% endif %} ```yaml copy on: diff --git a/content/rest/scim/index.md b/content/rest/scim/index.md index 2961a53407..5b7e951a01 100644 --- a/content/rest/scim/index.md +++ b/content/rest/scim/index.md @@ -1,7 +1,7 @@ --- title: SCIM intro: >- - Use the REST API to control and manage your GitHub organization members access + Use the REST API to control and manage your GitHub organization members' access with SCIM. versions: ghec: '*' @@ -12,4 +12,6 @@ children: autogenerated: rest --- +{% data reusables.scim.organization-rest-api-ghec-deployment-option %} + diff --git a/content/rest/scim/scim.md b/content/rest/scim/scim.md index 0dc1256241..bba63b15fa 100644 --- a/content/rest/scim/scim.md +++ b/content/rest/scim/scim.md @@ -1,7 +1,7 @@ --- title: SCIM intro: >- - Use the REST API to control and manage your GitHub organization members access + Use the REST API to control and manage your GitHub organization members' access with SCIM. versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 ghec: '*' @@ -12,6 +12,8 @@ redirect_from: autogenerated: rest --- +{% data reusables.scim.organization-rest-api-ghec-deployment-option %} + ## About SCIM ### SCIM Provisioning for Organizations diff --git a/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md b/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md index 5f68558d24..e03bebee04 100644 --- a/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md +++ b/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md @@ -5,7 +5,6 @@ intro: 'Learn how to use the {% data variables.product.prodname_dotcom %} REST A versions: fpt: '*' ghes: '*' - ghae: '*' ghec: '*' topics: - API @@ -116,7 +115,7 @@ Media types specify the format of the data you want to consume from the API. Med The most common media types supported by the {% data variables.product.prodname_dotcom %} REST API are `application/vnd.github+json` and `application/json`. -There are other custom media types that you can use with some endpoints. For example, some endpoints support the media types `full`, `raw`, `text`, or `html`. And the REST API to manage [commits](/rest/commits/commits#get-a-commit) and [pull requests](/rest/pulls/pulls) support the media types `diff`, `patch`, and `sha`. +There are custom media types that you can use with some endpoints. For example, the REST API to manage [commits](/rest/commits/commits#get-a-commit) and [pull requests](/rest/pulls/pulls) support the media types `diff`, `patch`, and `sha`. The media types `full`, `raw`, `text`, or `html` are used by some other endpoints. All custom media types for {% data variables.product.product_name %} look like this: `application/vnd.github.PARAM+json`, where `PARAM` is the name of the media type. For example, to specify the `raw` media type, you would use `application/vnd.github.raw+json`. @@ -200,9 +199,9 @@ Install {% data variables.product.prodname_cli %} on macOS, Windows, or Linux. F ### 2. Authenticate -1. Authenticate with {% data variables.product.company_short %} by running this command from your terminal.{% ifversion ghes or ghae %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}. For example, `octo-inc.ghe.com`.{% endif %} +1. Authenticate with {% data variables.product.company_short %} by running this command from your terminal.{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}. For example, `octo-inc.ghe.com`.{% endif %} - {%- ifversion ghes or ghae %} + {%- ifversion ghes %} ```shell copy gh auth login --hostname HOSTNAME @@ -270,10 +269,10 @@ gh api --method GET /events -F per_page=2 -F page=1 #### Example request using body parameters -The following example uses the ["Create an issue" endpoint](/rest/issues/issues#create-an-issue) to create a new issue in {% ifversion ghes or ghae %}a specified{% else %}the octocat/Spoon-Knife{% endif %} repository.{% ifversion ghes or ghae %} Replace `REPO-NAME` with the name of the repository where you want to create a new issue, and replace `REPO-OWNER` with the name of the account that owns the repository.{% endif %} In the response, find the `html_url` of your issue, and navigate to your issue in the browser. +The following example uses the ["Create an issue" endpoint](/rest/issues/issues#create-an-issue) to create a new issue in {% ifversion ghes %}a specified{% else %}the octocat/Spoon-Knife{% endif %} repository.{% ifversion ghes %} Replace `REPO-NAME` with the name of the repository where you want to create a new issue, and replace `REPO-OWNER` with the name of the account that owns the repository.{% endif %} In the response, find the `html_url` of your issue, and navigate to your issue in the browser. ```shell copy -gh api --method POST /repos/{% ifversion ghes or ghae %}REPO-OWNER/REPO-NAME{% else %}octocat/Spoon-Knife{% endif %}/issues \ +gh api --method POST /repos/{% ifversion ghes %}REPO-OWNER/REPO-NAME{% else %}octocat/Spoon-Knife{% endif %}/issues \ --header "Accept: application/vnd.github+json" \ --header "X-GitHub-Api-Version: 2022-11-28" \ -f title='Created with the REST API' \ @@ -315,7 +314,7 @@ Use the `curl` command to make your request. For more information, see [the curl Specify the following options and values in your request: - **`--request` or `-X`** followed by the HTTP method as the value. For more information, see "[HTTP method](#http-method)." -- **`--url`** followed by the full path as the value. The full path is a URL that includes the base URL for the GitHub REST API (`https://api.github.com`) and the path of the endpoint, like this: `{% data variables.product.api_url_code %}/PATH`.{% ifversion ghes or ghae %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} Replace `PATH` with the path of the endpoint. For more information, see "[Path](#path)." +- **`--url`** followed by the full path as the value. The full path is a URL that includes the base URL for the GitHub REST API (`https://api.github.com`) and the path of the endpoint, like this: `{% data variables.product.api_url_code %}/PATH`.{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} Replace `PATH` with the path of the endpoint. For more information, see "[Path](#path)." To use query parameters, add a `?` to the end of the path, then append your query parameter name and value in the form `parameter_name=value`. Separate multiple query parameters with `&`. If you need to send an array in the query string, use the query parameter once per array item, and append `[]` after the query parameter name. For example, to provide an array of two repository IDs, use `?repository_ids[]=REPOSITORY_A_ID&repository_ids[]=REPOSITORY_B_ID`. For more information, see "[Query parameters](#query-parameters)." For an example, see "[Example request using query parameters](#example-request-using-query-parameters-1)." - **`--header` or `-H`**: @@ -349,13 +348,13 @@ curl --request GET \ #### Example request using body parameters -The following example uses the "[Create an issue](/rest/issues/issues#create-an-issue)" endpoint to create a new issue in {% ifversion ghes or ghae %}a specified{% else %}the octocat/Spoon-Knife{% endif %} repository.{% ifversion ghes or ghae %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}. Replace `REPO-NAME` with the name of the repository where you want to create a new issue, and replace `REPO-OWNER` with the name of the account that owns the repository.{% endif %} Replace `YOUR-TOKEN` with the authentication token you created in a previous step. +The following example uses the "[Create an issue](/rest/issues/issues#create-an-issue)" endpoint to create a new issue in {% ifversion ghes %}a specified{% else %}the octocat/Spoon-Knife{% endif %} repository.{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}. Replace `REPO-NAME` with the name of the repository where you want to create a new issue, and replace `REPO-OWNER` with the name of the account that owns the repository.{% endif %} Replace `YOUR-TOKEN` with the authentication token you created in a previous step. {% ifversion pat-v2 %} {% note %} -**Note**: If you are using a {% data variables.product.pat_v2 %}, you must replace `{% ifversion ghes or ghae %}REPO-OWNER` and `REPO-NAME{% else %}octocat/Spoon-Knife{% endif %}` with a repository that you own or that is owned by an organization that you are a member of. Your token must have access to that repository and have read and write permissions for repository issues. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." +**Note**: If you are using a {% data variables.product.pat_v2 %}, you must replace `{% ifversion ghes %}REPO-OWNER` and `REPO-NAME{% else %}octocat/Spoon-Knife{% endif %}` with a repository that you own or that is owned by an organization that you are a member of. Your token must have access to that repository and have read and write permissions for repository issues. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." {% endnote %} @@ -364,7 +363,7 @@ The following example uses the "[Create an issue](/rest/issues/issues#create-an- ```shell copy curl \ --request POST \ ---url "{% data variables.product.api_url_code %}/repos/{% ifversion ghes or ghae %}REPO-OWNER/REPO-NAME{% else %}octocat/Spoon-Knife{% endif %}/issues" \ +--url "{% data variables.product.api_url_code %}/repos/{% ifversion ghes %}REPO-OWNER/REPO-NAME{% else %}octocat/Spoon-Knife{% endif %}/issues" \ --header "Accept: application/vnd.github+json" \{% ifversion api-date-versioning %} --header "X-GitHub-Api-Version: 2022-11-28" \{% endif %} --header "Authorization: Bearer YOUR-TOKEN" \ @@ -404,10 +403,10 @@ Create an access token to authenticate your request. You can save your token and ### 4. Make a request with Octokit.js 1. Import `octokit` in your script. For example, `import { Octokit } from "octokit";`. For other ways to import `octokit`, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). -1. Create an instance of `Octokit` with your token.{% ifversion ghes or ghae %} Set the base URL to `{% data variables.product.api_url_code %}`. Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} Replace `YOUR-TOKEN` with your token. +1. Create an instance of `Octokit` with your token.{% ifversion ghes %} Set the base URL to `{% data variables.product.api_url_code %}`. Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} Replace `YOUR-TOKEN` with your token. ```javascript copy - const octokit = new Octokit({ {% ifversion ghes or ghae %} + const octokit = new Octokit({ {% ifversion ghes %} baseUrl: "{% data variables.product.api_url_code %}",{% endif %} auth: 'YOUR-TOKEN' }); @@ -418,13 +417,13 @@ Create an access token to authenticate your request. You can save your token and - Send the HTTP method and path as the first argument to the `request` method. For more information, see "[HTTP method](#http-method)" and "[Path](#path)." - Specify all path, query, and body parameters in an object as the second argument to the `request` method. For more information, see "[Parameters](#parameters)." - In the following example request, the HTTP method is `POST`, the path is `/repos/{owner}/{repo}/issues`, the path parameters are `owner: "{% ifversion ghes or ghae %}REPO-OWNER{% else %}octocat{% endif %}"` and `repo: "{% ifversion ghes or ghae %}REPO-NAME{% else %}Spoon-Knife{% endif %}"`, and the body parameters are `title: "Created with the REST API"` and `body: "This is a test issue created by the REST API"`.{% ifversion ghes or ghae %} Replace `REPO-OWNER` with the name of the account that owns the repository, and `REPO-NAME` with the name of the repository.{% endif %} + In the following example request, the HTTP method is `POST`, the path is `/repos/{owner}/{repo}/issues`, the path parameters are `owner: "{% ifversion ghes %}REPO-OWNER{% else %}octocat{% endif %}"` and `repo: "{% ifversion ghes %}REPO-NAME{% else %}Spoon-Knife{% endif %}"`, and the body parameters are `title: "Created with the REST API"` and `body: "This is a test issue created by the REST API"`.{% ifversion ghes %} Replace `REPO-OWNER` with the name of the account that owns the repository, and `REPO-NAME` with the name of the repository.{% endif %} {% ifversion pat-v2 %} {% note %} - **Note**: If you are using a {% data variables.product.pat_v2 %}, you must replace `{% ifversion ghes or ghae %}REPO-OWNER` and `REPO-NAME{% else %}octocat/Spoon-Knife{% endif %}` with a repository that you own or that is owned by an organization that you are a member of. Your token must have access to that repository and have read and write permissions for repository issues. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." + **Note**: If you are using a {% data variables.product.pat_v2 %}, you must replace `{% ifversion ghes %}REPO-OWNER` and `REPO-NAME{% else %}octocat/Spoon-Knife{% endif %}` with a repository that you own or that is owned by an organization that you are a member of. Your token must have access to that repository and have read and write permissions for repository issues. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." {% endnote %} @@ -432,8 +431,8 @@ Create an access token to authenticate your request. You can save your token and ```javascript copy await octokit.request("POST /repos/{owner}/{repo}/issues", { - owner: "{% ifversion ghes or ghae %}REPO-OWNER{% else %}octocat{% endif %}", - repo: "{% ifversion ghes or ghae %}REPO-NAME{% else %}Spoon-Knife{% endif %}", + owner: "{% ifversion ghes %}REPO-OWNER{% else %}octocat{% endif %}", + repo: "{% ifversion ghes %}REPO-NAME{% else %}Spoon-Knife{% endif %}", title: "Created with the REST API", body: "This is a test issue created by the REST API", }); @@ -468,12 +467,12 @@ Additionally, the response will include headers that give more details about the To view the status code and headers, use the `--include` or `--i` option when you send your request. -For example, this request gets a list of issues in {% ifversion ghes or ghae %}a specified{% else %}the octocat/Spoon-Knife{% endif %} repository: +For example, this request gets a list of issues in {% ifversion ghes %}a specified{% else %}the octocat/Spoon-Knife{% endif %} repository: ```shell gh api \ --header 'Accept: application/vnd.github+json' \ ---method GET /repos/{% ifversion ghes or ghae %}REPO-OWNER/REPO-NAME{% else %}octocat/Spoon-Knife{% endif %}/issues \ +--method GET /repos/{% ifversion ghes %}REPO-OWNER/REPO-NAME{% else %}octocat/Spoon-Knife{% endif %}/issues \ -F per_page=2 --include ``` @@ -542,11 +541,11 @@ try { To view the status code and headers, use the `--include` or `--i` option when you send your request. -For example, this request gets a list of issues in {% ifversion ghes or ghae %}a specified{% else %}the octocat/Spoon-Knife{% endif %} repository: +For example, this request gets a list of issues in {% ifversion ghes %}a specified{% else %}the octocat/Spoon-Knife{% endif %} repository: ```shell curl --request GET \ ---url "https://api.github.com/repos/{% ifversion ghes or ghae %}REPO-OWNER/REPO-NAME{% else %}octocat/Spoon-Knife{% endif %}/issues?per_page=2" \ +--url "https://api.github.com/repos/{% ifversion ghes %}REPO-OWNER/REPO-NAME{% else %}octocat/Spoon-Knife{% endif %}/issues?per_page=2" \ --header "Accept: application/vnd.github+json" \ --header "Authorization: Bearer YOUR-TOKEN" \ --include @@ -651,7 +650,7 @@ try { {% curl %} -For example, you can use `>` to redirect the response to a file. In the following example, replace `REPO-OWNER` with the name of the account that owns the repository, and `REPO-NAME` with the name of the repository.{% ifversion ghes or ghae %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} +For example, you can use `>` to redirect the response to a file. In the following example, replace `REPO-OWNER` with the name of the account that owns the repository, and `REPO-NAME` with the name of the repository.{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} ```shell copy curl --request GET \ diff --git a/content/rest/using-the-rest-api/issue-event-types.md b/content/rest/using-the-rest-api/issue-event-types.md index b36926590c..3addc128fc 100644 --- a/content/rest/using-the-rest-api/issue-event-types.md +++ b/content/rest/using-the-rest-api/issue-event-types.md @@ -27,7 +27,7 @@ Issue events all have the same object structure, except events that are only ava ## added_to_project -The issue or pull request was added to a project board. {% data reusables.projects.disabled-projects %} +The issue or pull request was added to a {% data variables.projects.projects_v1_board %}. {% data reusables.projects.disabled-projects %} This event is available for the following issue types. @@ -247,7 +247,7 @@ This event is available for the following issue types. ## converted_note_to_issue -The issue was created by converting a note in a project board to an issue. {% data reusables.projects.disabled-projects %} +The issue was created by converting a note in a {% data variables.projects.projects_v1_board %} to an issue. {% data reusables.projects.disabled-projects %} This event is available for the following issue types. @@ -559,7 +559,7 @@ This event is available for the following issue types. ## moved_columns_in_project -The issue or pull request was moved between columns in a project board. {% data reusables.projects.disabled-projects %} +The issue or pull request was moved between columns in a {% data variables.projects.projects_v1_board %}. {% data reusables.projects.disabled-projects %} This event is available for the following issue types. @@ -638,7 +638,7 @@ This event is available for the following issue types. ## removed_from_project -The issue or pull request was removed from a project board. {% data reusables.projects.disabled-projects %} +The issue or pull request was removed from a {% data variables.projects.projects_v1_board %}. {% data reusables.projects.disabled-projects %} This event is available for the following issue types. diff --git a/content/rest/using-the-rest-api/using-pagination-in-the-rest-api.md b/content/rest/using-the-rest-api/using-pagination-in-the-rest-api.md index c1487dd269..b098d6282b 100644 --- a/content/rest/using-the-rest-api/using-pagination-in-the-rest-api.md +++ b/content/rest/using-the-rest-api/using-pagination-in-the-rest-api.md @@ -96,7 +96,7 @@ For example, this script gets all of the issues from the `octocat/Spoon-Knife` r ```javascript copy import { Octokit } from "octokit"; -const octokit = new Octokit({ {% ifversion ghes or ghae %} +const octokit = new Octokit({ {% ifversion ghes %} baseUrl: "{% data variables.product.api_url_code %}", {% endif %}}); @@ -123,7 +123,7 @@ The `getPaginatedData` function makes a request to an endpoint with `octokit.req ```javascript copy import { Octokit } from "octokit"; -const octokit = new Octokit({ {% ifversion ghes or ghae %} +const octokit = new Octokit({ {% ifversion ghes %} baseUrl: "{% data variables.product.api_url_code %}", {% endif %}}); diff --git a/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md b/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md index e6cdf23813..30b96dea84 100644 --- a/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md +++ b/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md @@ -42,7 +42,7 @@ After typing a search query, you can press **Enter** to go to the full search re {% ifversion fpt or ghes or ghec %} - {% data reusables.search.required_login %}{% endif %} - {% data variables.product.prodname_pages %} sites are not searchable on {% data variables.product.product_name %}. However you can search the source content if it exists in the default branch of a repository, using code search. For more information, see "[AUTOTITLE]{% ifversion code-search-code-view %}(/search-github/github-code-search/understanding-github-code-search-syntax){% else %}(/search-github/searching-on-github/searching-code){% endif %}." For more information about {% data variables.product.prodname_pages %}, see "[AUTOTITLE](/pages/getting-started-with-github-pages/about-github-pages)" -- Currently our search doesn't support exact matching.{% ifversion ghes or ghae %} +- Currently our search doesn't support exact matching.{% ifversion ghes %} - Whenever you are searching in code files, only the first two results in each file will be returned.{% endif %} {% endnote %} diff --git a/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md b/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md index 4491caa52a..c420e33189 100644 --- a/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md +++ b/content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md @@ -95,7 +95,7 @@ If your search query contains whitespace, you will need to surround it with quot - [cats NOT "hello world"](https://github.com/search?utf8=âś“&q=cats+NOT+"hello+world"&type=Repositories) matches repositories with the word "cats" but not the words "hello world." - [build label:"bug fix"](https://github.com/search?utf8=%E2%9C%93&q=build+label%3A%22bug+fix%22&type=Issues) matches issues with the word "build" that have the label "bug fix." -{% ifversion ghes or ghae %} Some non-alphanumeric symbols, such as spaces, are dropped from code search queries within quotation marks, so results can be unexpected.{% endif %} +{% ifversion ghes %} Some non-alphanumeric symbols, such as spaces, are dropped from code search queries within quotation marks, so results can be unexpected.{% endif %} ## Queries with usernames diff --git a/content/search-github/index.md b/content/search-github/index.md index 7067f23f45..ed0d2275a5 100644 --- a/content/search-github/index.md +++ b/content/search-github/index.md @@ -6,7 +6,7 @@ introLinks: featuredLinks: startHere: - /search-github/searching-on-github/searching-issues-and-pull-requests - - '{% ifversion ghes or ghae %}/search-github/searching-on-github/searching-code{% endif %}' + - '{% ifversion ghes %}/search-github/searching-on-github/searching-code{% endif %}' - /search-github/github-code-search/understanding-github-code-search-syntax - /search-github/searching-on-github/searching-for-repositories - /search-github/searching-on-github/searching-commits @@ -41,4 +41,3 @@ children: - /github-code-search shortTitle: Search on GitHub --- - diff --git a/content/search-github/searching-on-github/searching-in-forks.md b/content/search-github/searching-on-github/searching-in-forks.md index a45790fb23..525715744e 100644 --- a/content/search-github/searching-on-github/searching-in-forks.md +++ b/content/search-github/searching-on-github/searching-in-forks.md @@ -16,7 +16,7 @@ topics: To show forks in repository search results, add `fork:true` or `fork:only` to your query. For more information, see "[AUTOTITLE](/search-github/searching-on-github/searching-for-repositories)." -{% ifversion ghes or ghae %}Forks are only indexed for code search when they have more stars than the parent repository. You will not be able to search the code in a fork that has fewer stars than its parent. To show forks with more stars than the parent repository in code search results, add `fork:true` or `fork:only` to your query. For more information, see "[AUTOTITLE](/search-github/searching-on-github/searching-code)."{% endif %} +{% ifversion ghes %}Forks are only indexed for code search when they have more stars than the parent repository. You will not be able to search the code in a fork that has fewer stars than its parent. To show forks with more stars than the parent repository in code search results, add `fork:true` or `fork:only` to your query. For more information, see "[AUTOTITLE](/search-github/searching-on-github/searching-code)."{% endif %} {% note %} diff --git a/content/search-github/searching-on-github/searching-issues-and-pull-requests.md b/content/search-github/searching-on-github/searching-issues-and-pull-requests.md index 306179ff32..9d3b91717d 100644 --- a/content/search-github/searching-on-github/searching-issues-and-pull-requests.md +++ b/content/search-github/searching-on-github/searching-issues-and-pull-requests.md @@ -19,7 +19,7 @@ You can search for issues and pull requests globally across all of {% data varia {% tip %} -**Tips:**{% ifversion ghes or ghae %} +**Tips:**{% ifversion ghes %} - This article contains example searches on the {% data variables.product.prodname_dotcom %}.com website, but you can use the same search filters on {% data variables.location.product_location %}.{% endif %} - For a list of search syntaxes that you can add to any search qualifier to further improve your results, see "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)". - Use quotations around multi-word search terms. For example, if you want to search for issues with the label "In progress," you'd search for `label:"in progress"`. Search is not case sensitive. @@ -200,14 +200,14 @@ The `milestone` qualifier finds issues or pull requests that are a part of a [mi | milestone:MILESTONE | [**milestone:"overhaul"**](https://github.com/search?utf8=%E2%9C%93&q=milestone%3A%22overhaul%22&type=Issues) matches issues that are in a milestone named "overhaul." | milestone:MILESTONE | [**milestone:"bug fix"**](https://github.com/search?utf8=%E2%9C%93&q=milestone%3A%22bug+fix%22&type=Issues) matches issues that are in a milestone named "bug fix." -## Search by project board +## Search by project -You can use the `project` qualifier to find issues that are associated with a specific [project board](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards) in a repository or organization. You must search project boards by the project board number. You can find the project board number at the end of a project board's URL. +You can use the `project` qualifier to find issues that are associated with a specific project. You must search projects by the project number. You can find the project number at the end of a project's URL. | Qualifier | Example | ------------- | ------------- -| project:PROJECT_BOARD | **project:github/57** matches issues owned by GitHub that are associated with the organization's project board 57. -| project:REPOSITORY/PROJECT_BOARD | **project:github-linguist/linguist/1** matches issues that are associated with project board 1 in @github's linguist repository. +| project:PROJECT_NUMBER | **project:github/57** matches issues owned by GitHub that are associated with the organization's project 57. +| project:REPOSITORY/PROJECT_NUMBER | **project:github-linguist/linguist/1** matches issues that are associated with project 1 in @github's linguist repository. ## Search by commit status @@ -376,7 +376,7 @@ You can narrow your search to issues and pull requests that are missing certain | `no:label` | [**priority no:label**](https://github.com/search?q=priority+no%3Alabel&type=Issues) matches issues and pull requests with the word "priority" that also don't have any labels. | `no:milestone` | [**sprint no:milestone type:issue**](https://github.com/search?q=sprint+no%3Amilestone+type%3Aissue&type=Issues) matches issues not associated with a milestone containing the word "sprint." | `no:assignee` | [**important no:assignee language:java type:issue**](https://github.com/search?q=important+no%3Aassignee+language%3Ajava+type%3Aissue&type=Issues) matches issues not associated with an assignee, containing the word "important," and in Java repositories. -| `no:project` | [**build no:project**](https://github.com/search?utf8=%E2%9C%93&q=build+no%3Aproject&type=Issues) matches issues not associated with a project board, containing the word "build." +| `no:project` | [**build no:project**](https://github.com/search?utf8=%E2%9C%93&q=build+no%3Aproject&type=Issues) matches issues not associated with a {% data variables.projects.projects_v1_board %}, containing the word "build." ## Further reading diff --git a/content/site-policy/privacy-policies/github-candidate-privacy-policy.md b/content/site-policy/privacy-policies/github-candidate-privacy-policy.md index f1f51cba79..0f1f15a446 100644 --- a/content/site-policy/privacy-policies/github-candidate-privacy-policy.md +++ b/content/site-policy/privacy-policies/github-candidate-privacy-policy.md @@ -56,7 +56,7 @@ GitHub will share your Candidate Personal Information with those who have a legi 1. To comply with our legal obligations, regulations or contracts, or to respond to a court order, administrative or judicial process (such as subpoena, government audit or search warrant) or, in response to lawful requests by public authorities (such as national security or law enforcement); 1. As necessary to establish, exercise, or defend against potential or pending litigation; 1. Where necessary to protect GitHub, your vital interests (such as safety and security), or those of another person; or -1. With your consent (such to contact your referees). It is your responsibility to obtain consent from referees before providing their personal information to GitHub. +1. With your consent (such to contact your references). It is your responsibility to obtain consent from references before providing their personal information to GitHub. ## Your rights to your Candidate Personal Information diff --git a/content/site-policy/privacy-policies/github-subprocessors.md b/content/site-policy/privacy-policies/github-subprocessors.md index 1992acc3d0..39abe00890 100644 --- a/content/site-policy/privacy-policies/github-subprocessors.md +++ b/content/site-policy/privacy-policies/github-subprocessors.md @@ -23,22 +23,22 @@ To receive notifications of updates to this Subprocessor list, please follow the If you have questions about this list, please contact us at . -| Name of Subprocessor | Description of Processing | Location of Processing | Corporate Location | -| --------------------------- | ------------------------------------------------------------------------------ | ---------------------- | ------------------ | -| Amazon Web Services (AWS) | Cloud Hosted Infrastructure and Data Hosting | United States | United States | -| Azure (Microsoft) | Cloud Hosted Infrastructure and Data Hosting | United States | United States | -| Azure Cognitive Services | Customer support ticketing analysis | United States | United States | -| Cloudflare | Content delivery service | United States | United States | -| Fastly | Content delivery service | United States | United States | -| Google Cloud Platform (GCP) | Cloud Hosted Infrastructure | United States | United States | -| Microsoft | Technical Services | United States | United States | -| Moveworks | Customer support ticketing analysis | United States | United States | -| NexMo (aka Vonage) | SMS notification provider for 2 Factor Authentication | United States | United States | -| Obsidian Security | Security management | United States | United States | -| Pusher | Building and managing real-time infrastructure for web and mobile applications | United States | United States | -| SendGrid | SMS notification provider for 2 Factor Authentication | United States | United States | -| Splunk | Logging pipeline for security log, storage, and search | United States | United States | -| Twilio | SMS notification provider for 2 Factor Authentication | United States | United States | -| VividCortex | Monitor database performance, efficiency, and uptime | United States | United States | -| Zapier | App infrastructure and support | United States | United States | -| Zendesk | Customer support ticketing system | United States | United States | +| Name of Subprocessor | Description of Processing | Location of Processing | Corporate Location | +| --------------------------- | ------------------------------------------------------------------------------ | ----------------------- | ------------------ | +| Amazon Web Services (AWS) | Cloud Hosted Infrastructure and Data Hosting | United States | United States | +| Azure (Microsoft) | Cloud Hosted Infrastructure and Data Hosting | United States, France,
    Switzerland, and Japan | United States | +| Azure Cognitive Services | Customer support ticketing analysis | United States | United States | +| Cloudflare | Content delivery service | United States | United States | +| Fastly | Content delivery service | United States | United States | +| Google Cloud Platform (GCP) | Cloud Hosted Infrastructure | United States | United States | +| Microsoft | Technical Services | United States | United States | +| Moveworks | Customer support ticketing analysis | United States | United States | +| NexMo (aka Vonage) | SMS notification provider for 2 Factor Authentication | United States | United States | +| Obsidian Security | Security management | United States | United States | +| Pusher | Building and managing real-time infrastructure for web and mobile applications | United States | United States | +| SendGrid | SMS notification provider for 2 Factor Authentication | United States | United States | +| Splunk | Logging pipeline for security log, storage, and search | United States | United States | +| Twilio | SMS notification provider for 2 Factor Authentication | United States | United States | +| VividCortex | Monitor database performance, efficiency, and uptime | United States | United States | +| Zapier | App infrastructure and support | United States | United States | +| Zendesk | Customer support ticketing system | United States | United States | diff --git a/content/support/learning-about-github-support/about-github-premium-support.md b/content/support/learning-about-github-support/about-github-premium-support.md index 510f1a2994..c657f68476 100644 --- a/content/support/learning-about-github-support/about-github-premium-support.md +++ b/content/support/learning-about-github-support/about-github-premium-support.md @@ -125,7 +125,7 @@ If you don't receive an initial response within the guaranteed response time to The credit request must be made within 30 days of the end of the quarter during which {% data variables.contact.premium_support %} did not respond to your tickets within the designated response time. Credit requests will not be honored if the respective deadline has passed. Once the respective deadline passes, you have waived the ability to claim a refund for the qualified credit. Credit requests may take the form of a refund or credit to your account, cannot be exchanged into a cash amount, require you to have paid any outstanding invoices, and expire upon termination of your agreement with {% data variables.product.company_short %}. To receive a refund, you must submit a completed credit request to . To be eligible, the credit request must: -- Be sent from an email address associated with your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} +- Be sent from an email address associated with your account on {% data variables.location.product_location %} - Be received by {% data variables.product.company_short %} by the end of the 30th day after the quarter in which the four qualifying credits occurred - Include "Credit Request" in the subject line diff --git a/content/video-transcripts/index.md b/content/video-transcripts/index.md index 2c7536b550..c9597f8d5b 100644 --- a/content/video-transcripts/index.md +++ b/content/video-transcripts/index.md @@ -12,4 +12,5 @@ topics: children: - transcript-codespaces-your-instant-dev-box-in-the-cloud - transcript-using-projects-for-feature-planning + - transcript-billing-github-consumption-through-an-azure-subscription --- \ No newline at end of file diff --git a/content/video-transcripts/transcript-billing-github-consumption-through-an-azure-subscription.md b/content/video-transcripts/transcript-billing-github-consumption-through-an-azure-subscription.md new file mode 100644 index 0000000000..134cc58800 --- /dev/null +++ b/content/video-transcripts/transcript-billing-github-consumption-through-an-azure-subscription.md @@ -0,0 +1,94 @@ +--- +title: Transcript - "Billing GitHub consumption through an Azure subscription" +intro: Audio and visual transcript. +shortTitle: Billing through Azure +allowTitleToDifferFromFilename: true +product_video: 'https://www.youtube.com/watch?v=DAiIhJKCt8s' +topics: + - Transcripts +versions: + fpt: '*' + ghec: '*' +--- + +[Title card: "GitHub consolidated billing on Azure."] + +T.J.: Hello, everyone. Thank you for joining us to learn how you can bill your GitHub consumption through Azure. + +During this video, we will share the benefits of billing through Azure, review eligible GitHub products, demo the process step by step, and share resources to help you move forward. + +Let's start with why so many customers are already billing their GitHub consumption through Azure. The key benefits are consolidation, visibility, and commercials. + +From a consolidation standpoint, joint GitHub and Microsoft customers will be able to see all their GitHub consumption on their Azure invoice, eliminating the need for additional invoices and saving time on the procurement process. + +From a visibility perspective, GitHub customers will be able to leverage all the powerful tools and features of the Azure billing portal to gain enhanced visibility into their GitHub consumption spend. + +And finally, if a Microsoft customer has an Azure discount, it will automatically be applied to all future GitHub consumption billed through Azure. + +If a Microsoft customer also has a Microsoft Azure Consumption Commitment, or MACC, all future GitHub consumption will decrement their MACC as well. + +So what GitHub products are eligible for Azure billing? Any GitHub consumption products are eligible today, meaning products that customers pay for based on actual usage, including Copilot for Business, GitHub-hosted actions, larger hosted runners, GitHub Packages and storage, and GitHub Codespaces. Please note that GitHub Enterprise and GitHub Advanced Security are currently not able to be billed through Azure, but are instead invoiced on an annual basis. + +[A table shows eligibility for Azure billing and MACCs for the products mentioned. In the table, all products eligible for Azure billing are also eligible for MACCs.] + +T.J.: Now let's jump into a demo to see how to actually turn this on. + +[He shares his screen. He's on the home page of the Microsoft Azure portal.] + +T.J.: The first step in the process is to set up an admin consent workflow to allow your GitHub enterprise owner the ability to request the installation of a new application. This can be done by logging in to the Azure portal and opening up Microsoft Entra ID. + +From here, you'll need to click on "Enterprise Applications", and then under the "Security" section, "Consent and permissions". Finally, click "Admin consent settings". + +From here, you'll need to actually turn this on if it's not already enabled. So I'm going to go ahead and click "Yes". + +[In the settings, under "Users can request admin consent to apps they are unable to consent to", he switches a toggle to "Yes".] + +T.J.: And you'll need to add who has the ability to approve these requests. This would normally be yourself, the global admin, or potentially a team that you're a member of. + +Once you're happy with the settings, you can go ahead and click "Save". From here, you'll need to wait about an hour for these settings to replicate across Azure before you can proceed with the next step. + +Now I'll hand it over to the GitHub enterprise owner to actually request the application be installed. + +[The enterprise owner, Brian, shares his screen. He's looking at an enterprise account on GitHub.] + +Brian: So to start the process of linking an Azure subscription, I need to go to the settings for my enterprise, and underneath "Settings", you'll see there's an option here for billing. Then, under the various settings here, I'm going to go over to "Payment information", and finally "Add Azure Subscription". So I'm gonna click that link. + +[A Microsoft page: "Approval required".] + +Brian: Now once I sign in, it says approval is required from my Azure administrator, so I'm going to say, "Need to have GitHub paid," and let's select "Request approval". + +Now, at this point it says, "Hey, the request has been sent," so I'm gonna go back to my application and it's going to say, "Hey, we're not ready yet." + +[On the enterprise on GitHub, an error message says: "Authentication with Azure failed."] + +Brian: I'm going to go back into my subscription and I'm going to wait to hear from my administrator who will let me know when this is done. + +So now let's switch over back to T.J., and T.J., can you show us the approval process? + +[Back on the Azure portal.] + +T.J.: Your Entra global administrator should receive an email notification to approve a new request. To do so, they can go back into Entra ID, go to "Enterprise applications", and then look for "Admin consent requests" down under the "Activity" section. + +Here you'll see the pending request to install the GitHub Subscription Permission Validator. I can go ahead and click here and review the permissions and consent on behalf of my organization. + +It'll pop up asking me to reauthenticate, and then I can see the exact permissions that it's requesting. In this case, this application is just going to have access to see the users and be able to understand which subscriptions they're in ownership of to make sure that they have permissions to bill against it. + +So if I'm happy with this, I can go ahead and hit "Accept". And that's all I need to do. I can hand it back over to the GitHub enterprise owner to finish the last step. + +[Back in the enterprise on GitHub.] + +Brian: Okay. Well, I checked my email and my administrator approved from the Azure side that we can set up billing. So I'll go back into "Settings", go to "Billing" again, go to "Payment information", "Add Azure Subscription". + +[A dialog displays, labeled "Select a subscription".] + +Brian: Okay. Now that I've been authenticated, we see what subscription I'm hooking up to. I'm going to click it, click "Connect". + +[On the main "Payment information" page, under "Metered billing settings".] + +Brian: With my billing subscription selected, the last thing I need to do is select "Enable metered billing through Azure", and click "Update metered billing settings". + +At this point, the eligible items within my subscriptions, as we described earlier in the slides, will now be billed to the selected subscription. + +T.J.: Thanks so much for joining us today. For future reference, we are also sharing two helpful resources to help you bill GitHub consumption through Azure in the future. And if you have a dedicated GitHub and/or Microsoft account team, please don't hesitate to reach out to them for additional information. Thanks. + +End of transcript. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/billing/managing-the-plan-for-your-github-account/connecting-an-azure-subscription)" and [Get subscription and tenant IDs in the Azure portal](https://learn.microsoft.com/en-us/azure/azure-portal/get-subscription-tenant-id) in the Microsoft documentation. diff --git a/content/webhooks/testing-and-troubleshooting-webhooks/troubleshooting-webhooks.md b/content/webhooks/testing-and-troubleshooting-webhooks/troubleshooting-webhooks.md index 1587b8b439..b66cfab664 100644 --- a/content/webhooks/testing-and-troubleshooting-webhooks/troubleshooting-webhooks.md +++ b/content/webhooks/testing-and-troubleshooting-webhooks/troubleshooting-webhooks.md @@ -33,11 +33,11 @@ If you are not receiving the webhook deliveries that you expect, you should iden 1. Look at the logs for your server. The information in the logs depends on the code that your server runs to handle webhook deliveries. To help you diagnose problems on your server, you may want to add additional log statements to your code. -## Cannot have more than {% ifversion ghes or ghae %}250{% else %}20{% endif %} webhooks +## Cannot have more than {% ifversion ghes %}250{% else %}20{% endif %} webhooks -You can create up to {% ifversion ghes or ghae %}250{% else %}20{% endif %} {% ifversion ghec or ghes or ghae %} repository, organization, or global {% else %} repository or organization {% endif %}webhooks for each event type. If you attempt to create more, you will receive an error stating that you cannot have more than {% ifversion ghes or ghae %}250{% else %}20{% endif %} webhooks. +You can create up to {% ifversion ghes %}250{% else %}20{% endif %} {% ifversion ghec or ghes or ghae %} repository, organization, or global {% else %} repository or organization {% endif %}webhooks for each event type. If you attempt to create more, you will receive an error stating that you cannot have more than {% ifversion ghes %}250{% else %}20{% endif %} webhooks. -If you require more than {% ifversion ghes or ghae %}250{% else %}20{% endif %} webhooks, you can run a proxy that receives webhooks from {% data variables.product.company_short %} and forwards them to an unlimited number of destination URLs. +If you require more than {% ifversion ghes %}250{% else %}20{% endif %} webhooks, you can run a proxy that receives webhooks from {% data variables.product.company_short %} and forwards them to an unlimited number of destination URLs. ## URL host localhost is not supported diff --git a/content/webhooks/types-of-webhooks.md b/content/webhooks/types-of-webhooks.md index 5ee71c8814..aafca42ece 100644 --- a/content/webhooks/types-of-webhooks.md +++ b/content/webhooks/types-of-webhooks.md @@ -30,7 +30,7 @@ For more information, see "[AUTOTITLE](/webhooks/about-webhooks)." You can create webhooks in a repository to subscribe to events that occur in that repository. You must be a repository owner or have admin access in the repository to create and manage webhooks in a repository. You cannot create, edit, or delete webhooks in a repository where you do not have the required permissions. -You can create multiple webhooks in a single repository. However, you can only create up to {% ifversion ghes or ghae %}250{% else %}20{% endif %} webhooks that subscribe to each individual event type. For example, in a single repository you could only create up to {% ifversion ghes or ghae %}250{% else %}20{% endif %} different webhooks that each subscribe to the `push` event. +You can create multiple webhooks in a single repository. However, you can only create up to {% ifversion ghes %}250{% else %}20{% endif %} webhooks that subscribe to each individual event type. For example, in a single repository you could only create up to {% ifversion ghes %}250{% else %}20{% endif %} different webhooks that each subscribe to the `push` event. You can use the {% data variables.product.prodname_dotcom %} web interface or the REST API to manage repository webhooks. For more information, see "[AUTOTITLE](/webhooks/using-webhooks/creating-webhooks#creating-a-repository-webhook)," "[AUTOTITLE](/webhooks/using-webhooks/editing-webhooks#editing-a-repository-webhook)," and "[AUTOTITLE](/webhooks/using-webhooks/disabling-webhooks#disabling-a-repository-webhook)." For more information about using the REST API to manage repository webhooks, see "[AUTOTITLE](/rest/webhooks)." @@ -40,7 +40,7 @@ You can create webhooks in an organization to subscribe to events that occur in You must be an organization owner to create and manage webhooks in an organization. -You can create multiple webhooks in a single organization. However, you can only create up to {% ifversion ghes or ghae %}250{% else %}20{% endif %} webhooks that subscribe to each individual event type. For example, in a single organization you could only create up to {% ifversion ghes or ghae %}250{% else %}20{% endif %} different webhooks that each subscribe to the `push` event. +You can create multiple webhooks in a single organization. However, you can only create up to {% ifversion ghes %}250{% else %}20{% endif %} webhooks that subscribe to each individual event type. For example, in a single organization you could only create up to {% ifversion ghes %}250{% else %}20{% endif %} different webhooks that each subscribe to the `push` event. You can use the {% data variables.product.prodname_dotcom %} web interface or the REST API to manage organization webhooks. For more information, see "[AUTOTITLE](/webhooks/using-webhooks/creating-webhooks#creating-an-organization-webhook)," "[AUTOTITLE](/webhooks/using-webhooks/editing-webhooks#editing-an-organization-webhook)," and "[AUTOTITLE](/webhooks/using-webhooks/disabling-webhooks#disabling-an-organization-webhook)." For more information about using the REST API to manage organization webhooks, see "[AUTOTITLE](/rest/orgs/webhooks)." @@ -50,7 +50,7 @@ You can use the {% data variables.product.prodname_dotcom %} web interface or th Enterprise owners can create global webhooks to subscribe to events that occur within their enterprise or within organizations and repositories owned by the enterprise. -You can create multiple webhooks in a single enterprise. However, you can only create up to {% ifversion ghes or ghae %}250{% else %}20{% endif %} webhooks that subscribe to each individual event type. For example, in a single enterprise you could only create up to {% ifversion ghes or ghae %}250{% else %}20{% endif %} different webhooks that each subscribe to the `membership` event. +You can create multiple webhooks in a single enterprise. However, you can only create up to {% ifversion ghes %}250{% else %}20{% endif %} webhooks that subscribe to each individual event type. For example, in a single enterprise you could only create up to {% ifversion ghes %}250{% else %}20{% endif %} different webhooks that each subscribe to the `membership` event. You can use the {% data variables.product.prodname_dotcom %} web interface to manage global webhooks. For more information, see "[AUTOTITLE](/webhooks/using-webhooks/creating-webhooks#creating-a-global-webhook-for-a-github-enterprise)," "[AUTOTITLE](/webhooks/using-webhooks/editing-webhooks#editing-a-global-webhook-for-a-github-enterprise)," and "[AUTOTITLE](/webhooks/using-webhooks/disabling-webhooks#disabling-a-global-webhook-for-a-github-enterprise)." {% data reusables.enterprise_user_management.manage-global-webhooks-api %} @@ -68,7 +68,7 @@ You can use the {% data variables.product.prodname_dotcom %} web interface to ma ## {% data variables.product.prodname_sponsors %} webhooks -You can create webhooks to subscribe to events relating to {% data variables.product.prodname_sponsors %}. You can only create up to {% ifversion ghes or ghae %}250{% else %}20{% endif %} webhooks for a {% data variables.product.prodname_sponsors %} account. +You can create webhooks to subscribe to events relating to {% data variables.product.prodname_sponsors %}. You can only create up to {% ifversion ghes %}250{% else %}20{% endif %} webhooks for a {% data variables.product.prodname_sponsors %} account. You must be an account owner or have admin access in the sponsored account to manage sponsorship webhooks. diff --git a/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-github-app-webhook.md b/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-github-app-webhook.md index 7f47430386..8a651dac00 100644 --- a/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-github-app-webhook.md +++ b/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-github-app-webhook.md @@ -92,14 +92,14 @@ jobs: # - Replace `YOUR_PRIVATE_KEY_SECRET_NAME` with the name of the secret where you stored your private key. # - Replace `YOUR_TOKEN_SECRET_NAME` with the name of the secret where you stored your {% data variables.product.pat_generic %}. # - Replace `YOUR_LAST_REDELIVERY_VARIABLE_NAME` with the name that you want to use for a configuration variable that will be stored in the repository where this workflow is stored. The name can be any string that contains only alphanumeric characters and `_`, and does not start with `GITHUB_` or a number. For more information, see "[AUTOTITLE](/actions/learn-github-actions/variables#defining-configuration-variables-for-multiple-workflows)." - {% ifversion ghes or ghae %}# - Replace `YOUR_HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} + {% ifversion ghes %}# - Replace `YOUR_HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} - name: Run script env: APP_ID: {% raw %}${{ secrets.YOUR_APP_ID_SECRET_NAME }}{% endraw %} PRIVATE_KEY: {% raw %}${{ secrets.YOUR_PRIVATE_KEY_SECRET_NAME }}{% endraw %} TOKEN: {% raw %}${{ secrets.YOUR_TOKEN_SECRET_NAME }}{% endraw %} LAST_REDELIVERY_VARIABLE_NAME: 'YOUR_LAST_REDELIVERY_VARIABLE_NAME' - {% ifversion ghes or ghae %}HOSTNAME: 'YOUR_HOSTNAME'{% endif %} + {% ifversion ghes %}HOSTNAME: 'YOUR_HOSTNAME'{% endif %} WORKFLOW_REPO: {% raw %}${{ github.event.repository.name }}{% endraw %} WORKFLOW_REPO_OWNER: {% raw %}${{ github.repository_owner }}{% endraw %} run: | @@ -123,25 +123,25 @@ async function checkAndRedeliverWebhooks() { const PRIVATE_KEY = process.env.PRIVATE_KEY; const TOKEN = process.env.TOKEN; const LAST_REDELIVERY_VARIABLE_NAME = process.env.LAST_REDELIVERY_VARIABLE_NAME; - {% ifversion ghes or ghae %}const HOSTNAME = process.env.HOSTNAME;{% endif %} + {% ifversion ghes %}const HOSTNAME = process.env.HOSTNAME;{% endif %} const WORKFLOW_REPO_NAME = process.env.WORKFLOW_REPO; const WORKFLOW_REPO_OWNER = process.env.WORKFLOW_REPO_OWNER; - // Create an instance of the octokit `App` using the {% ifversion ghes or ghae %}app ID, private key, and hostname{% else %}app ID and private key{% endif %} values that were set in the {% data variables.product.prodname_actions %} workflow. + // Create an instance of the octokit `App` using the {% ifversion ghes %}app ID, private key, and hostname{% else %}app ID and private key{% endif %} values that were set in the {% data variables.product.prodname_actions %} workflow. // // This will be used to make API requests to the webhook-related endpoints. const app = new App({ appId: APP_ID, - privateKey: PRIVATE_KEY,{% ifversion ghes or ghae %} + privateKey: PRIVATE_KEY,{% ifversion ghes %} Octokit: Octokit.defaults({ baseUrl: "{% data variables.product.api_url_code %}", }),{% endif %} }); - // Create an instance of `Octokit` using the token{% ifversion ghes or ghae %} and hostname{% endif %} values that were set in the {% data variables.product.prodname_actions %} workflow. + // Create an instance of `Octokit` using the token{% ifversion ghes %} and hostname{% endif %} values that were set in the {% data variables.product.prodname_actions %} workflow. // // This will be used to update the configuration variable that stores the last time that this script ran. - const octokit = new Octokit({ {% ifversion ghes or ghae %} + const octokit = new Octokit({ {% ifversion ghes %} baseUrl: "{% data variables.product.api_url_code %}",{% endif %} auth: TOKEN, }); diff --git a/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-repository-webhook.md b/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-repository-webhook.md index acdcf6eee4..ea3248818f 100644 --- a/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-repository-webhook.md +++ b/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-repository-webhook.md @@ -89,7 +89,7 @@ jobs: # - Replace `YOUR_REPO_NAME` with the name of the repository where the webhook was created. # - Replace `YOUR_HOOK_ID` with the ID of the webhook. # - Replace `YOUR_LAST_REDELIVERY_VARIABLE_NAME` with the name that you want to use for a configuration variable that will be stored in the repository where this workflow is stored. The name can be any string that contains only alphanumeric characters and `_`, and does not start with `GITHUB_` or a number. For more information, see "[AUTOTITLE](/actions/learn-github-actions/variables#defining-configuration-variables-for-multiple-workflows)." - {% ifversion ghes or ghae %}# - Replace `YOUR_HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} + {% ifversion ghes %}# - Replace `YOUR_HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} - name: Run script env: TOKEN: {% raw %}${{ secrets.YOUR_SECRET_NAME }}{% endraw %} @@ -97,7 +97,7 @@ jobs: REPO_NAME: 'YOUR_REPO_NAME' HOOK_ID: 'YOUR_HOOK_ID' LAST_REDELIVERY_VARIABLE_NAME: 'YOUR_LAST_REDELIVERY_VARIABLE_NAME' - {% ifversion ghes or ghae %}HOSTNAME: 'YOUR_HOSTNAME'{% endif %} + {% ifversion ghes %}HOSTNAME: 'YOUR_HOSTNAME'{% endif %} WORKFLOW_REPO_NAME: {% raw %}${{ github.event.repository.name }}{% endraw %} WORKFLOW_REPO_OWNER: {% raw %}${{ github.repository_owner }}{% endraw %} run: | @@ -122,12 +122,12 @@ async function checkAndRedeliverWebhooks() { const REPO_NAME = process.env.REPO_NAME; const HOOK_ID = process.env.HOOK_ID; const LAST_REDELIVERY_VARIABLE_NAME = process.env.LAST_REDELIVERY_VARIABLE_NAME; - {% ifversion ghes or ghae %}const HOSTNAME = process.env.HOSTNAME;{% endif %} + {% ifversion ghes %}const HOSTNAME = process.env.HOSTNAME;{% endif %} const WORKFLOW_REPO_NAME = process.env.WORKFLOW_REPO_NAME; const WORKFLOW_REPO_OWNER = process.env.WORKFLOW_REPO_OWNER; - // Create an instance of `Octokit` using the token{% ifversion ghes or ghae %} and hostname{% endif %} values that were set in the {% data variables.product.prodname_actions %} workflow. - const octokit = new Octokit({ {% ifversion ghes or ghae %} + // Create an instance of `Octokit` using the token{% ifversion ghes %} and hostname{% endif %} values that were set in the {% data variables.product.prodname_actions %} workflow. + const octokit = new Octokit({ {% ifversion ghes %} baseUrl: "{% data variables.product.api_url_code %}",{% endif %} auth: TOKEN, }); diff --git a/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-an-organization-webhook.md b/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-an-organization-webhook.md index 5ff83e973f..5393438c90 100644 --- a/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-an-organization-webhook.md +++ b/content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-an-organization-webhook.md @@ -88,14 +88,14 @@ jobs: # - Replace `YOUR_ORGANIZATION_NAME` with the name of the organization where the webhook was created. # - Replace `YOUR_HOOK_ID` with the ID of the webhook. # - Replace `YOUR_LAST_REDELIVERY_VARIABLE_NAME` with the name that you want to use for a configuration variable that will be stored in the repository where this workflow is stored. The name can be any string that contains only alphanumeric characters and `_`, and does not start with `GITHUB_` or a number. For more information, see "[AUTOTITLE](/actions/learn-github-actions/variables#defining-configuration-variables-for-multiple-workflows)." - {% ifversion ghes or ghae %}# - Replace `YOUR_HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} + {% ifversion ghes %}# - Replace `YOUR_HOSTNAME` with the name of {% data variables.location.product_location %}.{% endif %} - name: Run script env: TOKEN: {% raw %}${{ secrets.YOUR_SECRET_NAME }}{% endraw %} ORGANIZATION_NAME: 'YOUR_ORGANIZATION_NAME' HOOK_ID: 'YOUR_HOOK_ID' LAST_REDELIVERY_VARIABLE_NAME: 'YOUR_LAST_REDELIVERY_VARIABLE_NAME' - {% ifversion ghes or ghae %}HOSTNAME: 'YOUR_HOSTNAME'{% endif %} + {% ifversion ghes %}HOSTNAME: 'YOUR_HOSTNAME'{% endif %} WORKFLOW_REPO_NAME: {% raw %}${{ github.event.repository.name }}{% endraw %} WORKFLOW_REPO_OWNER: {% raw %}${{ github.repository_owner }}{% endraw %} run: | @@ -119,12 +119,12 @@ async function checkAndRedeliverWebhooks() { const ORGANIZATION_NAME = process.env.ORGANIZATION_NAME; const HOOK_ID = process.env.HOOK_ID; const LAST_REDELIVERY_VARIABLE_NAME = process.env.LAST_REDELIVERY_VARIABLE_NAME; - {% ifversion ghes or ghae %}const HOSTNAME = process.env.HOSTNAME;{% endif %} + {% ifversion ghes %}const HOSTNAME = process.env.HOSTNAME;{% endif %} const WORKFLOW_REPO_NAME = process.env.WORKFLOW_REPO_NAME; const WORKFLOW_REPO_OWNER = process.env.WORKFLOW_REPO_OWNER; - // Create an instance of `Octokit` using the token{% ifversion ghes or ghae %} and hostname{% endif %} values that were set in the {% data variables.product.prodname_actions %} workflow. - const octokit = new Octokit({ {% ifversion ghes or ghae %} + // Create an instance of `Octokit` using the token{% ifversion ghes %} and hostname{% endif %} values that were set in the {% data variables.product.prodname_actions %} workflow. + const octokit = new Octokit({ {% ifversion ghes %} baseUrl: "{% data variables.product.api_url_code %}",{% endif %} auth: TOKEN, }); diff --git a/content/webhooks/using-webhooks/creating-webhooks.md b/content/webhooks/using-webhooks/creating-webhooks.md index b51b04ef9e..a074bb1b4e 100644 --- a/content/webhooks/using-webhooks/creating-webhooks.md +++ b/content/webhooks/using-webhooks/creating-webhooks.md @@ -71,7 +71,7 @@ After you create a new webhook, {% data variables.product.prodname_dotcom %} wil Enterprise owners can create a global webhook to subscribe to events that occur within their enterprise. -{% ifversion ghes or ghae %} +{% ifversion ghes %} You can use the {% data variables.product.company_short %} web interface or the REST API to create a global webhook. For more information about using the REST API to create a global webhook, see "[AUTOTITLE](/rest/enterprise-admin/global-webhooks)." diff --git a/content/webhooks/using-webhooks/disabling-webhooks.md b/content/webhooks/using-webhooks/disabling-webhooks.md index a12ab0665d..384e513054 100644 --- a/content/webhooks/using-webhooks/disabling-webhooks.md +++ b/content/webhooks/using-webhooks/disabling-webhooks.md @@ -17,7 +17,7 @@ topics: {% ifversion ghec %}You can disable a webhook that was previously enabled for a repository, organization, {% data variables.product.prodname_enterprise %}, {% data variables.product.prodname_marketplace %} account, {% data variables.product.prodname_sponsors %} account, or {% data variables.product.prodname_github_app %}.{% endif %} -{% ifversion ghes or ghae %}You can disable a webhook that was previously enabled for a repository, organization, {% data variables.product.prodname_enterprise %}, or {% data variables.product.prodname_github_app %}.{% endif %} +{% ifversion ghes %}You can disable a webhook that was previously enabled for a repository, organization, {% data variables.product.prodname_enterprise %}, or {% data variables.product.prodname_github_app %}.{% endif %} To disable a webhook, you can choose to deactivate or delete it. When you deactivate a webhook, the webhook deliveries will stop, and you can choose to reactivate the webhook at a later time. When you delete a webhook, it cannot be restored. @@ -52,7 +52,7 @@ You can use the {% data variables.product.prodname_dotcom %} web interface or th Enterprise owners can disable a global webhook in an {% data variables.product.prodname_enterprise %}. -{% ifversion ghes or ghae %} +{% ifversion ghes %} You can use the {% data variables.product.company_short %} web interface or the REST API to disable a global webhook. For more information about using the REST API to disable a global webhook, see "[AUTOTITLE](/rest/enterprise-admin/global-webhooks)." diff --git a/content/webhooks/using-webhooks/editing-webhooks.md b/content/webhooks/using-webhooks/editing-webhooks.md index 194700bd62..5121b8ea2e 100644 --- a/content/webhooks/using-webhooks/editing-webhooks.md +++ b/content/webhooks/using-webhooks/editing-webhooks.md @@ -47,7 +47,7 @@ You can use the {% data variables.product.prodname_dotcom %} web interface or th Enterprise owners can edit a global webhook to change any of the settings that were selected when the webhook was initially created. -{% ifversion ghes or ghae %} +{% ifversion ghes %} You can use the {% data variables.product.company_short %} web interface or the REST API to edit a global webhook. For more information about using the REST API to edit a global webhook, see "[AUTOTITLE](/rest/enterprise-admin/global-webhooks)." diff --git a/content/webhooks/using-webhooks/handling-failed-webhook-deliveries.md b/content/webhooks/using-webhooks/handling-failed-webhook-deliveries.md index ff44d4d9f0..9680f4a9a3 100644 --- a/content/webhooks/using-webhooks/handling-failed-webhook-deliveries.md +++ b/content/webhooks/using-webhooks/handling-failed-webhook-deliveries.md @@ -26,7 +26,7 @@ You can also write a script that checks for failed deliveries and attempts to re 1. Use the {% data variables.product.company_short %} REST API to fetch data about any webhook deliveries that were attempted since the last time that your script ran. For more information, see "[AUTOTITLE](/rest/webhooks/repo-deliveries#list-deliveries-for-a-repository-webhook)," "[AUTOTITLE](/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook)," and "[AUTOTITLE](/rest/apps/webhooks#list-deliveries-for-an-app-webhook)." - {% ifversion fpt %}There are no API endpoints to get data about {% data variables.product.prodname_marketplace %} webhooks or {% data variables.product.prodname_sponsors %} webhooks.{% endif %}{% ifversion ghec %}There are no API endpoints to get data about {% data variables.product.prodname_marketplace %} webhooks, {% data variables.product.prodname_sponsors %} webhooks, or global webhooks.{% endif %}{% ifversion ghes or ghae %}There are no API endpoints to get data about global webhook deliveries.{% endif %} + {% ifversion fpt %}There are no API endpoints to get data about {% data variables.product.prodname_marketplace %} webhooks or {% data variables.product.prodname_sponsors %} webhooks.{% endif %}{% ifversion ghec %}There are no API endpoints to get data about {% data variables.product.prodname_marketplace %} webhooks, {% data variables.product.prodname_sponsors %} webhooks, or global webhooks.{% endif %}{% ifversion ghes %}There are no API endpoints to get data about global webhook deliveries.{% endif %} 1. Look at the fetched data to see if any deliveries failed. The data for a failed delivery will have a `status` value that is not `OK`. 1. Use the {% data variables.product.company_short %} REST API to redeliver any deliveries that failed. For more information, see "[AUTOTITLE](/rest/webhooks/repo-deliveries#redeliver-a-delivery-for-a-repository-webhook)," "[AUTOTITLE](/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook)," and "[AUTOTITLE](/rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook)." diff --git a/content/webhooks/webhook-events-and-payloads.md b/content/webhooks/webhook-events-and-payloads.md index 406a89dda6..de0b98b32f 100644 --- a/content/webhooks/webhook-events-and-payloads.md +++ b/content/webhooks/webhook-events-and-payloads.md @@ -38,7 +38,7 @@ HTTP POST payloads that are delivered to your webhook's configured URL endpoint - `X-GitHub-Hook-ID`: The unique identifier of the webhook. - `X-GitHub-Event`: The name of the event that triggered the delivery. -- `X-GitHub-Delivery`: A globally unique identifier (GUID) to identify the delivery.{% ifversion ghes or ghae %} +- `X-GitHub-Delivery`: A globally unique identifier (GUID) to identify the delivery.{% ifversion ghes %} - `X-GitHub-Enterprise-Version`: The version of the {% data variables.product.prodname_ghe_server %} instance that sent the HTTP POST payload. - `X-GitHub-Enterprise-Host`: The hostname of the {% data variables.product.prodname_ghe_server %} instance that sent the HTTP POST payload.{% endif %}{% ifversion not ghae %} - `X-Hub-Signature`: This header is sent if the webhook is configured with a `secret`. This is the HMAC hex digest of the request body, and is generated using the SHA-1 hash function and the `secret` as the HMAC `key`. `X-Hub-Signature` is provided for compatibility with existing integrations. We recommend that you use the more secure `X-Hub-Signature-256` instead.{% endif %} @@ -56,7 +56,7 @@ You can choose to have payloads delivered in JSON format (`application/json`) or ```shell > POST /payload HTTP/2 -> X-GitHub-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958{% ifversion ghes or ghae %} +> X-GitHub-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958{% ifversion ghes %} > X-GitHub-Enterprise-Version: 2.15.0 > X-GitHub-Enterprise-Host: example.com{% endif %}{% ifversion not ghae %} > X-Hub-Signature: sha1=7d38cdd689735b008b3c702edd92eea23791c5f6{% endif %} diff --git a/contributing/translations-for-translators.md b/contributing/translations-for-translators.md index 51b02e4614..b0f2e26f64 100644 --- a/contributing/translations-for-translators.md +++ b/contributing/translations-for-translators.md @@ -19,31 +19,3 @@ We do not accept translation changes from open source contributors. - [ ] Do not translate anything inside of Liquid tags, such as `{% data %}` or `{% ifversion ... %}`, `{% note %}` or `{{ someVariable }}`. - [ ] Be sure to translate the frontmatter properties `title`, `shortTitle`, `intro`, `permissions` but leave all other keys in each content `.md` file - [ ] For every `{% ifversion ... %}` there's a `{% endif %}` following it - -## Error diagnosis - -We provide error reports that we upload daily. - -
    -Report locations - -We have both "latest" or date in 'yyyy-mm-dd' format for historical reference. - -- https://githubdocs.blob.core.windows.net/translation-health-reports/es-latest.json -- https://githubdocs.blob.core.windows.net/translation-health-reports/es-2023-01-05.json -- https://githubdocs.blob.core.windows.net/translation-health-reports/ja-latest.json -- https://githubdocs.blob.core.windows.net/translation-health-reports/ja-2023-01-05.json -- https://githubdocs.blob.core.windows.net/translation-health-reports/pt-latest.json -- https://githubdocs.blob.core.windows.net/translation-health-reports/pt-2023-01-05.json -- https://githubdocs.blob.core.windows.net/translation-health-reports/zh-latest.json -- https://githubdocs.blob.core.windows.net/translation-health-reports/zh-2023-01-05.json -- https://githubdocs.blob.core.windows.net/translation-health-reports/ru-latest.json -- https://githubdocs.blob.core.windows.net/translation-health-reports/ru-2023-01-05.json -- https://githubdocs.blob.core.windows.net/translation-health-reports/ko-latest.json -- https://githubdocs.blob.core.windows.net/translation-health-reports/ko-2023-01-05.json -- https://githubdocs.blob.core.windows.net/translation-health-reports/fr-latest.json -- https://githubdocs.blob.core.windows.net/translation-health-reports/fr-2023-01-05.json -- https://githubdocs.blob.core.windows.net/translation-health-reports/de-latest.json -- https://githubdocs.blob.core.windows.net/translation-health-reports/de-2023-01-05.json - -
    diff --git a/data/features/README.md b/data/features/README.md index 355b51af43..e57fb62e1b 100644 --- a/data/features/README.md +++ b/data/features/README.md @@ -1,4 +1,4 @@ -## Feature-based versioning +# Feature-based versioning Feature-based versioning allows us to define and control the versions of an arbitrarily named "feature" in one place. @@ -15,7 +15,6 @@ versions: fpt: '*' ghec: '*' ghes: '>3.1' - ghae: '*' ``` The format and allowed values are the same as the [frontmatter versions property](/content#versions). @@ -40,7 +39,7 @@ You cannot use `feature:` to specify multiple concurrent versions, as this is no ## Schema enforcement -The schema for validating the feature versioning lives in [`src/content-linter/lib/feature-versions-schema.js`](src/content-linter/lib/feature-versions-schema.js) and is exercised by [`tests/linting/lint-versioning.js`](tests/linting/lint-versioning.js). +The schema for validating the feature versioning lives in [`src/data-directory/lib/data-schemas/features.js`](../../src/data-directory/lib/data-schemas/features.js). ## Script to remove feature tags diff --git a/data/features/classic-project-visibility-permissions-or-projects-v2.yml b/data/features/classic-project-visibility-permissions-or-projects-v2.yml index 32feb60808..5e043e3ff7 100644 --- a/data/features/classic-project-visibility-permissions-or-projects-v2.yml +++ b/data/features/classic-project-visibility-permissions-or-projects-v2.yml @@ -1,5 +1,5 @@ # Issue 7720 -# Organization owners can restrict public classic projects /OR/ Projects V2 +# Organization owners can restrict public projects (classic) /OR/ Projects V2 versions: fpt: '*' ghec: '*' diff --git a/data/features/classic-project-visibility-permissions.yml b/data/features/classic-project-visibility-permissions.yml index 9e921ee199..4378df58b1 100644 --- a/data/features/classic-project-visibility-permissions.yml +++ b/data/features/classic-project-visibility-permissions.yml @@ -1,5 +1,5 @@ # Issue 7720 -# Organization owners can restrict public classic projects. +# Organization owners can restrict public projects (classic) versions: fpt: '*' ghec: '*' diff --git a/data/features/projects-v1-create-repo-project.yml b/data/features/projects-v1-create-repo-project.yml index d095bd44f4..8feb2a9cc8 100644 --- a/data/features/projects-v1-create-repo-project.yml +++ b/data/features/projects-v1-create-repo-project.yml @@ -1,3 +1,3 @@ -# Ability to create new repository level classic projects +# Ability to create new repository level projects (classic) versions: ghes: '*' diff --git a/data/features/projects-v2-migration.yml b/data/features/projects-v2-migration.yml index 2fbce03ddd..985704535a 100644 --- a/data/features/projects-v2-migration.yml +++ b/data/features/projects-v2-migration.yml @@ -1,4 +1,4 @@ -# Migrating from classic projects +# Migrating from projects (classic) versions: fpt: '*' ghec: '*' diff --git a/data/features/projects-v2-status-updates.yml b/data/features/projects-v2-status-updates.yml new file mode 100644 index 0000000000..eaec23c0f8 --- /dev/null +++ b/data/features/projects-v2-status-updates.yml @@ -0,0 +1,6 @@ +# Issue 12678 +# Status updates +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.13' diff --git a/data/graphql/ghae/schema.docs-ghae.graphql b/data/graphql/ghae/schema.docs-ghae.graphql index 5d9eb5fb65..0007478eb5 100644 --- a/data/graphql/ghae/schema.docs-ghae.graphql +++ b/data/graphql/ghae/schema.docs-ghae.graphql @@ -45317,6 +45317,11 @@ type UnpinIssuePayload { """ clientMutationId: String + """ + The id of the pinned issue that was unpinned + """ + id: ID + """ The issue that was unpinned """ diff --git a/data/graphql/ghec/schema.docs.graphql b/data/graphql/ghec/schema.docs.graphql index 78850cd818..7e22600889 100644 --- a/data/graphql/ghec/schema.docs.graphql +++ b/data/graphql/ghec/schema.docs.graphql @@ -56033,6 +56033,11 @@ type UnpinIssuePayload { """ clientMutationId: String + """ + The id of the pinned issue that was unpinned + """ + id: ID + """ The issue that was unpinned """ diff --git a/data/graphql/schema.docs.graphql b/data/graphql/schema.docs.graphql index 78850cd818..7e22600889 100644 --- a/data/graphql/schema.docs.graphql +++ b/data/graphql/schema.docs.graphql @@ -56033,6 +56033,11 @@ type UnpinIssuePayload { """ clientMutationId: String + """ + The id of the pinned issue that was unpinned + """ + id: ID + """ The issue that was unpinned """ diff --git a/data/release-notes/enterprise-server/3-11/2.yml b/data/release-notes/enterprise-server/3-11/2.yml index a168ed64d1..9a269718fc 100644 --- a/data/release-notes/enterprise-server/3-11/2.yml +++ b/data/release-notes/enterprise-server/3-11/2.yml @@ -3,14 +3,6 @@ sections: bugs: - When an instance is upgraded with a hotpatch, the instance may lose network connectivity after a reboot. known_issues: - - | - An upgrade to GitHub Enterprise Server 3.11 may fail, hanging on the "Reloading system services" screen. The following error will appear in `/var/log/syslog`. - - ```text - agent: Error starting agent: error="Failed to start Consul server: Failed to start Raft: failed to load any existing snapshots" - ``` - - To address this issue, [contact GitHub Support](https://support.github.com/contact). - | Custom firewall rules are removed during the upgrade process. - | diff --git a/data/release-notes/enterprise-server/3-8/12.yml b/data/release-notes/enterprise-server/3-8/12.yml index a44ca3e259..5b2e1054f2 100644 --- a/data/release-notes/enterprise-server/3-8/12.yml +++ b/data/release-notes/enterprise-server/3-8/12.yml @@ -25,6 +25,7 @@ sections: **MEDIUM**: An incorrect authorization vulnerability was identified that allowed issue comments to be updated with an improperly scoped token. This vulnerability did not allow unauthorized access to any repository content as it also required `contents.write` and `issues.read` permissions. This vulnerability was reported via the [GitHub Bug Bounty Program](https://bounty.github.com/) and has been assigned [CVE-2023-51379](https://www.cve.org/CVERecord?id=CVE-2023-51379). - | **MEDIUM**: An incorrect authorization vulnerability was identified that allowed issue comments to be read with an improperly scoped token. This vulnerability was reported via the [GitHub Bug Bounty Program](https://bounty.github.com/) and has been assigned [CVE-2023-51380](https://www.cve.org/CVERecord?id=CVE-2023-51380). + - | **LOW:** Pre-receive hooks have been further hardened against shell command injections. - | **LOW:** To render interactive maps in an instance's web UI using Azure Maps, GitHub Enterprise Server has migrated from use of an unsecure Azure Maps API token to a more secure access token provided by role-based access control (RBAC) in Entra ID. After upgrading to this release, to re-enable interactive maps, an administrator must reconfigure authentication to Azure Maps in the Management Console. For more information, see "[AUTOTITLE](/admin/configuration/configuring-user-applications-for-your-enterprise/configuring-interactive-maps)." diff --git a/data/reusables/actions/about-oidc-short-overview.md b/data/reusables/actions/about-oidc-short-overview.md index 6d975ab96f..9e62e3e0d1 100644 --- a/data/reusables/actions/about-oidc-short-overview.md +++ b/data/reusables/actions/about-oidc-short-overview.md @@ -1,4 +1,2 @@ If your {% data variables.product.prodname_actions %} workflows need to access resources from a cloud provider that supports OpenID Connect (OIDC), you can configure your workflows to authenticate directly to the cloud provider. This will let you stop storing these credentials as long-lived secrets and provide other security benefits. For more information, see "[AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)" - -{% data reusables.actions.oidc-custom-claims-aws-restriction %} diff --git a/data/reusables/actions/action-download-artifact.md b/data/reusables/actions/action-download-artifact.md index 11694395b5..5361ac71ad 100644 --- a/data/reusables/actions/action-download-artifact.md +++ b/data/reusables/actions/action-download-artifact.md @@ -1 +1 @@ -actions/download-artifact@v3 +actions/download-artifact@v4 diff --git a/data/reusables/actions/action-upload-artifact.md b/data/reusables/actions/action-upload-artifact.md index 248c970f06..8376b96609 100644 --- a/data/reusables/actions/action-upload-artifact.md +++ b/data/reusables/actions/action-upload-artifact.md @@ -1 +1 @@ -actions/upload-artifact@v3 +actions/upload-artifact@v4 diff --git a/data/reusables/actions/allow-specific-actions-intro.md b/data/reusables/actions/allow-specific-actions-intro.md index 72985b2292..62bc46f16f 100644 --- a/data/reusables/actions/allow-specific-actions-intro.md +++ b/data/reusables/actions/allow-specific-actions-intro.md @@ -6,11 +6,11 @@ When you choose {% data reusables.actions.policy-label-for-select-actions-workflows %}, local actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} are allowed, and there are additional options for allowing other specific actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %}: - **Allow actions created by {% data variables.product.prodname_dotcom %}:** You can allow all actions created by {% data variables.product.prodname_dotcom %} to be used by workflows. Actions created by {% data variables.product.prodname_dotcom %} are located in the `actions` and `github` organizations. For more information, see the [`actions`](https://github.com/actions) and [`github`](https://github.com/github) organizations. -- **Allow Marketplace actions by verified creators:** {% ifversion ghes or ghae %}This option is available if you have {% data variables.product.prodname_github_connect %} enabled and configured with {% data variables.product.prodname_actions %}. For more information, see "[AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect)."{% endif %} You can allow all {% data variables.product.prodname_marketplace %} actions created by verified creators to be used by workflows. When GitHub has verified the creator of the action as a partner organization, the {% octicon "verified" aria-label="The verified badge" %} badge is displayed next to the action in {% data variables.product.prodname_marketplace %}. +- **Allow Marketplace actions by verified creators:** {% ifversion ghes %}This option is available if you have {% data variables.product.prodname_github_connect %} enabled and configured with {% data variables.product.prodname_actions %}. For more information, see "[AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect)."{% endif %} You can allow all {% data variables.product.prodname_marketplace %} actions created by verified creators to be used by workflows. When GitHub has verified the creator of the action as a partner organization, the {% octicon "verified" aria-label="The verified badge" %} badge is displayed next to the action in {% data variables.product.prodname_marketplace %}. - **Allow specified actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %}:** You can restrict workflows to use actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} in specific organizations and repositories. Specified actions cannot be set to more than 1000. To restrict access to specific tags or commit SHAs of an action{% ifversion actions-workflow-policy %} or reusable workflow{% endif %}, use the same syntax used in the workflow to select the action{% ifversion actions-workflow-policy %} or reusable workflow{% endif %}. - + - For an action, the syntax is `OWNER/REPOSITORY@TAG-OR-SHA`. For example, use `actions/javascript-action@v1.0.1` to select a tag or `actions/javascript-action@a824008085750b8e136effc585c3cd6082bd575f` to select a SHA. For more information, see "[AUTOTITLE](/actions/learn-github-actions/finding-and-customizing-actions#using-release-management-for-your-custom-actions)." {%- ifversion actions-workflow-policy %} - For a reusable workflow, the syntax is `OWNER/REPOSITORY/PATH/FILENAME@TAG-OR-SHA`. For example, `octo-org/another-repo/.github/workflows/workflow.yml@v1`. For more information, see "[AUTOTITLE](/actions/using-workflows/reusing-workflows#calling-a-reusable-workflow)." diff --git a/data/reusables/actions/creating-a-runner-group-for-an-enterprise.md b/data/reusables/actions/creating-a-runner-group-for-an-enterprise.md index 27ef4d27ad..66f89442da 100644 --- a/data/reusables/actions/creating-a-runner-group-for-an-enterprise.md +++ b/data/reusables/actions/creating-a-runner-group-for-an-enterprise.md @@ -9,7 +9,7 @@ Always include a security admonition above this procedure. This is either one of Enterprises can add their runners to groups for access management. Enterprises can create groups of runners that are accessible to specific organizations in the enterprise account{% ifversion restrict-groups-to-workflows %} or to specific workflows{% endif %}. Organization owners can then assign additional granular repository{% ifversion restrict-groups-to-workflows %} or workflow{% endif %} access policies to the enterprise runner groups. For information about how to create a runner group with the REST API, see the enterprise endpoints in the [{% data variables.product.prodname_actions %} REST API](/rest/actions#self-hosted-runner-groups). -If no group is specified during the registration process, runners are automatically added to a default group. You can later move the runner from the default group to a custom group. For more information, see "Moving a runner to a group." +If no group is specified during the registration process, runners are automatically added to a default group. You can later move the runner from the default group to a custom group. For more information, see "[Moving a runner to a group](#moving-a-runner-to-a-group)." When creating a group, you must choose a policy that defines which organizations have access to the runner group. diff --git a/data/reusables/actions/disabling-github-actions.md b/data/reusables/actions/disabling-github-actions.md index ef2c62fe2f..5600ce0f01 100644 --- a/data/reusables/actions/disabling-github-actions.md +++ b/data/reusables/actions/disabling-github-actions.md @@ -1 +1 @@ -By default, {% ifversion ghes or ghae %}after {% data variables.product.prodname_actions %} is enabled on {% data variables.location.product_location %}, it{% elsif fpt or ghec %}{% data variables.product.prodname_actions %}{% endif %} is enabled on all repositories and organizations. You can choose to disable {% data variables.product.prodname_actions %} or limit it to actions {% ifversion actions-workflow-policy %}and reusable workflows{% endif %} in your {% ifversion ghec or ghes or ghae %}enterprise{% else %}organization{% endif %}. +By default, {% ifversion ghes %}after {% data variables.product.prodname_actions %} is enabled on {% data variables.location.product_location %}, it{% elsif fpt or ghec %}{% data variables.product.prodname_actions %}{% endif %} is enabled on all repositories and organizations. You can choose to disable {% data variables.product.prodname_actions %} or limit it to actions {% ifversion actions-workflow-policy %}and reusable workflows{% endif %} in your {% ifversion ghec or ghes or ghae %}enterprise{% else %}organization{% endif %}. diff --git a/data/reusables/actions/jobs/section-choosing-the-runner-for-a-job.md b/data/reusables/actions/jobs/section-choosing-the-runner-for-a-job.md index 6e054e5d95..be4487c684 100644 --- a/data/reusables/actions/jobs/section-choosing-the-runner-for-a-job.md +++ b/data/reusables/actions/jobs/section-choosing-the-runner-for-a-job.md @@ -55,9 +55,64 @@ Use `jobs..runs-on` to define the type of machine to run the job on. If you use a {% data variables.product.prodname_dotcom %}-hosted runner, each job runs in a fresh instance of a runner image specified by `runs-on`. -Available {% data variables.product.prodname_dotcom %}-hosted runner types are: +Available {% data variables.product.prodname_dotcom %}-hosted runner labels are: -{% data reusables.actions.supported-github-runners %} + + + + + + + + + + + + + + + + + + + + + + + + + +
    OS (YAML workflow label)Notes
    +ubuntu-latest, ubuntu-22.04, ubuntu-20.04 + +The ubuntu-latest label currently uses the Ubuntu 22.04 runner image. +
    +windows-latest, windows-2022, windows-2019 + +The windows-latest label currently uses the Windows 2022 runner image. +
    +macos-latest, macos-12, macos-11 + +The macos-latest workflow label currently uses the macOS 12 runner image. +
    +macos-13 [Beta] + +N/A +
    + +For more information about {% data variables.product.prodname_dotcom %}-hosted runner specifications, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources)." + +{% note %} + +**Note:** The `-latest` runner images are the latest stable images that {% data variables.product.prodname_dotcom %} provides, and might not be the most recent version of the operating system available from the operating system vendor. + +{% endnote %} + +{% warning %} + +**Warning:** Beta and Deprecated Images are provided "as-is", "with all faults" and "as available" and are excluded from the service level agreement and warranty. Beta Images may not be covered by customer support. + +{% endwarning %} #### Example: Specifying an operating system diff --git a/data/reusables/actions/oidc-custom-claims-aws-restriction.md b/data/reusables/actions/oidc-custom-claims-aws-restriction.md index 77c4bf8d96..509622dbeb 100644 --- a/data/reusables/actions/oidc-custom-claims-aws-restriction.md +++ b/data/reusables/actions/oidc-custom-claims-aws-restriction.md @@ -1,5 +1,5 @@ {% note %} -**Note:** support for custom claims for OIDC is unavailable in AWS. +**Note:** Support for custom claims for OIDC is unavailable in AWS. {% endnote %} diff --git a/data/reusables/actions/self-hosted-runner-ports-protocols.md b/data/reusables/actions/self-hosted-runner-ports-protocols.md index fa711b3cb3..97bd3c2723 100644 --- a/data/reusables/actions/self-hosted-runner-ports-protocols.md +++ b/data/reusables/actions/self-hosted-runner-ports-protocols.md @@ -1,3 +1,3 @@ -{% ifversion ghes or ghae %} +{% ifversion ghes %} The connection between self-hosted runners and {% data variables.product.product_name %} is over {% ifversion ghes %}HTTP (port 80) or {% endif %}HTTPS (port 443). {% ifversion ghes %}To ensure connectivity over HTTPS, configure TLS for {% data variables.location.product_location %}. For more information, see "[AUTOTITLE](/admin/configuration/configuring-network-settings/configuring-tls)."{% endif %} {% endif %} diff --git a/data/reusables/actions/supported-github-runners.md b/data/reusables/actions/supported-github-runners.md index 15ddc20d25..15745e47d4 100644 --- a/data/reusables/actions/supported-github-runners.md +++ b/data/reusables/actions/supported-github-runners.md @@ -1,3 +1,9 @@ + + +### Standard {% data variables.product.prodname_dotcom %}-hosted runners for Public repositories + +For public repositories, jobs utilizing the default YAML workflow labels listed in the table below run on virtual machines with the associated specifications. The use of these runners on public repositories is free and unlimited. + @@ -15,6 +21,103 @@ Linux + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +4 + +16 GB + +150 GB + +ubuntu-latest, ubuntu-22.04, ubuntu-20.04 + +The ubuntu-latest label currently uses the Ubuntu 22.04 runner image. +
    +Windows + +4 +16 GB + +150 GB + +windows-latest, windows-2022, windows-2019 + +The windows-latest label currently uses the Windows 2022 runner image. +
    +macOS + +3 + +14 GB + +14 GB + +macos-latest, macos-12, macos-11 + +The macos-latest workflow label currently uses the macOS 12 runner image. +
    +macOS + +4 + +14 GB + +14 GB + +macos-13[Beta] + +N/A +
    + +### Standard {% data variables.product.prodname_dotcom %}-hosted runners for Private repositories + +For private repositories, jobs utilizing the default YAML workflow labels listed in the table below run on virtual machines with the associated specifications. These runners use your {% data variables.product.prodname_dotcom %} account's allotment of free minutes, and are then charged at the per minute rates. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-actions/about-billing-for-github-actions#per-minute-rates)." + + + + + + + + + + + + + + +
    Virtual MachineProcessor (CPU)Memory (RAM)Storage (SSD)OS (YAML workflow label)Notes
    +Linux + 2 @@ -83,7 +186,7 @@ macOS 14 GB -macos-13 [Beta] +macos-13[Beta] N/A @@ -91,15 +194,3 @@ N/A
    - -{% note %} - -**Note:** The `-latest` runner images are the latest stable images that {% data variables.product.prodname_dotcom %} provides, and might not be the most recent version of the operating system available from the operating system vendor. - -{% endnote %} - -{% warning %} - -**Warning:** Beta and Deprecated Images are provided "as-is", "with all faults" and "as available" and are excluded from the service level agreement and warranty. Beta Images may not be covered by customer support. - -{% endwarning %} diff --git a/data/reusables/advanced-security/security-feature-availability.md b/data/reusables/advanced-security/security-feature-availability.md index ef965ceae3..9141e7dbcf 100644 --- a/data/reusables/advanced-security/security-feature-availability.md +++ b/data/reusables/advanced-security/security-feature-availability.md @@ -1 +1 @@ -Some features are available for {% ifversion ghes or ghae %}all repositories{% elsif fpt or ghec %}repositories on all plans{% endif %}. Additional features are available to enterprises that use {% data variables.product.prodname_GH_advanced_security %}. {% ifversion fpt or ghec %}{% data variables.product.prodname_GH_advanced_security %} features are also enabled for all public repositories on {% data variables.product.prodname_dotcom_the_website %}.{% endif %} {% data reusables.advanced-security.more-info-ghas %} +Some features are available for {% ifversion ghes %}all repositories{% elsif fpt or ghec %}repositories on all plans{% endif %}. Additional features are available to enterprises that use {% data variables.product.prodname_GH_advanced_security %}. {% ifversion fpt or ghec %}{% data variables.product.prodname_GH_advanced_security %} features are also enabled for all public repositories on {% data variables.product.prodname_dotcom_the_website %}.{% endif %} {% data reusables.advanced-security.more-info-ghas %} diff --git a/data/reusables/advisory-database/github-reviewed-overview.md b/data/reusables/advisory-database/github-reviewed-overview.md new file mode 100644 index 0000000000..14aedbcd90 --- /dev/null +++ b/data/reusables/advisory-database/github-reviewed-overview.md @@ -0,0 +1 @@ +{% data variables.product.company_short %}-reviewed advisories are security vulnerabilities that have been mapped to packages in ecosystems we support. We carefully review each advisory for validity and ensure that they have a full description, and contain both ecosystem and package information. diff --git a/data/reusables/advisory-database/malware-overview.md b/data/reusables/advisory-database/malware-overview.md new file mode 100644 index 0000000000..dc53151352 --- /dev/null +++ b/data/reusables/advisory-database/malware-overview.md @@ -0,0 +1 @@ +Malware advisories relate to vulnerabilities caused by malware, and are security advisories that {% data variables.product.prodname_dotcom %} publishes automatically into the {% data variables.product.prodname_advisory_database %}, directly from information provided by the npm security team. Malware advisories are exclusive to the npm ecosystem. {% data variables.product.prodname_dotcom %} doesn't edit or accept community contributions on these advisories. diff --git a/data/reusables/advisory-database/unreviewed-overview.md b/data/reusables/advisory-database/unreviewed-overview.md new file mode 100644 index 0000000000..6ab33614a2 --- /dev/null +++ b/data/reusables/advisory-database/unreviewed-overview.md @@ -0,0 +1 @@ +Unreviewed advisories are security vulnerabilities that we publish automatically into the {% data variables.product.prodname_advisory_database %}, directly from the National Vulnerability Database feed. diff --git a/data/reusables/apps/deprecating_auth_with_query_parameters.md b/data/reusables/apps/deprecating_auth_with_query_parameters.md index 70b201d9fc..5dcb8b4407 100644 --- a/data/reusables/apps/deprecating_auth_with_query_parameters.md +++ b/data/reusables/apps/deprecating_auth_with_query_parameters.md @@ -2,6 +2,6 @@ **Deprecation Notice:** {% data variables.product.prodname_dotcom %} will discontinue authentication to the API using query parameters. Authenticating to the API should be done with [HTTP basic authentication](/rest/overview/authenticating-to-the-rest-api#using-basic-authentication).{% ifversion fpt or ghec %} Using query parameters to authenticate to the API will no longer work on May 5, 2021. {% endif %} For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/). -{% ifversion ghes or ghae %} Authentication to the API using query parameters while available is no longer supported due to security concerns. Instead we recommend integrators move their access token, `client_id`, or `client_secret` in the header. {% data variables.product.prodname_dotcom %} will announce the removal of authentication by query parameters with advanced notice. {% endif %} +{% ifversion ghes %} Authentication to the API using query parameters while available is no longer supported due to security concerns. Instead we recommend integrators move their access token, `client_id`, or `client_secret` in the header. {% data variables.product.prodname_dotcom %} will announce the removal of authentication by query parameters with advanced notice. {% endif %} {% endwarning %} diff --git a/data/reusables/audit_log/audit-log-action-categories.md b/data/reusables/audit_log/audit-log-action-categories.md index d7bbb485e0..59f9d9a827 100644 --- a/data/reusables/audit_log/audit-log-action-categories.md +++ b/data/reusables/audit_log/audit-log-action-categories.md @@ -106,7 +106,7 @@ | `organization_default_label` | Contains activities related to default labels for repositories in an organization. {%- ifversion fpt or ghec or ghes %} | `organization_domain` | Contains activities related to verified organization domains. -| `organization_projects_change` | Contains activities related to organization-wide project boards in an enterprise. +| `organization_projects_change` | Contains activities related to organization-wide {% data variables.projects.projects_v1_boards %} in an enterprise. {%- endif %} {%- ifversion fpt or ghec %} | `pages_protected_domain` | Contains activities related to verified custom domains for {% data variables.product.prodname_pages %}. @@ -124,9 +124,9 @@ {%- ifversion fpt or ghec %} | `profile_picture` | Contains activities related to an organization's profile picture. {%- endif %} -| `project` | Contains activities related to project boards. -| `project_field` | Contains activities related to field creation and deletion in a project board. -| `project_view` | Contains activities related to view creation and deletion in a project board. +| `project` | Contains activities related to projects. +| `project_field` | Contains activities related to field creation and deletion in a project. +| `project_view` | Contains activities related to view creation and deletion in a project. | `protected_branch` | Contains activities related to protected branches. | `public_key` | Contains activities related to SSH keys and deploy keys. | `pull_request` | Contains activities related to pull requests. diff --git a/data/reusables/audit_log/audit-log-search-by-repo.md b/data/reusables/audit_log/audit-log-search-by-repo.md index 477159be63..e37783b24e 100644 --- a/data/reusables/audit_log/audit-log-search-by-repo.md +++ b/data/reusables/audit_log/audit-log-search-by-repo.md @@ -2,7 +2,7 @@ Use the `repo` qualifier to limit actions to a specific repository. For example: -{%- ifversion ghes or ghae %} +{%- ifversion ghes %} - `repo:"my-org/our-repo"` finds all events that occurred for the `our-repo` repository in the `my-org` organization. - `repo:"my-org/our-repo" repo:"my-org/another-repo"` finds all events that occurred for both the `our-repo` and `another-repo` repositories in the `my-org` organization. - `-repo:"my-org/not-this-repo"` excludes all events that occurred for the `not-this-repo` repository in the `my-org` organization. diff --git a/data/reusables/billing/billing-hosted-runners.md b/data/reusables/billing/billing-hosted-runners.md index d3b3042009..83f516063b 100644 --- a/data/reusables/billing/billing-hosted-runners.md +++ b/data/reusables/billing/billing-hosted-runners.md @@ -11,6 +11,6 @@ | Windows | 16 | $0.128 | | Windows | 32 | $0.256 | | Windows | 64 | $0.512 | -| macOS | 3 or 4 | $0.08 | +| macOS | 3 or 4 (M1 or Intel) | $0.08 | | macOS | 12 | $0.12 | | macOS | 6 (M1) | $0.16 | diff --git a/data/reusables/code-scanning/codeql-action-version-ghes.md b/data/reusables/code-scanning/codeql-action-version-ghes.md index 3dcbf5daf0..40bd35011d 100644 --- a/data/reusables/code-scanning/codeql-action-version-ghes.md +++ b/data/reusables/code-scanning/codeql-action-version-ghes.md @@ -1,4 +1,4 @@ -{% ifversion ghes or ghae %} +{% ifversion ghes %} {% note %} diff --git a/data/reusables/codeql-cli/download-codeql-cli-zip.md b/data/reusables/codeql-cli/download-codeql-cli-zip.md index 2ba9445c16..f0e0fb2a18 100644 --- a/data/reusables/codeql-cli/download-codeql-cli-zip.md +++ b/data/reusables/codeql-cli/download-codeql-cli-zip.md @@ -9,7 +9,7 @@ You should download the {% data variables.product.prodname_codeql %} bundle from - A compatible version of the queries and libraries from https://github.com/github/codeql - Precompiled versions of all the queries included in the bundle -{% ifversion ghes or ghae %} +{% ifversion ghes %} {% note %} For {% data variables.product.product_name %}{% ifversion ghes %} {{ allVersions[currentVersion].currentRelease }}{% endif %}, we recommend {% data variables.product.prodname_codeql_cli %} version {% data variables.product.codeql_cli_ghes_recommended_version %}. diff --git a/data/reusables/dependabot/dependabot-alerts-dependency-graph-enterprise.md b/data/reusables/dependabot/dependabot-alerts-dependency-graph-enterprise.md index 3fdebf70bc..168833580d 100644 --- a/data/reusables/dependabot/dependabot-alerts-dependency-graph-enterprise.md +++ b/data/reusables/dependabot/dependabot-alerts-dependency-graph-enterprise.md @@ -1,2 +1,2 @@ -{% ifversion ghes or ghae %} +{% ifversion ghes %} Enterprise owners can configure {% ifversion ghes %}the dependency graph and {% endif %}{% data variables.product.prodname_dependabot_alerts %} for an enterprise. For more information, see {% ifversion ghes %}"[AUTOTITLE](/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise)" and {% endif %}"[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)."{% endif %} diff --git a/data/reusables/dependabot/no-dependabot-alerts-for-malware.md b/data/reusables/dependabot/no-dependabot-alerts-for-malware.md new file mode 100644 index 0000000000..95bfbf3f27 --- /dev/null +++ b/data/reusables/dependabot/no-dependabot-alerts-for-malware.md @@ -0,0 +1,5 @@ +{% ifversion GH-advisory-db-supports-malware %} + +{% data variables.product.prodname_dependabot %} doesn't generate {% data variables.product.prodname_dependabot_alerts %} for malware. For more information, see "[AUTOTITLE](/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-the-github-advisory-database#malware-advisories)." + +{% endif %} diff --git a/data/reusables/dependency-review/action-enterprise.md b/data/reusables/dependency-review/action-enterprise.md index a4594a9171..090c5be312 100644 --- a/data/reusables/dependency-review/action-enterprise.md +++ b/data/reusables/dependency-review/action-enterprise.md @@ -1,3 +1,3 @@ -{% ifversion ghes or ghae %} +{% ifversion ghes %} Enterprise owners and people with admin access to a repository can add the {% data variables.dependency-review.action_name %} to their enterprise and repository, respectively. {% endif %} diff --git a/data/reusables/emus/guest-collaborators-note.md b/data/reusables/emus/guest-collaborators-note.md new file mode 100644 index 0000000000..aa962136ec --- /dev/null +++ b/data/reusables/emus/guest-collaborators-note.md @@ -0,0 +1,8 @@ +{% note %} + +**Notes:** + +- The guest collaborator feature is currently in public beta and subject to change. +- The guest collaborator role is only available with {% data variables.product.prodname_emus %}. + +{% endnote %} diff --git a/data/reusables/enterprise-accounts/access-enterprise.md b/data/reusables/enterprise-accounts/access-enterprise.md index 4e00ef33fa..281297cf90 100644 --- a/data/reusables/enterprise-accounts/access-enterprise.md +++ b/data/reusables/enterprise-accounts/access-enterprise.md @@ -3,6 +3,6 @@ 1. In the list of enterprises, click the enterprise you want to view. -{%- elsif ghes or ghae %} +{%- elsif ghes %} {% data reusables.enterprise-accounts.access-enterprise-ghes %} {%- endif %} diff --git a/data/reusables/enterprise-accounts/options-tab.md b/data/reusables/enterprise-accounts/options-tab.md index db4daa0312..61a5d80fc4 100644 --- a/data/reusables/enterprise-accounts/options-tab.md +++ b/data/reusables/enterprise-accounts/options-tab.md @@ -1 +1 @@ -1. Under {% ifversion ghes or ghae %} {% octicon "law" aria-hidden="true" %} **Policies**{% else %}"{% octicon "gear" aria-hidden="true" %} Settings"{% endif %}, click **Options**. +1. Under {% ifversion ghes %} {% octicon "law" aria-hidden="true" %} **Policies**{% else %}"{% octicon "gear" aria-hidden="true" %} Settings"{% endif %}, click **Options**. diff --git a/data/reusables/enterprise_installation/changing-hostname-not-supported.md b/data/reusables/enterprise_installation/changing-hostname-not-supported.md index 7d9e1fb748..2f73ba70e7 100644 --- a/data/reusables/enterprise_installation/changing-hostname-not-supported.md +++ b/data/reusables/enterprise_installation/changing-hostname-not-supported.md @@ -1,5 +1,5 @@ {% warning %} -**Warning**: Do not change the hostname for {% data variables.product.prodname_ghe_server %} after initial setup. Changing the hostname will cause unexpected behavior, up to and including instance outages. If you have changed the hostname for your instance and are experiencing problems, contact GitHub Enterprise Support or GitHub Premium Support. +**Warning**: Do not change the hostname for {% data variables.product.prodname_ghe_server %} after initial setup. Changing the hostname will cause unexpected behavior, up to and including instance outages and invalidation of users' security keys. If you have changed the hostname for your instance and are experiencing problems, contact {% data variables.contact.enterprise_support %} or {% data variables.contact.premium_support %}. {% endwarning %} diff --git a/data/reusables/enterprise_site_admin_settings/business.md b/data/reusables/enterprise_site_admin_settings/business.md index 294572aa66..8f069750cb 100644 --- a/data/reusables/enterprise_site_admin_settings/business.md +++ b/data/reusables/enterprise_site_admin_settings/business.md @@ -1 +1 @@ -1. In the left sidebar, click **Enterprise{% ifversion ghes or ghae %} overview{% endif %}**. +1. In the left sidebar, click **Enterprise{% ifversion ghes %} overview{% endif %}**. diff --git a/data/reusables/enterprise_user_management/manage-global-webhooks-api.md b/data/reusables/enterprise_user_management/manage-global-webhooks-api.md index e7812fd30d..104275e125 100644 --- a/data/reusables/enterprise_user_management/manage-global-webhooks-api.md +++ b/data/reusables/enterprise_user_management/manage-global-webhooks-api.md @@ -1,3 +1,3 @@ -{% ifversion ghes or ghae %} +{% ifversion ghes %} You can also use the REST API to manage global webhooks. For a complete list of endpoints, see "[AUTOTITLE](/rest/enterprise-admin/global-webhooks)." {% endif %} diff --git a/data/reusables/getting-started/configuring-security-features.md b/data/reusables/getting-started/configuring-security-features.md index fda18241c1..666b0a16a8 100644 --- a/data/reusables/getting-started/configuring-security-features.md +++ b/data/reusables/getting-started/configuring-security-features.md @@ -1 +1 @@ -To keep {% ifversion ghes or ghae %}the organizations in {% data variables.location.product_location %}{% else %}your organization{% endif %} secure, you can use a variety of {% data variables.product.prodname_dotcom %} security features, including security policies, dependency graphs, secret scanning and Dependabot security and version updates. For more information, see "[AUTOTITLE](/code-security/getting-started/securing-your-organization)" and "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization)." +To keep {% ifversion ghes %}the organizations in {% data variables.location.product_location %}{% else %}your organization{% endif %} secure, you can use a variety of {% data variables.product.prodname_dotcom %} security features, including security policies, dependency graphs, secret scanning and Dependabot security and version updates. For more information, see "[AUTOTITLE](/code-security/getting-started/securing-your-organization)" and "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization)." diff --git a/data/reusables/getting-started/giving-access-to-repositories-projects-apps.md b/data/reusables/getting-started/giving-access-to-repositories-projects-apps.md index feb8c445b0..c9b44a9aa1 100644 --- a/data/reusables/getting-started/giving-access-to-repositories-projects-apps.md +++ b/data/reusables/getting-started/giving-access-to-repositories-projects-apps.md @@ -1,3 +1,3 @@ You can give organization members, teams, and outside collaborators different levels of access to repositories owned by your organization with repository roles. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization)." -You can also customize access to your organization's project boards and allow individual organization members to manage your organization's {% data variables.product.prodname_github_apps %}. For more information, see "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards)" and "[AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization)." +You can also customize access to your organization's projects and allow individual organization members to manage your organization's {% data variables.product.prodname_github_apps %}. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects)," "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards)," and "[AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization)." diff --git a/data/reusables/getting-started/set-up-git.md b/data/reusables/getting-started/set-up-git.md index 4900b28f29..0d593bd574 100644 --- a/data/reusables/getting-started/set-up-git.md +++ b/data/reusables/getting-started/set-up-git.md @@ -1 +1 @@ -Synchronizing {% data variables.product.prodname_dotcom %} repositories with your computer allows you to work locally and push your changes to {% data variables.product.prodname_dotcom %}. For more information, see “[Set up Git](/get-started/quickstart/set-up-git).” +Synchronizing {% data variables.product.prodname_dotcom %} repositories with your computer allows you to work locally and push your changes to {% data variables.product.prodname_dotcom %}. For more information, see “[Set up Git](/get-started/getting-started-with-git/set-up-git).” diff --git a/data/reusables/gist/anonymous-gists-cannot-be-deleted.md b/data/reusables/gist/anonymous-gists-cannot-be-deleted.md index 331f4fe843..08240b2448 100644 --- a/data/reusables/gist/anonymous-gists-cannot-be-deleted.md +++ b/data/reusables/gist/anonymous-gists-cannot-be-deleted.md @@ -1,4 +1,4 @@ -{% ifversion ghes or ghae %} +{% ifversion ghes %} {% warning %} **Warning:** Anonymous gists cannot be deleted from the web browser. To have an anonymous gist deleted, contact {% data variables.contact.contact_support %}. Please provide the URL of the gist you wish to delete. diff --git a/data/reusables/notifications/outbound_email_tip.md b/data/reusables/notifications/outbound_email_tip.md index e8f714d69a..b8f39b8511 100644 --- a/data/reusables/notifications/outbound_email_tip.md +++ b/data/reusables/notifications/outbound_email_tip.md @@ -1,4 +1,4 @@ -{% ifversion ghes or ghae %} +{% ifversion ghes %} {% note %} **Note**: You'll only receive email notifications if outbound email support is enabled on {% data variables.location.product_location %}. For more information, contact your site administrator. diff --git a/data/reusables/notifications/vulnerable-dependency-notification-options.md b/data/reusables/notifications/vulnerable-dependency-notification-options.md index 151022cb11..7aaf3182ff 100644 --- a/data/reusables/notifications/vulnerable-dependency-notification-options.md +++ b/data/reusables/notifications/vulnerable-dependency-notification-options.md @@ -1,4 +1,4 @@ -{% ifversion fpt or ghec %}By default, you will receive notifications:{% endif %}{% ifversion ghes or ghae %}By default, if your enterprise owner has configured email for notifications on your instance, you will receive {% data variables.product.prodname_dependabot_alerts %}:{% endif %} +{% ifversion fpt or ghec %}By default, you will receive notifications:{% endif %}{% ifversion ghes %}By default, if your enterprise owner has configured email for notifications on your instance, you will receive {% data variables.product.prodname_dependabot_alerts %}:{% endif %} - in your inbox, as web notifications. A web notification is sent when {% data variables.product.prodname_dependabot %} is enabled for a repository, when a new manifest file is committed to the repository, and when a new vulnerability with a critical or high severity is found (**On {% data variables.product.prodname_dotcom %}** option). - by email, an email is sent when {% data variables.product.prodname_dependabot %} is enabled for a repository, when a new manifest file is committed to the repository, and when a new vulnerability with a critical or high severity is found (**Email** option).{% ifversion ghae < 3.8 %} diff --git a/data/reusables/package_registry/docker_registry_deprecation_status.md b/data/reusables/package_registry/docker_registry_deprecation_status.md index fda36cc7e9..df327c3f24 100644 --- a/data/reusables/package_registry/docker_registry_deprecation_status.md +++ b/data/reusables/package_registry/docker_registry_deprecation_status.md @@ -1,5 +1,5 @@ {% warning %} -**Note:** The {% data variables.product.prodname_registry %} Docker registry {% ifversion ghes or ghae %} will be superseded in a future {% data variables.product.product_name %} release with the {% data variables.product.prodname_container_registry %}, which offers improved container support.{% elsif fpt %} is superseded by the {% data variables.product.prodname_container_registry %}, which offers improved container support. {% endif %} {% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)." {% endif %} +**Note:** The {% data variables.product.prodname_registry %} Docker registry {% ifversion ghes %} will be superseded in a future {% data variables.product.product_name %} release with the {% data variables.product.prodname_container_registry %}, which offers improved container support.{% elsif fpt %} is superseded by the {% data variables.product.prodname_container_registry %}, which offers improved container support. {% endif %} {% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)." {% endif %} {% endwarning %} diff --git a/data/reusables/package_registry/package-settings-options-menu.md b/data/reusables/package_registry/package-settings-options-menu.md index b11a59103e..62dc049232 100644 --- a/data/reusables/package_registry/package-settings-options-menu.md +++ b/data/reusables/package_registry/package-settings-options-menu.md @@ -1,4 +1,4 @@ -{% ifversion ghes or ghae %} +{% ifversion ghes %} 1. On the left click **Options**. ![Screenshot of a package's "Options" menu. In the lower right corner, "Options" is highlighted with an orange outline.](/assets/images/help/package-registry/packages-settings-options-menu.png) {% endif %} diff --git a/data/reusables/pages/build-failure-email-server.md b/data/reusables/pages/build-failure-email-server.md index 89e9253b46..a381bc2e03 100644 --- a/data/reusables/pages/build-failure-email-server.md +++ b/data/reusables/pages/build-failure-email-server.md @@ -1,4 +1,4 @@ -{% ifversion ghes or ghae %} +{% ifversion ghes %} {% tip %} You will only receive an email if outbound email support is enabled on {% data variables.location.product_location %}. For more information, contact your site administrator. diff --git a/data/reusables/pre-release-program/starfox-preview.md b/data/reusables/pre-release-program/starfox-preview.md index aca22eee88..93fd99ab54 100644 --- a/data/reusables/pre-release-program/starfox-preview.md +++ b/data/reusables/pre-release-program/starfox-preview.md @@ -2,7 +2,7 @@ **Note:** Project card details are now shown in REST API responses for project-related issue and timeline events. This feature is now available for developers to preview. For details, see the [blog post](https://developer.github.com/changes/2018-09-05-project-card-events). -To receive the `project_card` attribute, project boards must be [enabled](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header: +To receive the `project_card` attribute, {% data variables.projects.projects_v1_boards %} must be [enabled](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository) for a repository, and you must provide a custom [media type](/rest/overview/media-types) in the `Accept` header: ```text application/vnd.github.starfox-preview+json diff --git a/data/reusables/profile/access_profile.md b/data/reusables/profile/access_profile.md index 4ffe9b8b43..5cbbd19316 100644 --- a/data/reusables/profile/access_profile.md +++ b/data/reusables/profile/access_profile.md @@ -1,4 +1,4 @@ -1. {% ifversion fpt or ghec %}In the top right corner of {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_name %}{% endif %}, click your profile photo, then click **Your profile**.{% endif %} +1. In the top right corner of {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_name %}{% endif %}, click your profile photo, then click **Your profile**. {% ifversion global-nav-update %} diff --git a/data/reusables/project-management/add-column-new-project.md b/data/reusables/project-management/add-column-new-project.md index b6cd2ae07b..17269bea7f 100644 --- a/data/reusables/project-management/add-column-new-project.md +++ b/data/reusables/project-management/add-column-new-project.md @@ -1 +1 @@ -1. On your new project board, to add your first column, **Add a column**. +1. On your new {% data variables.projects.projects_v1_board %}, to add your first column, **Add a column**. diff --git a/data/reusables/project-management/choose-template.md b/data/reusables/project-management/choose-template.md index 6979185464..f1215bff84 100644 --- a/data/reusables/project-management/choose-template.md +++ b/data/reusables/project-management/choose-template.md @@ -1 +1 @@ -1. Optionally, to add a template to your project board, use the **Template:** drop-down menu and click a template. +1. Optionally, to add a template to your {% data variables.projects.projects_v1_board %}, use the **Template:** drop-down menu and click a template. diff --git a/data/reusables/project-management/choose-visibility.md b/data/reusables/project-management/choose-visibility.md index cad83ff9b9..40cdb3fae8 100644 --- a/data/reusables/project-management/choose-visibility.md +++ b/data/reusables/project-management/choose-visibility.md @@ -1 +1 @@ -1. Under "Visibility", choose to make your project board {% ifversion ghae %}internal{% else %}public{% endif %} or private. For more information, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility)." +1. Under "Visibility", choose to make your {% data variables.projects.projects_v1_board %} {% ifversion ghae %}internal{% else %}public{% endif %} or private. For more information, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/changing-project-board-visibility)." diff --git a/data/reusables/project-management/create-project-name-description.md b/data/reusables/project-management/create-project-name-description.md index e6367e8cb5..1bf40bc6dc 100644 --- a/data/reusables/project-management/create-project-name-description.md +++ b/data/reusables/project-management/create-project-name-description.md @@ -1 +1 @@ -1. Type a name and description for your project board. +1. Type a name and description for your {% data variables.projects.projects_v1_board %}. diff --git a/data/reusables/project-management/edit-project-columns.md b/data/reusables/project-management/edit-project-columns.md index c532ecf40d..fdbbde77f4 100644 --- a/data/reusables/project-management/edit-project-columns.md +++ b/data/reusables/project-management/edit-project-columns.md @@ -1,5 +1,5 @@ {% tip %} -**Tip:** To edit or remove a column from your project board, in the upper-right corner of the column, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}. +**Tip:** To edit or remove a column from your {% data variables.projects.projects_v1_board %}, in the upper-right corner of the column, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}. {% endtip %} diff --git a/data/reusables/project-management/for-more-info-project-keyboard-shortcuts.md b/data/reusables/project-management/for-more-info-project-keyboard-shortcuts.md index f838b15b97..9465991464 100644 --- a/data/reusables/project-management/for-more-info-project-keyboard-shortcuts.md +++ b/data/reusables/project-management/for-more-info-project-keyboard-shortcuts.md @@ -1 +1 @@ -For more information about keyboard shortcuts, see "Project boards" in "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts#project-boards)." +For more information about keyboard shortcuts, see "{% data variables.projects.projects_v1_boards_caps %}" in "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts#project-boards)." diff --git a/data/reusables/project-management/linked-repositories.md b/data/reusables/project-management/linked-repositories.md index 80ce41e26a..1b64c0f70b 100644 --- a/data/reusables/project-management/linked-repositories.md +++ b/data/reusables/project-management/linked-repositories.md @@ -1 +1 @@ -1. Optionally, under **Linked repositories**, search for a repository you'd like to link to your project board. +1. Optionally, under **Linked repositories**, search for a repository you'd like to link to your {% data variables.projects.projects_v1_board %}. diff --git a/data/reusables/project-management/project-board-import-with-api.md b/data/reusables/project-management/project-board-import-with-api.md index 5070f24289..f711eabde2 100644 --- a/data/reusables/project-management/project-board-import-with-api.md +++ b/data/reusables/project-management/project-board-import-with-api.md @@ -1 +1 @@ -You can use {% data variables.product.prodname_dotcom %}'s API to import a project board. For more information, see "[AUTOTITLE](/graphql/reference/mutations#importproject/)." +You can use {% data variables.product.prodname_dotcom %}'s API to import a {% data variables.projects.projects_v1_board %}. For more information, see "[AUTOTITLE](/graphql/reference/mutations#importproject/)." diff --git a/data/reusables/projects/classic-project-creation.md b/data/reusables/projects/classic-project-creation.md index 84152dfa91..29c15666ca 100644 --- a/data/reusables/projects/classic-project-creation.md +++ b/data/reusables/projects/classic-project-creation.md @@ -2,7 +2,7 @@ {% note %} -**Note:** You can only create a new classic project board for an organization, user, or repository that already has at least one classic project board. If you're unable to create a classic project board, create a beta project board instead. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project)." +**Note:** You can only create a new {% data variables.projects.projects_v1_board %} for an organization, user, or repository that already has at least one {% data variables.projects.projects_v1_board %}. If you're unable to create a {% data variables.projects.projects_v1_board %}, create a {% data variables.projects.project_v2 %} instead. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project)." {% endnote %} diff --git a/data/reusables/projects/disabled-projects.md b/data/reusables/projects/disabled-projects.md index 4e197f27dd..4bfe1f8cf8 100644 --- a/data/reusables/projects/disabled-projects.md +++ b/data/reusables/projects/disabled-projects.md @@ -1 +1 @@ -You only see this event in responses when project boards have been [enabled](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository) in the repository. +You only see this event in responses when {% data variables.projects.projects_v1_boards %} have been [enabled](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository) in the repository. diff --git a/data/reusables/projects/project_boards_old.md b/data/reusables/projects/project_boards_old.md index d18fb9b34b..3acc58a179 100644 --- a/data/reusables/projects/project_boards_old.md +++ b/data/reusables/projects/project_boards_old.md @@ -4,7 +4,7 @@ **Notes:** - {% data variables.product.prodname_projects_v2 %}, the all-new projects experience, is now available. For more information about {% data variables.product.prodname_projects_v2 %}, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects){% ifversion projects-v2-migration %}" and for information about migrating your {% data variables.projects.projects_v1_board %}, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/creating-projects/migrating-from-projects-classic){% endif %}." -- You can only create a new classic project board for an organization{% ifversion projects-v1-create-repo-project %}, repository, {% endif %} or user that already has at least one classic project board. {% ifversion projects-v1-create-repo-project %}{% else %} You cannot create new classic projects for repositories. {% endif %} If you're unable to create a classic project board, create a project instead. +- You can only create a new {% data variables.projects.projects_v1_board %} for an organization{% ifversion projects-v1-create-repo-project %}, repository, {% endif %} or user that already has at least one {% data variables.projects.projects_v1_board %}. {% ifversion projects-v1-create-repo-project %}{% else %} You cannot create new {% data variables.projects.projects_v1_boards %} for repositories. {% endif %} If you're unable to create a {% data variables.projects.projects_v1_board %}, create a project instead. {% endnote %} diff --git a/data/reusables/pull_requests/pull_request_merges_and_contributions.md b/data/reusables/pull_requests/pull_request_merges_and_contributions.md index 81bef02ac8..974e28e726 100644 --- a/data/reusables/pull_requests/pull_request_merges_and_contributions.md +++ b/data/reusables/pull_requests/pull_request_merges_and_contributions.md @@ -1,6 +1,6 @@ {% note %} -**Notes:**{% ifversion ghes or ghae %} +**Notes:**{% ifversion ghes %} - To appear on your profile contributions graph, co-authored commits must meet the same criteria as commits with one author.{% endif %} - When rebasing commits, the original authors of the commit and the person who rebased the commits, whether on the command line or on {% data variables.location.product_location %}, receive contribution credit.{% ifversion ghec or fpt %} - If you merged multiple personal accounts, issues, pull requests, and discussions will not be attributed to the new account and will not appear on your contribution graph.{% endif %} diff --git a/data/reusables/repositories/assign-an-issue-as-project-maintainer.md b/data/reusables/repositories/assign-an-issue-as-project-maintainer.md index 36d7f4e5e6..f4adfbf8fc 100644 --- a/data/reusables/repositories/assign-an-issue-as-project-maintainer.md +++ b/data/reusables/repositories/assign-an-issue-as-project-maintainer.md @@ -1 +1 @@ -1. If you're a project maintainer, you can [assign the issue to someone](/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users), [add it to a project board](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board#adding-issues-and-pull-requests-to-a-project-board-from-the-sidebar), [associate it with a milestone](/issues/using-labels-and-milestones-to-track-work/associating-milestones-with-issues-and-pull-requests), or [apply a label](/issues/using-labels-and-milestones-to-track-work/managing-labels). +1. If you're a project maintainer, you can [assign the issue to someone](/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users), [add it to a {% data variables.projects.projects_v1_board %}](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board#adding-issues-and-pull-requests-to-a-project-board-from-the-sidebar), [associate it with a milestone](/issues/using-labels-and-milestones-to-track-work/associating-milestones-with-issues-and-pull-requests), or [apply a label](/issues/using-labels-and-milestones-to-track-work/managing-labels). diff --git a/data/reusables/repositories/dependency-review.md b/data/reusables/repositories/dependency-review.md index ad49ab4b50..7757225ed4 100644 --- a/data/reusables/repositories/dependency-review.md +++ b/data/reusables/repositories/dependency-review.md @@ -1 +1 @@ -Additionally, {% data variables.product.prodname_dotcom %} can review any dependencies added, updated, or removed in a pull request made against the default branch of a repository, and flag any changes that would reduce the security of your project. This allows you to spot and deal with vulnerable dependencies{% ifversion GH-advisory-db-supports-malware %} or malware{% endif %} before, rather than after, they reach your codebase. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request)." +Additionally, {% data variables.product.prodname_dotcom %} can review any dependencies added, updated, or removed in a pull request made against the default branch of a repository, and flag any changes that would reduce the security of your project. This allows you to spot and deal with vulnerable dependencies before, rather than after, they reach your codebase. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request)." diff --git a/data/reusables/repositories/deploy-keys.md b/data/reusables/repositories/deploy-keys.md index 847fe22700..41aad645dd 100644 --- a/data/reusables/repositories/deploy-keys.md +++ b/data/reusables/repositories/deploy-keys.md @@ -1 +1 @@ -You can launch projects from a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} to your server by using a deploy key, which is an SSH key that grants access to a single repository. {% data variables.product.product_name %} attaches the public part of the key directly to your repository instead of a personal account, and the private part of the key remains on your server. For more information, see "[AUTOTITLE](/rest/guides/delivering-deployments)." +You can launch projects from a repository on {% data variables.location.product_location %} to your server by using a deploy key, which is an SSH key that grants access to a single repository. {% data variables.product.product_name %} attaches the public part of the key directly to your repository instead of a personal account, and the private part of the key remains on your server. For more information, see "[AUTOTITLE](/rest/guides/delivering-deployments)." diff --git a/data/reusables/repositories/enable-security-alerts.md b/data/reusables/repositories/enable-security-alerts.md index 56fda0f0c1..61b386aa3d 100644 --- a/data/reusables/repositories/enable-security-alerts.md +++ b/data/reusables/repositories/enable-security-alerts.md @@ -1,3 +1,3 @@ -{% ifversion ghes or ghae %} +{% ifversion ghes %} Enterprise owners must enable {% data variables.product.prodname_dependabot_alerts %} for {% data variables.location.product_location %} before you can use this feature. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)." {% endif %} diff --git a/data/reusables/repositories/rulesets-unsupported-fnmatch-syntax.md b/data/reusables/repositories/rulesets-unsupported-fnmatch-syntax.md index 5279571eca..598f7cfed8 100644 --- a/data/reusables/repositories/rulesets-unsupported-fnmatch-syntax.md +++ b/data/reusables/repositories/rulesets-unsupported-fnmatch-syntax.md @@ -1,5 +1,9 @@ {% note %} -**Note:** Although {% data variables.product.prodname_dotcom %} supports `File::FNM_PATHNAME` in `fnmatch` syntax, `File::FNM_EXTGLOB` is not supported. +**Note:** Not all expressions from the `fnmatch` syntax are supported in branch protection rules. Please be aware of the following constraints: + +- You cannot use the backslash (`\`) character as a quoting character, as {% data variables.product.prodname_dotcom %} does not support the use of backslashes in branch protection rules. +- You can specify character sets within square brackets (`[]`), but you cannot currently complement a set with the `^` operator (e.g., `[^charset]`). +- Although {% data variables.product.prodname_dotcom %} supports `File::FNM_PATHNAME` in `fnmatch` syntax, `File::FNM_EXTGLOB` is not supported. {% endnote %} diff --git a/data/reusables/rest-api/github-cli-install-and-auth.md b/data/reusables/rest-api/github-cli-install-and-auth.md index b41e5a727a..b443f15429 100644 --- a/data/reusables/rest-api/github-cli-install-and-auth.md +++ b/data/reusables/rest-api/github-cli-install-and-auth.md @@ -1,5 +1,5 @@ 1. Install {% data variables.product.prodname_cli %} on macOS, Windows, or Linux. For more information, see [Installation](https://github.com/cli/cli#installation) in the {% data variables.product.prodname_cli %} repository. -1. Authenticate with {% data variables.product.company_short %} by running this command from your terminal.{% ifversion ghes or ghae %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}. For example, `octo-inc.ghe.com`.{% endif %} +1. Authenticate with {% data variables.product.company_short %} by running this command from your terminal.{% ifversion ghes %} Replace `HOSTNAME` with the name of {% data variables.location.product_location %}. For example, `octo-inc.ghe.com`.{% endif %} {%- ifversion fpt or ghec %} diff --git a/data/reusables/scim/ghec-open-scim-beta-note.md b/data/reusables/scim/ghec-open-scim-beta-note.md index 66985627be..cef33d5c9e 100644 --- a/data/reusables/scim/ghec-open-scim-beta-note.md +++ b/data/reusables/scim/ghec-open-scim-beta-note.md @@ -5,6 +5,7 @@ **Notes**: - Support for provisioning users with {% data variables.product.company_short %}'s public SCIM schema is in private beta and subject to change. To request access to the beta, contact your account manager on {% data variables.contact.contact_enterprise_sales %}. +- This operation allows you to provision user accounts for your enterprise on {% data variables.product.prodname_ghe_cloud %} using SCIM. The operation is only available for use with {% data variables.product.prodname_emus %}. If you don't use {% data variables.product.prodname_emus %} and want to provision access to your organizations using SCIM, see "[AUTOTITLE](/rest/scim/scim)." - {% data variables.product.company_short %} recommends that you test provisioning in an environment that's isolated from the production data on your IdP and {% data variables.location.product_location %}. {% endnote %} diff --git a/data/reusables/scim/organization-rest-api-ghec-deployment-option.md b/data/reusables/scim/organization-rest-api-ghec-deployment-option.md new file mode 100644 index 0000000000..d0317f83fa --- /dev/null +++ b/data/reusables/scim/organization-rest-api-ghec-deployment-option.md @@ -0,0 +1,5 @@ +{% note %} + +**Note**: This operation allows you to provision access to an organization on {% data variables.product.prodname_ghe_cloud %} using SCIM. The operation is not available for use with {% data variables.product.prodname_emus %}. For more information about provisioning {% data variables.enterprise.prodname_managed_users %} using SCIM, see "[AUTOTITLE](/rest/enterprise-admin/scim)." + +{% endnote %} diff --git a/data/reusables/search/syntax_tips.md b/data/reusables/search/syntax_tips.md index 8d3e299d35..0c7bcf9757 100644 --- a/data/reusables/search/syntax_tips.md +++ b/data/reusables/search/syntax_tips.md @@ -1,6 +1,6 @@ {% tip %} -**Tips:**{% ifversion ghes or ghae %} +**Tips:**{% ifversion ghes %} - This article contains links to example searches on the {% data variables.product.prodname_dotcom_the_website %} website, but you can use the same search filters with {% data variables.product.product_name %}. In the linked example searches, replace `github.com` with the hostname for {% data variables.location.product_location %}.{% endif %} - For a list of search syntaxes that you can add to any search qualifier to further improve your results, see "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)". - Use quotations around multi-word search terms. For example, if you want to search for issues with the label "In progress," you'd search for `label:"in progress"`. Search is not case sensitive. diff --git a/data/reusables/secret-scanning/api-beta.md b/data/reusables/secret-scanning/api-beta.md index b3fdea6462..a5579fe470 100644 --- a/data/reusables/secret-scanning/api-beta.md +++ b/data/reusables/secret-scanning/api-beta.md @@ -1,4 +1,4 @@ -{% ifversion ghes or ghae %} +{% ifversion ghes %} {% note %} diff --git a/data/reusables/support/ask-and-answer-forum.md b/data/reusables/support/ask-and-answer-forum.md index 8e69add438..923b039be7 100644 --- a/data/reusables/support/ask-and-answer-forum.md +++ b/data/reusables/support/ask-and-answer-forum.md @@ -1 +1 @@ -You can connect with developers around the world to ask and answer questions, learn, and interact directly with {% data variables.product.product_name %} staff. To get the conversation started, see "[{% data variables.product.prodname_gcf %}](https://github.community)." +You can connect with developers around the world to ask and answer questions, learn, and interact directly with {% data variables.product.product_name %} staff. To get the conversation started, see "[{% data variables.product.prodname_gcf %}](https://github.com/orgs/community/discussions/)." diff --git a/data/reusables/support/enterprise-resolving-and-closing-tickets.md b/data/reusables/support/enterprise-resolving-and-closing-tickets.md index 07a7e65c84..f4c958c2dd 100644 --- a/data/reusables/support/enterprise-resolving-and-closing-tickets.md +++ b/data/reusables/support/enterprise-resolving-and-closing-tickets.md @@ -1,6 +1,6 @@ {% data variables.contact.enterprise_support %} may consider a ticket solved after providing an explanation, recommendation, usage instructions, {% ifversion ghae %}or {% endif %} workaround instructions{% ifversion ghes %}, or by advising you of an available release that addresses the issue{% endif %}. -{% ifversion ghes or ghae %} +{% ifversion ghes %} If you have installed additional third-party software on, or made modifications to, {% data variables.product.product_name %} outside of the recommendations of {% data variables.contact.enterprise_support %}, {% data variables.contact.enterprise_support %} may ask you to remove the software and/or modifications while attempting to resolve the issue. If the problem is fixed when the unsupported software or modifications have been removed, {% data variables.contact.enterprise_support %} may consider the ticket solved. {% endif %} diff --git a/data/secret-scanning.yml b/data/secret-scanning.yml index b0e1fb04d8..37fa026eaa 100644 --- a/data/secret-scanning.yml +++ b/data/secret-scanning.yml @@ -5,7 +5,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -18,7 +17,6 @@ fpt: '*' ghec: '*' ghes: '>=3.11' - ghae: '>=3.11' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -31,7 +29,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -44,7 +41,6 @@ fpt: '*' ghec: '*' ghes: '>=3.11' - ghae: '>=3.11' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -57,7 +53,6 @@ fpt: '*' ghec: '*' ghes: '>=3.11' - ghae: '>=3.11' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -70,7 +65,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -83,7 +77,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -96,7 +89,6 @@ fpt: '*' ghec: '*' ghes: '>3.9' - ghae: '>3.9' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -109,7 +101,6 @@ fpt: '*' ghec: '*' ghes: '>3.9' - ghae: '>3.9' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -122,7 +113,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -135,7 +125,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -148,7 +137,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -161,7 +149,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -186,7 +173,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -199,7 +185,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -212,7 +197,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -225,7 +209,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -238,7 +221,6 @@ fpt: '*' ghec: '*' ghes: '>=3.11' - ghae: '>=3.11' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -251,7 +233,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -264,7 +245,6 @@ fpt: '*' ghec: '*' ghes: '>3.8' - ghae: '>3.8' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -277,7 +257,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -290,7 +269,6 @@ fpt: '*' ghec: '*' ghes: '>=3.11' - ghae: '>=3.11' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -303,7 +281,6 @@ fpt: '*' ghec: '*' ghes: '>3.8' - ghae: '>3.8' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -316,7 +293,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -329,7 +305,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>=3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -342,7 +317,6 @@ fpt: '*' ghec: '*' ghes: '>3.8' - ghae: '>3.8' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -355,7 +329,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -368,7 +341,6 @@ fpt: '*' ghec: '*' ghes: '>3.8' - ghae: '>3.8' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -381,7 +353,6 @@ fpt: '*' ghec: '*' ghes: '>3.8' - ghae: '>3.8' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -394,7 +365,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -407,7 +377,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '<3.4' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -420,7 +389,6 @@ fpt: '*' ghec: '*' ghes: '>=3.11' - ghae: '>=3.11' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -433,7 +401,6 @@ fpt: '*' ghec: '*' ghes: '>3.6' - ghae: '>3.6' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -446,7 +413,6 @@ fpt: '*' ghec: '*' ghes: '>=3.11' - ghae: '>=3.11' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -459,7 +425,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -472,7 +437,6 @@ fpt: '*' ghec: '*' ghes: '>=3.9' - ghae: '>=3.9' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -497,7 +461,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -510,7 +473,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -523,7 +485,6 @@ fpt: '*' ghec: '*' ghes: '>3.7' - ghae: '>3.7' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -536,7 +497,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -549,7 +509,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -562,7 +521,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -586,7 +544,6 @@ fpt: '*' ghec: '*' ghes: '>=3.9' - ghae: '>= 3.9' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -599,7 +556,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -623,7 +579,6 @@ fpt: '*' ghec: '*' ghes: '>=3.10' - ghae: '>=3.10' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -636,7 +591,6 @@ fpt: '*' ghec: '*' ghes: '>3.8' - ghae: '>3.8' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -649,7 +603,6 @@ fpt: '*' ghec: '*' ghes: '>3.8' - ghae: '>3.8' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -662,7 +615,6 @@ fpt: '*' ghec: '*' ghes: '>3.8' - ghae: '>3.8' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -675,7 +627,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -688,7 +639,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -701,7 +651,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -714,7 +663,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -727,7 +675,6 @@ fpt: '*' ghec: '*' ghes: '>3.7' - ghae: '>3.7' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -740,7 +687,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -753,7 +699,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -766,7 +711,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -779,7 +723,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -792,7 +735,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -805,7 +747,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -818,7 +759,6 @@ fpt: '*' ghec: '*' ghes: '>=3.9' - ghae: '>= 3.9' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -831,7 +771,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -844,7 +783,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -857,7 +795,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -870,7 +807,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -883,7 +819,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -896,7 +831,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -909,7 +843,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -922,7 +855,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -935,7 +867,6 @@ fpt: '*' ghec: '*' ghes: '>3.8' - ghae: '>3.8' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -948,7 +879,6 @@ fpt: '*' ghec: '*' ghes: '>3.8' - ghae: '>3.8' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -961,7 +891,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -974,7 +903,6 @@ fpt: '*' ghec: '*' ghes: '>3.7' - ghae: '>3.7' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -987,7 +915,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -1000,7 +927,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -1013,7 +939,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -1026,7 +951,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -1039,7 +963,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -1052,7 +975,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1065,7 +987,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1078,7 +999,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1091,7 +1011,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1104,7 +1023,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1117,7 +1035,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1130,7 +1047,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -1143,7 +1059,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -1156,7 +1071,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -1169,7 +1083,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -1182,7 +1095,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -1195,7 +1107,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -1208,7 +1119,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -1221,7 +1131,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -1234,7 +1143,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -1247,7 +1155,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -1260,7 +1167,6 @@ fpt: '*' ghec: '*' ghes: '>3.5' - ghae: '>3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1273,7 +1179,6 @@ fpt: '*' ghec: '*' ghes: '>3.7' - ghae: '>3.7' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1286,7 +1191,6 @@ fpt: '*' ghec: '*' ghes: '>3.7' - ghae: '>3.7' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1299,7 +1203,6 @@ fpt: '*' ghec: '*' ghes: '>3.7' - ghae: '>3.7' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1312,7 +1215,6 @@ fpt: '*' ghec: '*' ghes: '>3.7' - ghae: '>3.7' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1325,7 +1227,6 @@ fpt: '*' ghec: '*' ghes: '>3.8' - ghae: '>3.8' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -1338,7 +1239,6 @@ fpt: '*' ghec: '*' ghes: '>3.8' - ghae: '>3.8' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -1351,7 +1251,6 @@ fpt: '*' ghec: '*' ghes: '>3.8' - ghae: '>3.8' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -1364,7 +1263,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1377,7 +1275,6 @@ fpt: '*' ghec: '*' ghes: '>3.9' - ghae: '>3.9' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1390,7 +1287,6 @@ fpt: '*' ghec: '*' ghes: '>3.9' - ghae: '>3.9' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1403,7 +1299,6 @@ fpt: '*' ghec: '*' ghes: '>3.9' - ghae: '>3.9' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1416,7 +1311,6 @@ fpt: '*' ghec: '*' ghes: '>3.9' - ghae: '>3.9' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1429,7 +1323,6 @@ fpt: '*' ghec: '*' ghes: '>=3.11' - ghae: '>=3.11' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1442,7 +1335,6 @@ fpt: '*' ghec: '*' ghes: '>=3.11' - ghae: '>=3.11' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1455,7 +1347,6 @@ fpt: '*' ghec: '*' ghes: '>=3.11' - ghae: '>=3.11' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1468,7 +1359,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1481,7 +1371,6 @@ fpt: '*' ghec: '*' ghes: '>3.7' - ghae: '>3.7' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1494,7 +1383,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -1507,7 +1395,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1520,7 +1407,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1533,7 +1419,6 @@ fpt: '*' ghec: '*' ghes: '>3.4' - ghae: '>3.4' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -1546,7 +1431,6 @@ fpt: '*' ghec: '*' ghes: '>3.6' - ghae: '>3.6' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -1559,7 +1443,6 @@ fpt: '*' ghec: '*' ghes: '>3.6' - ghae: '>3.6' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -1572,7 +1455,6 @@ fpt: '*' ghec: '*' ghes: '>3.10' - ghae: '>3.10' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -1585,7 +1467,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1598,7 +1479,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1611,7 +1491,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -1624,7 +1503,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -1637,7 +1515,6 @@ fpt: '*' ghec: '*' ghes: '>3.7' - ghae: '>3.7' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -1650,7 +1527,6 @@ fpt: '*' ghec: '*' ghes: '>3.8' - ghae: '>3.8' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1663,7 +1539,6 @@ fpt: '*' ghec: '*' ghes: '>3.8' - ghae: '>3.8' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1676,7 +1551,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -1700,7 +1574,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -1713,7 +1586,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -1726,7 +1598,6 @@ fpt: '*' ghec: '*' ghes: '>=3.11' - ghae: '>=3.11' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1739,7 +1610,6 @@ fpt: '*' ghec: '*' ghes: '>=3.10' - ghae: '>=3.10' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -1752,7 +1622,6 @@ fpt: '*' ghec: '*' ghes: '>=3.10' - ghae: '>=3.10' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -1765,7 +1634,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -1778,7 +1646,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -1791,7 +1658,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -1804,7 +1670,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -1817,7 +1682,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -1830,7 +1694,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -1843,7 +1706,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -1856,7 +1718,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -1869,7 +1730,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -1882,7 +1742,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -1895,7 +1754,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1908,7 +1766,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -1921,7 +1778,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -1934,7 +1790,6 @@ fpt: '*' ghec: '*' ghes: '>3.9' - ghae: '>3.9' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -1947,7 +1802,6 @@ fpt: '*' ghec: '*' ghes: '>=3.10' - ghae: '>= 3.10' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -1960,7 +1814,6 @@ fpt: '*' ghec: '*' ghes: '>=3.10' - ghae: '>= 3.10' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -1973,7 +1826,6 @@ fpt: '*' ghec: '*' ghes: '>=3.10' - ghae: '>= 3.10' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -1986,7 +1838,6 @@ fpt: '*' ghec: '*' ghes: '>=3.10' - ghae: '>= 3.10' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -1999,7 +1850,6 @@ fpt: '*' ghec: '*' ghes: '>=3.10' - ghae: '>= 3.10' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -2012,7 +1862,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2025,7 +1874,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -2038,7 +1886,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2051,7 +1898,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2064,7 +1910,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2077,7 +1922,6 @@ fpt: '*' ghec: '*' ghes: '>3.7' - ghae: '>3.7' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -2090,7 +1934,6 @@ fpt: '*' ghec: '*' ghes: '>3.7' - ghae: '>3.7' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -2103,7 +1946,6 @@ fpt: '*' ghec: '*' ghes: '>3.10' - ghae: '>3.10' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2116,7 +1958,6 @@ fpt: '*' ghec: '*' ghes: '>3.10' - ghae: '>3.10' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2129,7 +1970,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2142,7 +1982,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2155,7 +1994,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2168,7 +2006,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2181,7 +2018,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2194,7 +2030,6 @@ fpt: '*' ghec: '*' ghes: '>3.9' - ghae: '>3.9' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -2207,7 +2042,6 @@ fpt: '*' ghec: '*' ghes: '>3.6' - ghae: '>3.6' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2220,7 +2054,6 @@ fpt: '*' ghec: '*' ghes: '>3.6' - ghae: '>3.6' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -2244,7 +2077,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -2257,7 +2089,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -2270,7 +2101,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -2283,7 +2113,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2296,7 +2125,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -2309,7 +2137,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -2322,7 +2149,6 @@ fpt: '*' ghec: '*' ghes: '>3.6' - ghae: '>3.6' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2335,7 +2161,6 @@ fpt: '*' ghec: '*' ghes: '>3.5' - ghae: '>3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2348,7 +2173,6 @@ fpt: '*' ghec: '*' ghes: '>3.9' - ghae: '>3.9' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2361,7 +2185,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -2374,7 +2197,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2387,7 +2209,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2400,7 +2221,6 @@ fpt: '*' ghec: '*' ghes: '>3.9' - ghae: '>3.9' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2413,7 +2233,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2426,7 +2245,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2439,7 +2257,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2452,7 +2269,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -2465,7 +2281,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -2478,7 +2293,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2491,7 +2305,6 @@ fpt: '*' ghec: '*' ghes: '>3.4' - ghae: '>3.4' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -2504,7 +2317,6 @@ fpt: '*' ghec: '*' ghes: '>3.4' - ghae: '>3.4' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -2517,7 +2329,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2530,7 +2341,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -2543,7 +2353,6 @@ fpt: '*' ghec: '*' ghes: '>3.4' - ghae: '>3.4' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -2556,7 +2365,6 @@ fpt: '*' ghec: '*' ghes: '>3.4' - ghae: '>3.4' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -2569,7 +2377,6 @@ fpt: '*' ghec: '*' ghes: '>3.4' - ghae: '>3.4' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -2582,7 +2389,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -2595,7 +2401,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2608,7 +2413,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -2621,7 +2425,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -2634,7 +2437,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -2647,7 +2449,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -2660,7 +2461,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -2673,7 +2473,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -2686,7 +2485,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -2699,7 +2497,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -2712,7 +2509,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2725,7 +2521,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -2738,7 +2533,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -2751,7 +2545,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -2764,7 +2557,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -2777,7 +2569,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -2790,7 +2581,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -2803,7 +2593,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -2816,7 +2605,6 @@ fpt: '*' ghec: '*' ghes: '>3.7' - ghae: '>3.7' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2829,7 +2617,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2842,7 +2629,6 @@ fpt: '*' ghec: '*' ghes: '>3.7' - ghae: '>3.7' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -2855,7 +2641,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -2868,7 +2653,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '>3.8' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2881,7 +2665,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2894,7 +2677,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2907,7 +2689,6 @@ fpt: '*' ghec: '*' ghes: '>3.6' - ghae: '>3.6' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2920,7 +2701,6 @@ fpt: '*' ghec: '*' ghes: '>3.9' - ghae: '>3.9' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2933,7 +2713,6 @@ fpt: '*' ghec: '*' ghes: '>3.9' - ghae: '>3.9' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2946,7 +2725,6 @@ fpt: '*' ghec: '*' ghes: '>3.9' - ghae: '>3.9' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2959,7 +2737,6 @@ fpt: '*' ghec: '*' ghes: '>3.11' - ghae: '>3.11' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -2972,7 +2749,6 @@ fpt: '*' ghec: '*' ghes: '>=3.5' - ghae: '>= 3.5' isPublic: false isPrivateWithGhas: true hasPushProtection: true @@ -2985,7 +2761,6 @@ fpt: '*' ghec: '*' ghes: '>3.4' - ghae: '>3.4' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -2998,7 +2773,6 @@ fpt: '*' ghec: '*' ghes: '>3.4' - ghae: '>3.4' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -3011,7 +2785,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -3024,7 +2797,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -3037,7 +2809,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: true isPrivateWithGhas: true hasPushProtection: false @@ -3050,7 +2821,6 @@ fpt: '*' ghec: '*' ghes: '>=3.11' - ghae: '>=3.11' isPublic: true isPrivateWithGhas: true hasPushProtection: true @@ -3063,7 +2833,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -3087,7 +2856,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -3100,7 +2868,6 @@ fpt: '*' ghec: '*' ghes: '*' - ghae: '*' isPublic: false isPrivateWithGhas: true hasPushProtection: false @@ -3113,7 +2880,6 @@ fpt: '*' ghec: '*' ghes: '>3.6' - ghae: '>3.6' isPublic: true isPrivateWithGhas: true hasPushProtection: true diff --git a/data/variables/package_registry.yml b/data/variables/package_registry.yml index 8b52f7894d..9a03956021 100644 --- a/data/variables/package_registry.yml +++ b/data/variables/package_registry.yml @@ -1,6 +1,6 @@ # sentence fragments package-settings-actions-access-menu: >- - {% ifversion ghes or ghae %}through the **Actions access** menu option{% else %}by using the **Add Repository** button under "Manage Actions access" in the package's settings{% endif %} + {% ifversion ghes %}through the **Actions access** menu option{% else %}by using the **Add Repository** button under "Manage Actions access" in the package's settings{% endif %} package-settings-actions-access-role-dropdown: >- the **Role** drop-down menu to select the default access level that you'd like the repository to have to your package. # packages registries limits diff --git a/data/variables/product.yml b/data/variables/product.yml index 937972fa78..4764bdf445 100644 --- a/data/variables/product.yml +++ b/data/variables/product.yml @@ -8,7 +8,7 @@ company_short: 'GitHub' # GitHub's flagship products product_name: >- - {% ifversion ghec %}GitHub Enterprise Cloud{% elsif ghes %}GitHub Enterprise Server{% elsif ghae %}GitHub AE{% else %}GitHub{% endif %} + {% ifversion ghec %}GitHub Enterprise Cloud{% elsif ghes %}GitHub Enterprise Server{% else %}GitHub{% endif %} ## Use this variable when referring to the product, when the output should always be GitHub. For example, "the GitHub REST API" prodname_dotcom: 'GitHub' @@ -89,18 +89,18 @@ prodname_codeql_cli: 'CodeQL CLI' # CodeQL usually bumps its minor version for each minor version of GHES. # Update this whenever a new enterprise version of CodeQL is being prepared. codeql_cli_ghes_recommended_version: >- - {% ifversion ghes < 3.10 or ghae < 3.10 %}2.12.7{% elsif ghes < 3.11 %}2.13.5{% elsif ghes < 3.12 %}2.14.6{% endif %} + {% ifversion ghes < 3.10 %}2.12.7{% elsif ghes < 3.11 %}2.13.5{% elsif ghes < 3.12 %}2.14.6{% endif %} # Projects v2 prodname_projects_v2: '{% ifversion ghes = 3.8 or ghes = 3.9 %}Projects (beta){% else %}Projects{% endif %}' prodname_projects_v1: >- - {% ifversion ghae %}project boards{% else %}projects (classic){% endif %} + projects (classic) prodname_projects_v1_caps: >- - {% ifversion ghae %}Project boards{% else %}Projects (classic){% endif %} + Projects (classic) prodname_project_v1: >- - {% ifversion ghae %}project board{% else %}project (classic){% endif %} + project (classic) prodname_project_v1_caps: >- - {% ifversion ghae %}Project board{% else %}Project (classic){% endif %} + Project (classic) # Personal access tokens pat_generic: 'personal access token' @@ -128,7 +128,7 @@ prodname_oauth_app: 'OAuth app' prodname_oauth_apps: 'OAuth apps' # API and developer docs -prodname_enterprise_api: '{% ifversion ghes %}GitHub Enterprise Server{% elsif ghae %}GitHub AE{% endif %} APIs' +prodname_enterprise_api: 'GitHub Enterprise Server APIs' prodname_unfurls: 'Content Attachments' # GitHub Actions @@ -155,8 +155,8 @@ prodname_github_issues: 'GitHub Issues' prodname_registry: 'GitHub Packages' prodname_container_registry: 'Container registry' prodname_container_registries: 'Container registries' -prodname_docker_registry_namespace: '{% ifversion fpt or ghec %}`docker.pkg.github.com`{% elsif ghes or ghae %}docker.HOSTNAME{% endif %}' -prodname_container_registry_namespace: '{% ifversion fpt or ghec %}`ghcr.io`{% elsif ghes or ghae %}containers.HOSTNAME{% endif %}' +prodname_docker_registry_namespace: '{% ifversion fpt or ghec %}`docker.pkg.github.com`{% elsif ghes %}docker.HOSTNAME{% endif %}' +prodname_container_registry_namespace: '{% ifversion fpt or ghec %}`ghcr.io`{% elsif ghes %}containers.HOSTNAME{% endif %}' prodname_npm_registry: 'npm registry' # GitHub Insights @@ -207,7 +207,7 @@ prodname_security_advisories: 'GitHub Security Advisories' prodname_advisory_database: 'GitHub Advisory Database' # Secret scanning -prodname_secret_scanning: 'secret scanning' # Overall feature name and name for GHES and GHAE +prodname_secret_scanning: 'secret scanning' # Overall feature name and name for GHES prodname_secret_scanning_caps: 'Secret scanning' # Code scanning @@ -284,10 +284,10 @@ current-340-version: '11.10.354' # Developer site product variables # Use this inside command-line and other code blocks doc_url_pre: >- - {% ifversion fpt or ghec %}https://docs.github.com/rest{% elsif ghes %}https://docs.github.com/enterprise/{{ currentVersion | version_num }}/rest{% elsif ghae %}https://docs.github.com/github-ae@latest/rest{% endif %} + {% ifversion fpt or ghec %}https://docs.github.com/rest{% elsif ghes %}https://docs.github.com/enterprise/{{ currentVersion | version_num }}/rest{% endif %} # Use this inside command-line code blocks api_url_pre: >- - {% ifversion fpt or ghec %}https://api.github.com{% elsif ghes %}http(s)://HOSTNAME/api/v3{% elsif ghae %}https://HOSTNAME/api/v3{% endif %} + {% ifversion fpt or ghec %}https://api.github.com{% elsif ghes %}http(s)://HOSTNAME/api/v3{% endif %} # Use this inside command-line code blocks # Enterprise OAuth paths that don't include "/graphql" or "/api/v3" oauth_host_code: >- @@ -297,15 +297,13 @@ device_authorization_url: >- [`https://github.com/login/device`](https://github.com/login/device) {%- elsif ghes %} `http(s)://HOSTNAME/login/device` - {%- elsif ghae %} - `https://HOSTNAME/login/device` {%- endif %} # Use this all other code blocks api_url_code: >- - {% ifversion fpt or ghec %}https://api.github.com{% elsif ghes %}http(s)://HOSTNAME/api/v3{% elsif ghae %}https://HOSTNAME/api/v3{% endif %} + {% ifversion fpt or ghec %}https://api.github.com{% elsif ghes %}http(s)://HOSTNAME/api/v3{% endif %} # Use this inside command-line code blocks graphql_url_pre: >- - {% ifversion fpt or ghec %}https://api.github.com/graphql{% elsif ghes %}http(s)://HOSTNAME/api/graphql{% elsif ghae %}https://HOSTNAME/api/graphql{% endif %} + {% ifversion fpt or ghec %}https://api.github.com/graphql{% elsif ghes %}http(s)://HOSTNAME/api/graphql{% endif %} # Use this all other code blocks graphql_url_code: >- - {% ifversion fpt or ghec %}https://api.github.com/graphql{% elsif ghes %}http(s)://HOSTNAME/api/graphql{% elsif ghae %}https://HOSTNAME/api/graphql{% endif %} + {% ifversion fpt or ghec %}https://api.github.com/graphql{% elsif ghes %}http(s)://HOSTNAME/api/graphql{% endif %} diff --git a/data/variables/projects.yml b/data/variables/projects.yml index 16bda84ec5..b82eeaef02 100644 --- a/data/variables/projects.yml +++ b/data/variables/projects.yml @@ -4,13 +4,13 @@ project_v2: 'project' project_v2_caps: 'Project' projects_v1_board: >- - {% ifversion ghae %}project board{% else %}classic project{% endif %} + {% ifversion ghes < 3.8 %}project board{% else %}project (classic){% endif %} projects_v1_board_caps: >- - {% ifversion ghae %}Project board{% else %}Classic project{% endif %} + {% ifversion ghes < 3.8 %}Project board{% else %}Project (classic){% endif %} projects_v1_boards: >- - {% ifversion ghae %}project boards{% else %}classic projects{% endif %} + {% ifversion ghes < 3.8 %}project boards{% else %}projects (classic){% endif %} projects_v1_boards_caps: >- - {% ifversion ghae %}Project boards{% else %}Classic projects{% endif %} + {% ifversion ghes < 3.8 %}Project boards{% else %}Projects (classic){% endif %} command-palette-shortcut: 'Command+K (Mac) or Ctrl+K (Windows/Linux)' diff --git a/data/variables/rest.yml b/data/variables/rest.yml index 6ce315f536..8d3eb2d7a9 100644 --- a/data/variables/rest.yml +++ b/data/variables/rest.yml @@ -1 +1 @@ -example_request_url: '/repos{% ifversion ghes or ghae %}/REPO-OWNER/REPO-NAME{% else %}/octocat/Spoon-Knife{% endif %}/issues' +example_request_url: '/repos{% ifversion ghes %}/REPO-OWNER/REPO-NAME{% else %}/octocat/Spoon-Knife{% endif %}/issues' diff --git a/package-lock.json b/package-lock.json index 04eb905609..e6fa249c40 100644 --- a/package-lock.json +++ b/package-lock.json @@ -43,7 +43,7 @@ "gray-matter": "^4.0.3", "hast-util-from-parse5": "^8.0.1", "hast-util-to-string": "^2.0.0", - "hastscript": "^8.0.0", + "hastscript": "^9.0.0", "helmet": "^7.0.0", "highlight.js": "11.9.0", "highlightjs-curl": "^1.3.0", @@ -97,13 +97,13 @@ "devDependencies": { "@actions/core": "^1.10.0", "@actions/github": "^6.0.0", - "@axe-core/playwright": "^4.8.2", + "@axe-core/playwright": "^4.8.3", "@github/markdownlint-github": "^0.4.1", "@graphql-inspector/core": "^5.0.0", "@graphql-tools/load": "^8.0.0", "@jest/globals": "29.7.0", "@octokit/rest": "^20.0.2", - "@playwright/test": "1.40.1", + "@playwright/test": "1.41.0", "@types/imurmurhash": "^0.1.4", "@types/js-cookie": "^3.0.6", "@types/lodash": "^4.14.202", @@ -227,12 +227,12 @@ } }, "node_modules/@axe-core/playwright": { - "version": "4.8.2", - "resolved": "https://registry.npmjs.org/@axe-core/playwright/-/playwright-4.8.2.tgz", - "integrity": "sha512-9KOhX2tNuvqn9DzpBNyqoqNKRZBrexeSiN9irQ0sEdq8zH13JnatepCJxobuXn4UopNy6iIpP4342beMiH+MSQ==", + "version": "4.8.3", + "resolved": "https://registry.npmjs.org/@axe-core/playwright/-/playwright-4.8.3.tgz", + "integrity": "sha512-YtbkAWeOp5oQeI8vS6KYqJDa5yTl5O1wJP8KOZAAVjhxeiK/Y1ssxnZuGRobARyVh3eS6O3jdxTv/iCK1RfgaA==", "dev": true, "dependencies": { - "axe-core": "~4.8.2" + "axe-core": "~4.8.3" }, "peerDependencies": { "playwright-core": ">= 1.0.0" @@ -3064,12 +3064,12 @@ } }, "node_modules/@playwright/test": { - "version": "1.40.1", - "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.40.1.tgz", - "integrity": "sha512-EaaawMTOeEItCRvfmkI9v6rBkF1svM8wjl/YPRrg2N2Wmp+4qJYkWtJsbew1szfKKDm6fPLy4YAanBhIlf9dWw==", + "version": "1.41.0", + "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.41.0.tgz", + "integrity": "sha512-Grvzj841THwtpBOrfiHOeYTJQxDRnKofMSzCiV8XeyLWu3o89qftQ4BCKfkziJhSUQRd0utKhrddtIsiraIwmw==", "dev": true, "dependencies": { - "playwright": "1.40.1" + "playwright": "1.41.0" }, "bin": { "playwright": "cli.js" @@ -4153,9 +4153,9 @@ } }, "node_modules/axe-core": { - "version": "4.8.2", - "resolved": "https://registry.npmjs.org/axe-core/-/axe-core-4.8.2.tgz", - "integrity": "sha512-/dlp0fxyM3R8YW7MFzaHWXrf4zzbr0vaYb23VBFCl83R7nWNPg/yaQw2Dc8jzCMmDVLhSdzH8MjrsuIUuvX+6g==", + "version": "4.8.3", + "resolved": "https://registry.npmjs.org/axe-core/-/axe-core-4.8.3.tgz", + "integrity": "sha512-d5ZQHPSPkF9Tw+yfyDcRoUOc4g/8UloJJe5J8m4L5+c7AtDdjDLRxew/knnI4CxvtdxEUVgWz4x3OIQUIFiMfw==", "dev": true, "engines": { "node": ">=4" @@ -7682,6 +7682,22 @@ "resolved": "https://registry.npmjs.org/@types/unist/-/unist-3.0.0.tgz", "integrity": "sha512-MFETx3tbTjE7Uk6vvnWINA/1iJ7LuMdO4fcq8UfF0pRbj01aGLduVvQcRyswuACJdpnHgg8E3rQLhaRdNEJS0w==" }, + "node_modules/hast-util-from-parse5/node_modules/hastscript": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/hastscript/-/hastscript-8.0.0.tgz", + "integrity": "sha512-dMOtzCEd3ABUeSIISmrETiKuyydk1w0pa+gE/uormcTpSYuaNJPbX1NU3JLyscSLjwAQM8bWMhhIlnCqnRvDTw==", + "dependencies": { + "@types/hast": "^3.0.0", + "comma-separated-tokens": "^2.0.0", + "hast-util-parse-selector": "^4.0.0", + "property-information": "^6.0.0", + "space-separated-tokens": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, "node_modules/hast-util-from-parse5/node_modules/unist-util-stringify-position": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/unist-util-stringify-position/-/unist-util-stringify-position-4.0.0.tgz", @@ -7979,9 +7995,9 @@ } }, "node_modules/hastscript": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/hastscript/-/hastscript-8.0.0.tgz", - "integrity": "sha512-dMOtzCEd3ABUeSIISmrETiKuyydk1w0pa+gE/uormcTpSYuaNJPbX1NU3JLyscSLjwAQM8bWMhhIlnCqnRvDTw==", + "version": "9.0.0", + "resolved": "https://registry.npmjs.org/hastscript/-/hastscript-9.0.0.tgz", + "integrity": "sha512-jzaLBGavEDKHrc5EfFImKN7nZKKBdSLIdGvCwDZ9TfzbF2ffXiov8CKE445L2Z1Ek2t/m4SKQ2j6Ipv7NyUolw==", "dependencies": { "@types/hast": "^3.0.0", "comma-separated-tokens": "^2.0.0", @@ -12545,12 +12561,12 @@ } }, "node_modules/playwright": { - "version": "1.40.1", - "resolved": "https://registry.npmjs.org/playwright/-/playwright-1.40.1.tgz", - "integrity": "sha512-2eHI7IioIpQ0bS1Ovg/HszsN/XKNwEG1kbzSDDmADpclKc7CyqkHw7Mg2JCz/bbCxg25QUPcjksoMW7JcIFQmw==", + "version": "1.41.0", + "resolved": "https://registry.npmjs.org/playwright/-/playwright-1.41.0.tgz", + "integrity": "sha512-XOsfl5ZtAik/T9oek4V0jAypNlaCNzuKOwVhqhgYT3os6kH34PzbRb74F0VWcLYa5WFdnmxl7qyAHBXvPv7lqQ==", "dev": true, "dependencies": { - "playwright-core": "1.40.1" + "playwright-core": "1.41.0" }, "bin": { "playwright": "cli.js" @@ -12563,9 +12579,9 @@ } }, "node_modules/playwright-core": { - "version": "1.40.1", - "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.40.1.tgz", - "integrity": "sha512-+hkOycxPiV534c4HhpfX6yrlawqVUzITRKwHAmYfmsVreltEl6fAZJ3DPfLMOODw0H3s1Itd6MDCWmP1fl/QvQ==", + "version": "1.41.0", + "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.41.0.tgz", + "integrity": "sha512-UGKASUhXmvqm2Lxa1fNr8sFwAtqjpgBRr9jQ7XBI8Rn5uFiEowGUGwrruUQsVPIom4bk7Lt+oLGpXobnXzrBIw==", "dev": true, "bin": { "playwright-core": "cli.js" diff --git a/package.json b/package.json index 1d7b151971..1bdbaa2328 100644 --- a/package.json +++ b/package.json @@ -22,7 +22,6 @@ "check-content-type": "node src/workflows/check-content-type.js", "check-github-github-links": "node src/links/scripts/check-github-github-links.js", "copy-fixture-data": "node src/tests/scripts/copy-fixture-data.js", - "create-translation-health-report": "node src/languages/scripts/create-translation-health-report.js", "debug": "cross-env NODE_ENV=development ENABLED_LANGUAGES=en nodemon --inspect src/frame/server.js", "delete-orphan-translation-files": "tsx src/workflows/delete-orphan-translation-files.ts", "dev": "cross-env npm start", @@ -40,7 +39,7 @@ "playwright-test": "playwright test --config src/fixtures/playwright.config.ts --project=\"Google Chrome\"", "post-lints": "node src/content-linter/scripts/post-lints.js", "postinstall": "cp package-lock.json .installed.package-lock.json && echo \"Updated .installed.package-lock.json\" # see husky/post-checkout and husky/post-merge", - "precompute-pageinfo": "node src/pageinfo/scripts/precompute-pageinfo.js", + "precompute-pageinfo": "tsx src/pageinfo/scripts/precompute-pageinfo.ts", "prepare": "husky install src/workflows/husky", "prettier": "prettier -w \"**/*.{ts,tsx,js,mjs,scss,yml,yaml}\"", "prettier-check": "prettier -c \"**/*.{ts,tsx,js,mjs,scss,yml,yaml}\"", @@ -265,7 +264,7 @@ "gray-matter": "^4.0.3", "hast-util-from-parse5": "^8.0.1", "hast-util-to-string": "^2.0.0", - "hastscript": "^8.0.0", + "hastscript": "^9.0.0", "helmet": "^7.0.0", "highlight.js": "11.9.0", "highlightjs-curl": "^1.3.0", @@ -319,13 +318,13 @@ "devDependencies": { "@actions/core": "^1.10.0", "@actions/github": "^6.0.0", - "@axe-core/playwright": "^4.8.2", + "@axe-core/playwright": "^4.8.3", "@github/markdownlint-github": "^0.4.1", "@graphql-inspector/core": "^5.0.0", "@graphql-tools/load": "^8.0.0", "@jest/globals": "29.7.0", "@octokit/rest": "^20.0.2", - "@playwright/test": "1.40.1", + "@playwright/test": "1.41.0", "@types/imurmurhash": "^0.1.4", "@types/js-cookie": "^3.0.6", "@types/lodash": "^4.14.202", diff --git a/src/audit-logs/data/ghec/enterprise.json b/src/audit-logs/data/ghec/enterprise.json index 66ec41566e..0d610169ee 100644 --- a/src/audit-logs/data/ghec/enterprise.json +++ b/src/audit-logs/data/ghec/enterprise.json @@ -724,6 +724,11 @@ "description": "The excluded paths for GitHub Copilot were updated.", "docs_reference_links": "N/A" }, + { + "action": "copilot.plan_changed", + "description": "The plan for GitHub Copilot was updated.", + "docs_reference_links": "/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot" + }, { "action": "custom_hosted_runner.create", "description": "N/A", diff --git a/src/audit-logs/lib/config.json b/src/audit-logs/lib/config.json index e02f93e0e2..561d9a7709 100644 --- a/src/audit-logs/lib/config.json +++ b/src/audit-logs/lib/config.json @@ -1,4 +1,4 @@ { "apiOnlyEventsAdditionalDescription": "This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", - "sha": "9d8853a5a1102bc954cd80819b52730c5473cc33" + "sha": "b5bbe6c2aa628a381e44765b7a9deba2bba4bc7f" } \ No newline at end of file diff --git a/src/content-linter/lib/linting-rules/list-first-word-capitalization.js b/src/content-linter/lib/linting-rules/list-first-word-capitalization.js index 578d4eacb2..f19b566b89 100644 --- a/src/content-linter/lib/linting-rules/list-first-word-capitalization.js +++ b/src/content-linter/lib/linting-rules/list-first-word-capitalization.js @@ -33,7 +33,8 @@ export const listFirstWordCapitalization = { const firstWord = content.trim().split(' ')[0] // Liquid is considered a text node but we don't want to capitalize it - if (/^[{%|{{]/.test(content)) return + if (firstWord.startsWith('[{%') || firstWord.startsWith('{%') || firstWord.startsWith('{{')) + return // If the first letter is capitalized, it's not an error if (/[A-Z]/.test(firstWord[0])) return // There are items that start with a number or words that contain numbers diff --git a/src/content-linter/tests/unit/list-first-word-captitalization.js b/src/content-linter/tests/unit/list-first-word-captitalization.js index 6e72f0a992..d596346b86 100644 --- a/src/content-linter/tests/unit/list-first-word-captitalization.js +++ b/src/content-linter/tests/unit/list-first-word-captitalization.js @@ -46,6 +46,8 @@ describe(listFirstWordCapitalization.names.join(' - '), () => { "- '[AUTOTITLE](/billing/managing-billing-for-github-marketplace-apps)'", '- [Viewing your sponsors and sponsorships](/sponsors/receiving-sponsorships-through-github-sponsors/viewing-your-sponsors-and-sponsorships)', '- macOS', + '- [{% data variables.actions.test %}](/apple/test)', + '- {{ foo }} for example', '- {% data variables.product.prodname_dotcom_the_website %} Services Continuity and Incident Management Plan', '- {% data variables.product.prodname_dotcom_the_website %} Services Continuity and Incident Management Plan', '- x64', diff --git a/src/fixtures/fixtures/content/pages/index.md b/src/fixtures/fixtures/content/pages/index.md index efa587c4d5..9e6d441f25 100644 --- a/src/fixtures/fixtures/content/pages/index.md +++ b/src/fixtures/fixtures/content/pages/index.md @@ -1,7 +1,7 @@ --- title: Pages Documentation shortTitle: Pages ({% data variables.product.product_name %}) -intro: 'Pages are cool on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}. ' +intro: 'Pages are cool on {% data variables.location.product_location %}. ' introLinks: quickstart: /pages/quickstart layout: product-landing diff --git a/src/frame/lib/page-data.js b/src/frame/lib/page-data.js index 8735504188..6a3b4751f2 100644 --- a/src/frame/lib/page-data.js +++ b/src/frame/lib/page-data.js @@ -37,7 +37,7 @@ const translatableFrontmatterKeys = Object.entries(frontmatterSchema.schema.prop * first since it's the most expensive work. This gets us a nested object with pages attached that we can use * as the basis for the siteTree after we do some versioning. We can also use it to derive the pageList. */ -export async function loadUnversionedTree(languagesOnly = null) { +export async function loadUnversionedTree(languagesOnly = []) { if (languagesOnly && !Array.isArray(languagesOnly)) { throw new Error("'languagesOnly' has to be an array") } @@ -47,7 +47,7 @@ export async function loadUnversionedTree(languagesOnly = null) { const languagesValues = Object.entries(languages) .filter(([language]) => { - return !languagesOnly || languagesOnly.includes(language) + return !languagesOnly.length || languagesOnly.includes(language) }) .map(([, data]) => { return data @@ -295,7 +295,7 @@ export async function versionPages(obj, version, langCode) { } // Derive a flat array of Page objects in all languages. -export async function loadPageList(unversionedTree, languagesOnly = null) { +export async function loadPageList(unversionedTree, languagesOnly = []) { if (languagesOnly && !Array.isArray(languagesOnly)) { throw new Error("'languagesOnly' has to be an array") } @@ -303,7 +303,7 @@ export async function loadPageList(unversionedTree, languagesOnly = null) { const pageList = [] await Promise.all( - (languagesOnly || Object.keys(languages)).map(async (langCode) => { + ((languagesOnly.length && languagesOnly) || Object.keys(languages)).map(async (langCode) => { await addToCollection(rawTree[langCode], pageList) }), ) @@ -335,7 +335,7 @@ export function createMapFromArray(pageList) { return pageMap } -export async function loadPageMap(pageList, languagesOnly = null) { +export async function loadPageMap(pageList, languagesOnly = []) { const pages = pageList || (await loadPageList(languagesOnly)) const pageMap = createMapFromArray(pages) return pageMap diff --git a/src/graphql/data/fpt/changelog.json b/src/graphql/data/fpt/changelog.json index b2e3f81e71..b25c7e793e 100644 --- a/src/graphql/data/fpt/changelog.json +++ b/src/graphql/data/fpt/changelog.json @@ -1,4 +1,17 @@ [ + { + "schemaChanges": [ + { + "title": "The GraphQL schema includes these changes:", + "changes": [ + "

    Field id was added to object type UnpinIssuePayload

    " + ] + } + ], + "previewChanges": [], + "upcomingChanges": [], + "date": "2024-01-23" + }, { "schemaChanges": [ { diff --git a/src/graphql/data/fpt/schema.json b/src/graphql/data/fpt/schema.json index 04d9c23c13..63ca72a04b 100644 --- a/src/graphql/data/fpt/schema.json +++ b/src/graphql/data/fpt/schema.json @@ -6984,6 +6984,14 @@ "href": "/graphql/reference/scalars#string", "description": "

    A unique identifier for the client performing the mutation.

    " }, + { + "name": "id", + "type": "ID", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "description": "

    The id of the pinned issue that was unpinned.

    " + }, { "name": "issue", "type": "Issue", diff --git a/src/graphql/data/ghae/schema.json b/src/graphql/data/ghae/schema.json index 5264ebbf3b..569f4b562b 100644 --- a/src/graphql/data/ghae/schema.json +++ b/src/graphql/data/ghae/schema.json @@ -5067,6 +5067,14 @@ "href": "/graphql/reference/scalars#string", "description": "

    A unique identifier for the client performing the mutation.

    " }, + { + "name": "id", + "type": "ID", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "description": "

    The id of the pinned issue that was unpinned.

    " + }, { "name": "issue", "type": "Issue", diff --git a/src/graphql/data/ghec/schema.json b/src/graphql/data/ghec/schema.json index 04d9c23c13..63ca72a04b 100644 --- a/src/graphql/data/ghec/schema.json +++ b/src/graphql/data/ghec/schema.json @@ -6984,6 +6984,14 @@ "href": "/graphql/reference/scalars#string", "description": "

    A unique identifier for the client performing the mutation.

    " }, + { + "name": "id", + "type": "ID", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "description": "

    The id of the pinned issue that was unpinned.

    " + }, { "name": "issue", "type": "Issue", diff --git a/src/landings/components/ProductReleases.tsx b/src/landings/components/ProductReleases.tsx index b952a286e3..350b389e14 100644 --- a/src/landings/components/ProductReleases.tsx +++ b/src/landings/components/ProductReleases.tsx @@ -14,7 +14,7 @@ export function ProductReleases() { return (
    - {ghesReleases.map((release) => { + {ghesReleases.slice(0, 4).map((release) => { const releaseNumber = release.version if (!enterpriseServerReleases.supported.includes(releaseNumber)) { return null diff --git a/src/languages/scripts/create-translation-health-report.js b/src/languages/scripts/create-translation-health-report.js deleted file mode 100755 index 74847991c6..0000000000 --- a/src/languages/scripts/create-translation-health-report.js +++ /dev/null @@ -1,142 +0,0 @@ -#!/usr/bin/env node - -// [start-readme] -// -// Create a list of errors and summary statistics for errors in a particular language. -// -// [end-readme] - -/* Nota bene: - If you are getting more errors all the sudden, try running this: - $ npm run create-translation-health-report -- -l en -r 000 - If there's any errors before getting the JSON output, - const context = { ... } probably needs more data. -*/ - -import { program } from 'commander' -import fs from 'fs/promises' - -program - .description('Create a translation health report for one language.') - .requiredOption('-l, --language ', 'The language to health check') - .option('-r, --gitref ', 'Language repo latest git commit short SHA') - .parse(process.argv) - -// Throw errors instead of falling back to English -process.env.DEBUG_TRANSLATION_FALLBACKS = true -// The error option stops everything, but we want it to continue to generate the full report -process.env.ENABLED_LANGUAGES = `en,${program.opts().language}` - -// In debug mode, it will call console.warn ... so overriding :) -// Want to make sure the result is valid JSON -const prevConsoleWarn = console.warn -const prevConsoleError = console.error - -let issues = [] -console.warn = console.error = (...args) => { - if (args.length > 1) { - issues.push({ message: args.map(String).join(' '), score: 0 }) - } else if (typeof args[0] === 'string') { - issues.push({ message: args[0], score: 0 }) - } else if (args[0]?.constructor === Object) { - const path = args[0].path?.replace('/index.md', '').replace('.md', '') - issues.push({ path, message: args[0].message, score: scores[path] || 0 }) - } else if (Array.isArray(args[0]) && args[0][0]?.constructor === Object && args[0][0].filepath) { - // This is a YML parsing error. It's serious enough to bump the score. - let message = args[0][0].message - if (args[0][0].reason) { - message += ` (reason: ${args[0][0].reason})` - } - const path = args[0][0].filepath - // By giving it a +100 on the score, it at least stands above all the - // other issues which are mostly score 0. It's artificial but it works. - issues.push({ path, message, score: (scores[path] || 0) + 100 }) - } else { - // Don't use .warn() because this logging here is for the engineer - // working on this script. - console.log("WARNING: Don't know how to turn these args into an issue", args) - } -} - -// Weird import syntax, but forces it to load after process.env... changes -const { languageKeys } = await import('#src/languages/lib/languages.js') -const { loadPages, loadPageMap } = await import('#src/frame/lib/page-data.js') -const { precompileRedirects } = await import('#src/redirects/lib/precompile.js') -const { allVersions, allVersionKeys } = await import('#src/versions/lib/all-versions.js') -const { getProductStringFromPath } = await import('#src/frame/lib/path-utils.js') - -// Check that the language is valid -const { language, gitref } = program.opts() -if (!languageKeys.includes(language)) { - throw new Error(`Language ${language} is not in ${languageKeys.join()}.`) -} - -// Gather popularity data the search uses to prioritize errors -const scores = {} -const { POPULAR_PAGES_JSON } = process.env -if (POPULAR_PAGES_JSON) { - const popularPagesRaw = await fs.readFile(POPULAR_PAGES_JSON, 'utf8') - for (const row of JSON.parse(popularPagesRaw)) { - scores[row.path_article] = row.path_count - } -} - -// Load all pages in language -const allPages = await loadPages() -const pages = allPages.filter((page) => page.languageCode === language) -const pageMap = await loadPageMap(pages) -const redirects = await precompileRedirects(pages) - -// Try to render each page -for (const page of pages) { - const plainPath = page.relativePath.replace('/index.md', '').replace('.md', '') - // Go through each version... - const versions = allVersionKeys.filter((version) => page.applicableVersions.includes(version)) - const pageIssues = {} - for (const version of versions) { - const path = `/${language}/${version}/${plainPath}` - // Reference middleware/context.js for shape - const context = { - currentVersion: version, // needed for all pages - currentLanguage: language, // needed for all pages - currentPath: path, // needed for all pages - currentVersionObj: allVersions[version], // needed for ifversion tag - currentProduct: getProductStringFromPath(path), // needed for learning-track on guides pages - pages: pageMap, // needed for learning-track on guides pages - redirects, // needed for learning-track on guides pages - } - try { - await page.render(context) - } catch (err) { - // Which messages apply to which versions - pageIssues[err.message] = pageIssues[err.message] || [] - pageIssues[err.message].push(version) - } - } - if (Object.keys(pageIssues).length) { - issues.push({ - path: plainPath, - messages: pageIssues, - score: scores[plainPath] || 0, - }) - } -} - -// Sort by score desc so the translators know what to focus on first -// Issues with more information should be higher -issues = issues - .filter((issue) => !issue.path?.includes('early-access')) - .sort((a, b) => b.score - a.score || JSON.stringify(b).length - JSON.stringify(a).length) - -// Begin an output report -const report = { - language, - gitref, - datetime: new Date().toJSON(), - issuesCount: issues.length, - issues, -} - -console.warn = prevConsoleWarn -console.error = prevConsoleError -console.log(JSON.stringify(report, null, 2)) diff --git a/src/links/scripts/rendered-content-link-checker.js b/src/links/scripts/rendered-content-link-checker.js index 281c81ead9..98d48f3ca5 100755 --- a/src/links/scripts/rendered-content-link-checker.js +++ b/src/links/scripts/rendered-content-link-checker.js @@ -332,6 +332,7 @@ async function main(core, octokit, uploadArtifact, opts = {}) { ) } } + process.exit(1) } else { // It might be that the PR got a comment about >0 flaws before, // and now it can update that comment to say all is well again. diff --git a/src/pageinfo/middleware.js b/src/pageinfo/middleware.js index 6ce31cafee..d852997b19 100644 --- a/src/pageinfo/middleware.js +++ b/src/pageinfo/middleware.js @@ -22,7 +22,7 @@ const router = express.Router() // Note that if the file does not exist, it will be ignored and // every pageinfo is computed every time. // Note! The only reason this variable is exported is so that -// it can be imported by the script scripts/precompute-pageinfo.js +// it can be imported by the script scripts/precompute-pageinfo.ts export const CACHE_FILE_PATH = '.pageinfo-cache.json.br' const validationMiddleware = (req, res, next) => { diff --git a/src/pageinfo/scripts/precompute-pageinfo.js b/src/pageinfo/scripts/precompute-pageinfo.ts old mode 100755 new mode 100644 similarity index 53% rename from src/pageinfo/scripts/precompute-pageinfo.js rename to src/pageinfo/scripts/precompute-pageinfo.ts index 24a31f097b..e95c027ad6 --- a/src/pageinfo/scripts/precompute-pageinfo.js +++ b/src/pageinfo/scripts/precompute-pageinfo.ts @@ -13,7 +13,7 @@ * Why cache?: Despite being a fast computation (3 Liquid + Markdown renders), * it still adds up. And it's safe and cheap to precompute in advance. * - * Why only the English?: To make the file not too large. + * Why only the English by default?: To make the file not too large. * Given how good these things compress, we might consider, in the * future, to do all languages. * @@ -29,20 +29,55 @@ import fs from 'fs' import { brotliCompressSync } from 'zlib' -import { loadPages, loadUnversionedTree } from '#src/frame/lib/page-data.js' +import chalk from 'chalk' +import { program, Option } from 'commander' + +import { languageKeys } from 'src/languages/lib/languages.js' +import { loadPages, loadUnversionedTree } from 'src/frame/lib/page-data.js' import { CACHE_FILE_PATH, getPageInfo } from '../middleware.js' -main() +program + .description('Generates a JSON file with precompute pageinfo data by pathname') + .addOption( + new Option('-l, --language ', 'Which languages to focus on') + .choices(languageKeys) + .default(['en']), + ) + .option('-o, --output-file ', 'path to output file', CACHE_FILE_PATH) + .parse(process.argv) + +type Options = { + outputFile: string + languages: string[] +} +const opts = program.opts() + +main({ + outputFile: opts.outputFile, + languages: opts.language, +}) const CI = Boolean(JSON.parse(process.env.CI || 'false')) -async function main() { - const unversionedTree = await loadUnversionedTree(['en']) - const pageList = await loadPages(unversionedTree, ['en']) +type PageInfo = { + title: string + intro: string + product: string +} + +async function main(options: Options) { + const { outputFile, languages } = options + if (outputFile !== CACHE_FILE_PATH) { + console.warn(chalk.yellow(`Writing to ${outputFile} instead of ${CACHE_FILE_PATH}`)) + } + const unversionedTree = await loadUnversionedTree(languages) + const pageList = await loadPages(unversionedTree, languages) let label = `Compute pageinfos for ${pageList.length.toLocaleString()} pages` console.time(label) - const pageinfos = {} + const pageinfos: { + [pathname: string]: PageInfo + } = {} for (const page of pageList) { const pathname = page.permalinks[0].href try { @@ -57,14 +92,20 @@ async function main() { } console.timeEnd(label) - label = `Serialize, compress, and write to ${CACHE_FILE_PATH}` + label = `Serialize, compress, and write to ${outputFile}` console.time(label) const payload = CI ? JSON.stringify(pageinfos) : JSON.stringify(pageinfos, null, 2) - const payloadBuffer = Buffer.from(payload, 'utf-8') - const payloadCompressed = brotliCompressSync(payloadBuffer) - fs.writeFileSync(CACHE_FILE_PATH, payloadCompressed) + if (outputFile.endsWith('.json')) { + fs.writeFileSync(outputFile, payload) + } else { + const payloadBuffer = Buffer.from(payload, 'utf-8') + const payloadCompressed = brotliCompressSync(payloadBuffer) + fs.writeFileSync(outputFile, payloadCompressed) + } console.timeEnd(label) console.log( - `Wrote ${Object.keys(pageinfos).length.toLocaleString()} pageinfos to ${CACHE_FILE_PATH}`, + chalk.green( + `Wrote ${Object.keys(pageinfos).length.toLocaleString()} pageinfos to ${outputFile}`, + ), ) } diff --git a/src/search/scripts/index-elasticsearch.js b/src/search/scripts/index-elasticsearch.js index cbcc92523f..f2ddd52c68 100755 --- a/src/search/scripts/index-elasticsearch.js +++ b/src/search/scripts/index-elasticsearch.js @@ -19,6 +19,14 @@ import { retryOnErrorTest } from './retry-on-error-test.js' import { languageKeys } from '#src/languages/lib/languages.js' import { allVersions } from '#src/versions/lib/all-versions.js' +const availableVersions = Object.fromEntries( + Object.entries(allVersions) + // GHAE is deprecated and not yet entirely deleted from all-versions + // Until so, we manually filter it out. + .filter(([version]) => version !== 'github-ae@latest') + .map(([key, value]) => [key, value]), +) + // Now you can optionally have set the ELASTICSEARCH_URL in your .env file. dotenv.config() @@ -38,7 +46,7 @@ dotenv.config() // We need this later to be able to map CLI arguments to what the // records are called when found on disk. const shortNames = Object.fromEntries( - Object.values(allVersions).map((info) => { + Object.values(availableVersions).map((info) => { const shortName = info.hasNumberedReleases ? info.miscBaseName + info.currentRelease : info.miscBaseName diff --git a/src/search/scripts/sync-search-indices.js b/src/search/scripts/sync-search-indices.js index 8f7f5e049c..40367febaf 100755 --- a/src/search/scripts/sync-search-indices.js +++ b/src/search/scripts/sync-search-indices.js @@ -16,8 +16,15 @@ import { languageKeys } from '#src/languages/lib/languages.js' import { allVersions } from '#src/versions/lib/all-versions.js' import searchSync from './sync.js' +const availableVersions = Object.fromEntries( + Object.entries(allVersions) + // GHAE is deprecated and not yet entirely deleted from all-versions + // Until so, we manually filter it out. + .filter(([version]) => version !== 'github-ae@latest') + .map(([key, value]) => [key, value]), +) const shortNames = Object.fromEntries( - Object.values(allVersions).map((info) => { + Object.values(availableVersions).map((info) => { const shortName = info.hasNumberedReleases ? info.miscBaseName + info.currentRelease : info.miscBaseName @@ -25,7 +32,7 @@ const shortNames = Object.fromEntries( }), ) -const allVersionKeys = [...Object.keys(shortNames), ...Object.keys(allVersions)] +const allVersionKeys = [...Object.keys(shortNames), ...Object.keys(availableVersions)] program .description('Creates search records by scraping') @@ -133,9 +140,9 @@ async function main(opts, args) { const options = { language, notLanguage, - version: indexVersion, outDirectory, config, + versionsToBuild: indexVersion ? [indexVersion] : Object.keys(availableVersions), } await searchSync(options) } diff --git a/src/search/scripts/sync.js b/src/search/scripts/sync.js index c63ef71559..127a26bfcc 100644 --- a/src/search/scripts/sync.js +++ b/src/search/scripts/sync.js @@ -12,9 +12,9 @@ import { writeIndexRecords } from './search-index-records.js' // e.g. `github-docs-dotcom-en.json` and `github-docs-2.14-ja.json` export default async function syncSearchIndexes({ language, - version, notLanguage, outDirectory, + versionsToBuild, config = {}, }) { const t0 = new Date() @@ -24,14 +24,9 @@ export default async function syncSearchIndexes({ notLanguage ? notLanguage !== lang : language ? language === lang : true, ) - // build indices for a specific version if provided; otherwise build indices for all versions - const versionsToBuild = Object.keys(allVersions).filter((ver) => - version ? version === ver : true, - ) - console.log( `Building indices for ${chalk.yellow(language || 'all languages')} and ${chalk.yellow( - version || 'all versions', + versionsToBuild.length === 1 ? versionsToBuild[0] : 'all versions', )}.\n`, ) diff --git a/src/workflows/get-preview-app-info.sh b/src/workflows/get-preview-app-info.sh index 094ff29687..3624f683d0 100755 --- a/src/workflows/get-preview-app-info.sh +++ b/src/workflows/get-preview-app-info.sh @@ -14,9 +14,10 @@ PREVIEW_ENV_LOCATION="eastus" -# If a CUSTOM_GITHUB_REPOSITORY variable was set, use that. -# Otherwise, use the default GITHUB_REPOSITORY value. -# (This allows us to call this script from another repo.) +# GITHUB_REPOSITORY is a default env variable and cannot be overwritten. +# Use CUSTOM_GITHUB_REPOSITORY to specify a repo owner/name +# other than the repo owner/name where this script was called from. +# If CUSTOM_GITHUB_REPOSITORY is not specified, fall back to GITHUB_REPOSITORY. REPO_NAME_WITH_OWNER="${CUSTOM_GITHUB_REPOSITORY:-$GITHUB_REPOSITORY}" REPO_NAME="${REPO_NAME_WITH_OWNER#*\/}"