From edc2fb17f0ec4806df5ee5385f0685e474a508bc Mon Sep 17 00:00:00 2001 From: Steve Guntrip Date: Tue, 23 Jan 2024 10:12:13 +0000 Subject: [PATCH 01/12] Add a short introduction to the GitHub Projects map topic (#48789) Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com> --- content/issues/planning-and-tracking-with-projects/index.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/content/issues/planning-and-tracking-with-projects/index.md b/content/issues/planning-and-tracking-with-projects/index.md index 36d8794c99d4..c232de9adf86 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. From 066e2e453dc9aaf735b1f7c5d1143146cb4fea3e Mon Sep 17 00:00:00 2001 From: marz Date: Tue, 23 Jan 2024 05:28:41 -0500 Subject: [PATCH 02/12] Update secret-scanning-partner-program example payload (#48727) Co-authored-by: Anne-Marie <102995847+am-stead@users.noreply.github.com> --- .../secret-scanning-partner-program.md | 30 +++++-------------- 1 file changed, 8 insertions(+), 22 deletions(-) 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 8bf5935b8996..6fe877465be5 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"}] -``` - -{% 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----- +[{"source":"commit","token":"some_token","type":"some_type","url":"https://example.com/base-repo-url/"}] ``` -{% 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. From dcef4a7b6092efd853d40d22c8ba30f952357db5 Mon Sep 17 00:00:00 2001 From: hubwriter Date: Tue, 23 Jan 2024 12:10:13 +0000 Subject: [PATCH 03/12] Delete .devcontainer/test-custom-devcontainer directory --- .../devcontainer.json | 27 ------------------- 1 file changed, 27 deletions(-) delete mode 100644 .devcontainer/test-custom-devcontainer/devcontainer.json diff --git a/.devcontainer/test-custom-devcontainer/devcontainer.json b/.devcontainer/test-custom-devcontainer/devcontainer.json deleted file mode 100644 index 587805e006bc..000000000000 --- 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" - -} From 3f5263c558679258afe11b1896f638c21db39859 Mon Sep 17 00:00:00 2001 From: hubwriter Date: Tue, 23 Jan 2024 12:14:05 +0000 Subject: [PATCH 04/12] Update github-debian.sh --- .devcontainer/library-scripts/github-debian.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/library-scripts/github-debian.sh b/.devcontainer/library-scripts/github-debian.sh index 2d474fdefa72..1a7a177c1892 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] From dc3f4de1d711dc05f6bf2229257a948c306e1933 Mon Sep 17 00:00:00 2001 From: Steve Guntrip Date: Tue, 23 Jan 2024 13:09:42 +0000 Subject: [PATCH 05/12] Update project (classic) usage (#48784) Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com> --- .../verifying-your-email-address.md | 2 +- .../about-your-personal-dashboard.md | 2 +- ...o-your-personal-accounts-project-boards.md | 15 ++--- ...oject-board-owned-by-a-personal-account.md | 63 ++++++++++--------- ...oving-assigned-issues-on-project-boards.md | 15 ++--- ...card-is-added-to-a-project-board-column.md | 5 +- ...g-github-actions-for-project-management.md | 4 +- .../events-that-trigger-workflows.md | 8 +-- ...olicies-for-projects-in-your-enterprise.md | 4 +- .../reviewing-your-security-log.md | 2 +- content/discussions/quickstart.md | 2 +- .../accessibility/github-command-palette.md | 2 +- ...ng-started-with-github-enterprise-cloud.md | 2 +- .../getting-started-with-github-team.md | 4 +- ...etting-started-with-your-github-account.md | 8 +-- .../about-project-boards.md | 2 +- .../changing-project-board-visibility.md | 2 +- .../copying-a-project-board.md | 6 +- .../deleting-a-project-board.md | 2 +- ...es-and-pull-requests-to-a-project-board.md | 2 +- .../migrating-from-projects-classic.md | 10 +-- .../managing-visibility-of-your-projects.md | 2 +- .../creating-an-issue.md | 2 +- ...-tracking-work-for-your-team-or-project.md | 16 ++--- ...sferring-an-issue-to-another-repository.md | 2 +- .../using-ghe-migrator/about-ghe-migrator.md | 2 +- ...rating-data-to-github-enterprise-server.md | 2 +- .../about-organizations.md | 2 +- ...ing-the-audit-log-for-your-organization.md | 2 +- ...t-board-permissions-for-an-organization.md | 6 +- .../deleting-an-organization-account.md | 2 +- ...ing-project-boards-in-your-organization.md | 10 +-- ...ra-with-your-organization-project-board.md | 3 +- .../roles-in-an-organization.md | 8 +-- .../repository-roles-for-an-organization.md | 2 +- ...ery-parameters-to-create-a-pull-request.md | 2 +- .../about-repositories.md | 2 +- .../disabling-projects-in-a-repository.md | 2 +- .../using-the-rest-api/issue-event-types.md | 8 +-- .../searching-issues-and-pull-requests.md | 10 +-- ...-visibility-permissions-or-projects-v2.yml | 2 +- ...classic-project-visibility-permissions.yml | 2 +- .../projects-v1-create-repo-project.yml | 2 +- data/features/projects-v2-migration.yml | 2 +- .../audit_log/audit-log-action-categories.md | 8 +-- ...ng-access-to-repositories-projects-apps.md | 2 +- .../pre-release-program/starfox-preview.md | 2 +- data/reusables/profile/access_profile.md | 2 +- .../add-column-new-project.md | 2 +- .../project-management/choose-template.md | 2 +- .../project-management/choose-visibility.md | 2 +- .../create-project-name-description.md | 2 +- .../edit-project-columns.md | 2 +- ...or-more-info-project-keyboard-shortcuts.md | 2 +- .../project-management/linked-repositories.md | 2 +- .../project-board-import-with-api.md | 2 +- .../projects/classic-project-creation.md | 2 +- data/reusables/projects/disabled-projects.md | 2 +- data/reusables/projects/project_boards_old.md | 2 +- .../assign-an-issue-as-project-maintainer.md | 2 +- data/variables/projects.yml | 8 +-- 61 files changed, 153 insertions(+), 148 deletions(-) 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 184ce49913ba..92926b3f9628 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 f25e9705cdf9..9ecb7f206fd1 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 7bd8ca514809..773a1440b2b1 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/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 a04f4e639223..59b619bf95da 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 @@ -13,51 +13,52 @@ versions: 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 public 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 public 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/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 f92dc9b38356..cb4b46a5caae 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 7bc7c9d1d67e..71cfa7c5f255 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 77ec4e0a19f6..fdb2496e9bc9 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/using-workflows/events-that-trigger-workflows.md b/content/actions/using-workflows/events-that-trigger-workflows.md index 138ff3c103c3..018cd2f8a219 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/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 f1c7aadbf5b8..b910d4fc920d 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/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 9e6226cc18cf..f2efe9247f9c 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,7 +44,7 @@ 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 %} diff --git a/content/discussions/quickstart.md b/content/discussions/quickstart.md index 28299ba6ad67..8f3e647fddc9 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 b6ebdb87f866..b1ad5b1a2566 100644 --- a/content/get-started/accessibility/github-command-palette.md +++ b/content/get-started/accessibility/github-command-palette.md @@ -144,7 +144,7 @@ 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](/get-started/accessibility/managing-your-theme-settings)." | diff --git a/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md b/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md index b2e44bc193b1..4b06b07ff180 100644 --- a/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md +++ b/content/get-started/onboarding/getting-started-with-github-enterprise-cloud.md @@ -114,7 +114,7 @@ To manage and moderate your enterprise, you can set policies for organizations w ### 1. Managing policies for organizations in your enterprise account -You can choose to enforce a number of policies for all organizations owned by your enterprise, or choose to allow these policies to be set in each organization. Types of policies you can enforce include repository management, project board, and team policies. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/policies)." +You can choose to enforce a number of policies for all organizations owned by your enterprise, or choose to allow these policies to be set in each organization. Types of policies you can enforce include repository management, projects, and team policies. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/policies)." ### 2. Viewing audit logs, configuring webhooks, and restricting email notifications for your enterprise diff --git a/content/get-started/onboarding/getting-started-with-github-team.md b/content/get-started/onboarding/getting-started-with-github-team.md index 8ab3490e1f22..0a0c0a59d0a1 100644 --- a/content/get-started/onboarding/getting-started-with-github-team.md +++ b/content/get-started/onboarding/getting-started-with-github-team.md @@ -31,7 +31,7 @@ Only organization members with the _owner_ or _billing manager_ role can access ## Part 2: Adding members and setting up teams -After creating your organization, you can invite members and set permissions and roles. You can also create different levels of teams and set customized levels of permissions for your organization's repositories, project boards, and apps. +After creating your organization, you can invite members and set permissions and roles. You can also create different levels of teams and set customized levels of permissions for your organization's repositories, projects, and apps. ### 1. Managing members of your organization @@ -49,7 +49,7 @@ After creating your organization, you can invite members and set permissions and {% data reusables.getting-started.managing-team-settings %} -### 5. Giving people and teams access to repositories, project boards and apps +### 5. Giving people and teams access to repositories, projects, and apps {% data reusables.getting-started.giving-access-to-repositories-projects-apps %} diff --git a/content/get-started/onboarding/getting-started-with-your-github-account.md b/content/get-started/onboarding/getting-started-with-your-github-account.md index 37f5212fe5da..b804a539a9d9 100644 --- a/content/get-started/onboarding/getting-started-with-your-github-account.md +++ b/content/get-started/onboarding/getting-started-with-your-github-account.md @@ -106,7 +106,7 @@ With {% data variables.product.product_name %}, you can create, edit, move and d ## Part 3: Collaborating on {% data variables.product.product_name %} -Any number of people can work together in repositories across {% data variables.product.product_name %}. You can configure settings, create project boards, and manage your notifications to encourage effective collaboration. +Any number of people can work together in repositories across {% data variables.product.product_name %}. You can configure settings, create projects, and manage your notifications to encourage effective collaboration. ### 1. Working with repositories @@ -130,7 +130,7 @@ If you have existing projects you'd like to move over to {% data variables.produ ### 3. Managing collaborators and permissions -You can collaborate on your project with others using your repository's issues, pull requests, and project boards. You can invite other people to your repository as collaborators from the **Collaborators** tab in the repository settings. For more information, 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)." +You can collaborate on your project with others using your repository's issues, pull requests, and {% data variables.projects.projects_v1_boards %}. You can invite other people to your repository as collaborators from the **Collaborators** tab in the repository settings. For more information, 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)." You are the owner of any repository you create in your personal account and have full control of the repository. Collaborators have write access to your repository, limiting what they have permission to do. 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-personal-account-repository)." @@ -149,9 +149,9 @@ By adding files like contributing guidelines, a code of conduct, and a license t By adding files like contributing guidelines, a code of conduct, and support resources to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions)." {% endif %} -### 6. Using GitHub Issues and project boards +### 6. Using {% data variables.product.prodname_github_issues %} and {% data variables.product.prodname_projects_v2 %} -You can use GitHub Issues to organize your work with issues and pull requests and manage your workflow with project boards. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/about-issues)" and "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." +You can use {% data variables.product.prodname_github_issues %} to organize your work with issues and pull requests and manage your workflow with {% data variables.product.prodname_projects_v2 %}. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/about-issues)" and "[AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." ### 7. Managing notifications 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 ea7a52d5fbc8..f74a5f1cca95 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 16593291ad2a..b555058bb8d1 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 7a460d923bc0..73312a9cfb83 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 4dd563353b58..aa3f90494c69 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 7bf3603a7a59..0ef2165f1149 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 9b07ac8a3a68..8b6d309e8fbf 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/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 f92ec50f1c54..cfba95efcda8 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/creating-an-issue.md b/content/issues/tracking-your-work-with-issues/creating-an-issue.md index 7a9e6499d4b6..709eae733b00 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 851920657998..52f7e8569395 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 @@ -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 fdada85eb6bd..f315d5e852d0 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/using-ghe-migrator/about-ghe-migrator.md b/content/migrations/using-ghe-migrator/about-ghe-migrator.md index 25a2f17e00d7..0cb3e67ea26a 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 700ae03c3f6a..2f24a0f9e4ee 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/organizations/collaborating-with-groups-in-organizations/about-organizations.md b/content/organizations/collaborating-with-groups-in-organizations/about-organizations.md index 2847a712d842..fb737563ff93 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/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 6dc7240073cf..cf5e9b0418b4 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 @@ -76,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 7e2d1e355e0c..a0c2b6483eb4 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 95f5f25c8680..e13f3082fd7d 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 51f94b5faa51..6d1aa665854d 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 96644c2c907f..709e07f3f7a8 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,6 +8,7 @@ versions: ghes: '*' ghae: '*' shortTitle: Integrate Jira +allowTitleToDifferFromFilename: true --- {% ifversion ghes or ghae %} 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 0f7e16fa45d4..144586237d35 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-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 11d34516018b..f7e5525d4c8c 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/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 b80f22d39dc2..c95975b0d4c4 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/repositories/creating-and-managing-repositories/about-repositories.md b/content/repositories/creating-and-managing-repositories/about-repositories.md index 52b89db93886..d39bba944d2b 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/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 1a8d743b1696..987872cf45f6 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/rest/using-the-rest-api/issue-event-types.md b/content/rest/using-the-rest-api/issue-event-types.md index b36926590cd2..3addc128fcdc 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/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 306179ff3294..c4d5759a07bc 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 @@ -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/data/features/classic-project-visibility-permissions-or-projects-v2.yml b/data/features/classic-project-visibility-permissions-or-projects-v2.yml index 32feb60808ff..5e043e3ff72d 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 9e921ee199df..4378df58b176 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 d095bd44f449..8feb2a9cc844 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 2fbce03ddd5b..985704535a21 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/reusables/audit_log/audit-log-action-categories.md b/data/reusables/audit_log/audit-log-action-categories.md index d7bbb485e083..59f9d9a82799 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/getting-started/giving-access-to-repositories-projects-apps.md b/data/reusables/getting-started/giving-access-to-repositories-projects-apps.md index feb8c445b085..c9b44a9aa123 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/pre-release-program/starfox-preview.md b/data/reusables/pre-release-program/starfox-preview.md index aca22eee88d0..93fd99ab54a5 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 4ffe9b8b43ba..5cbbd1931608 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 b6cd2ae07b45..17269bea7f26 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 6979185464e1..f1215bff8428 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 cad83ff9b965..40cdb3fae81a 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 e6367e8cb516..1bf40bc6dc68 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 c532ecf40d63..fdbbde77f43b 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 f838b15b970d..94659914641f 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 80ce41e26a4a..1b64c0f70bfd 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 5070f242899d..f711eabde211 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 84152dfa91d2..29c15666ca9a 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 4e197f27ddc7..4bfe1f8cf810 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 d18fb9b34bba..3acc58a179dd 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/repositories/assign-an-issue-as-project-maintainer.md b/data/reusables/repositories/assign-an-issue-as-project-maintainer.md index 36d7f4e5e6e1..f4adfbf8fc2c 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/variables/projects.yml b/data/variables/projects.yml index 76613f3381d6..b82eeaef027f 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: >- - classic project + {% ifversion ghes < 3.8 %}project board{% else %}project (classic){% endif %} projects_v1_board_caps: >- - Classic project + {% ifversion ghes < 3.8 %}Project board{% else %}Project (classic){% endif %} projects_v1_boards: >- - classic projects + {% ifversion ghes < 3.8 %}project boards{% else %}projects (classic){% endif %} projects_v1_boards_caps: >- - Classic projects + {% ifversion ghes < 3.8 %}Project boards{% else %}Projects (classic){% endif %} command-palette-shortcut: 'Command+K (Mac) or Ctrl+K (Windows/Linux)' From eb9571a80de8d2dee7ae53c4e7adef09ad84b871 Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Tue, 23 Jan 2024 08:12:04 -0500 Subject: [PATCH 06/12] Remove GHAE in Liquid and front matter (7) (#48772) --- content/account-and-profile/index.md | 2 +- .../about-self-hosted-runners.md | 4 ++-- .../understanding-github-actions.md | 2 +- ...ure-devops-with-github-actions-importer.md | 8 +++---- ...rom-bamboo-with-github-actions-importer.md | 2 +- ...-pipelines-with-github-actions-importer.md | 2 +- ...m-circleci-with-github-actions-importer.md | 6 ++--- ...rom-gitlab-with-github-actions-importer.md | 2 +- ...om-jenkins-with-github-actions-importer.md | 6 ++--- ...-travis-ci-with-github-actions-importer.md | 2 +- .../about-github-connect.md | 4 ++-- ...manually-syncing-actions-from-githubcom.md | 8 +++---- .../saml-configuration-reference.md | 6 ++--- ...siderations-for-external-authentication.md | 2 +- .../using-saml-for-enterprise-iam/index.md | 2 +- .../updating-a-users-saml-nameid.md | 2 +- .../configuring-custom-footers.md | 2 +- ...-visibility-for-organization-membership.md | 2 +- ...nting-users-from-creating-organizations.md | 2 +- ...-large-file-storage-for-your-enterprise.md | 2 +- ...bling-git-ssh-access-on-your-enterprise.md | 2 +- .../migrating-to-internal-repositories.md | 2 +- .../viewing-people-in-your-enterprise.md | 2 +- .../index.md | 2 +- ...about-the-audit-log-for-your-enterprise.md | 2 +- ...ching-the-audit-log-for-your-enterprise.md | 24 +++++++++---------- .../overview/about-enterprise-accounts.md | 2 +- .../overview/about-github-for-enterprises.md | 2 +- ...s-for-github-actions-in-your-enterprise.md | 2 +- ...-management-policies-in-your-enterprise.md | 10 ++++---- .../migrating-oauth-apps-to-github-apps.md | 4 ++-- ...hub-app-that-responds-to-webhook-events.md | 10 ++++---- .../building-ci-checks-with-a-github-app.md | 2 +- .../quickstart.md | 4 ++-- .../scopes-for-oauth-apps.md | 2 +- .../sharing-your-github-app.md | 4 ++-- ...talling-a-github-app-from-a-third-party.md | 4 ++-- .../using-ssh-agent-forwarding.md | 10 ++++---- .../reviewing-your-security-log.md | 2 +- .../about-commit-signature-verification.md | 2 +- .../about-code-scanning-with-codeql.md | 2 +- ...ading-codeql-analysis-results-to-github.md | 10 ++++---- ...ing-notifications-for-dependabot-alerts.md | 2 +- ...he-detection-of-vulnerable-dependencies.md | 2 +- ...ng-a-security-policy-to-your-repository.md | 2 +- .../secret-scanning-patterns.md | 2 +- .../end-to-end-supply-chain/securing-code.md | 2 +- .../about-supply-chain-security.md | 2 +- ...loring-the-dependencies-of-a-repository.md | 4 ++-- ...etting-started-with-your-github-account.md | 4 ++-- .../using-github/communicating-on-github.md | 2 +- .../creating-gists.md | 2 +- .../guides/managing-enterprise-accounts.md | 2 +- content/issues/index.md | 5 ++-- .../overview/migration-paths-to-github.md | 4 ++-- ...-of-a-migration-between-github-products.md | 6 ++--- ...ra-with-your-organization-project-board.md | 2 +- ...rogrammatic-access-in-your-organization.md | 2 +- .../introduction-to-github-packages.md | 2 +- ...nstalling-a-package-with-github-actions.md | 2 +- content/packages/quickstart.md | 8 +++---- .../working-with-the-apache-maven-registry.md | 4 ++-- .../working-with-the-docker-registry.md | 10 ++++---- .../working-with-the-npm-registry.md | 4 ++-- .../working-with-the-nuget-registry.md | 4 ++-- .../working-with-the-rubygems-registry.md | 2 +- content/pages/index.md | 10 ++++---- ...reating-a-github-pages-site-with-jekyll.md | 2 +- .../resolving-a-merge-conflict-on-github.md | 4 ++-- ...sitory-is-deleted-or-changes-visibility.md | 2 +- ...creating-a-commit-with-multiple-authors.md | 4 ++-- .../about-protected-branches.md | 2 +- .../available-rules-for-rulesets.md | 2 +- .../deleting-a-repository.md | 2 +- .../restoring-a-deleted-repository.md | 6 ++--- .../setting-repository-visibility.md | 2 +- .../viewing-a-projects-contributors.md | 2 +- .../configuring-git-large-file-storage.md | 2 +- .../authenticating-to-the-rest-api.md | 4 ++-- ...ipting-with-the-rest-api-and-javascript.md | 16 ++++++------- .../scripting-with-the-rest-api-and-ruby.md | 2 +- .../using-pagination-in-the-rest-api.md | 4 ++-- .../about-searching-on-github.md | 2 +- .../understanding-the-search-syntax.md | 2 +- content/search-github/index.md | 3 +-- .../searching-on-github/searching-in-forks.md | 2 +- .../searching-issues-and-pull-requests.md | 2 +- .../troubleshooting-webhooks.md | 6 ++--- content/webhooks/types-of-webhooks.md | 8 +++---- ...led-deliveries-for-a-github-app-webhook.md | 14 +++++------ ...led-deliveries-for-a-repository-webhook.md | 10 ++++---- ...-deliveries-for-an-organization-webhook.md | 10 ++++---- .../using-webhooks/creating-webhooks.md | 2 +- .../using-webhooks/disabling-webhooks.md | 4 ++-- .../using-webhooks/editing-webhooks.md | 2 +- .../handling-failed-webhook-deliveries.md | 2 +- .../webhooks/webhook-events-and-payloads.md | 4 ++-- .../actions/allow-specific-actions-intro.md | 4 ++-- .../actions/disabling-github-actions.md | 2 +- .../self-hosted-runner-ports-protocols.md | 2 +- .../security-feature-availability.md | 2 +- .../deprecating_auth_with_query_parameters.md | 2 +- .../audit_log/audit-log-search-by-repo.md | 2 +- .../codeql-action-version-ghes.md | 2 +- .../codeql-cli/download-codeql-cli-zip.md | 2 +- ...abot-alerts-dependency-graph-enterprise.md | 2 +- .../dependency-review/action-enterprise.md | 2 +- .../enterprise-accounts/options-tab.md | 2 +- .../business.md | 2 +- .../manage-global-webhooks-api.md | 2 +- .../configuring-security-features.md | 2 +- .../gist/anonymous-gists-cannot-be-deleted.md | 2 +- .../notifications/outbound_email_tip.md | 2 +- ...nerable-dependency-notification-options.md | 2 +- .../docker_registry_deprecation_status.md | 2 +- .../package-settings-options-menu.md | 2 +- .../pages/build-failure-email-server.md | 2 +- .../pull_request_merges_and_contributions.md | 2 +- .../repositories/enable-security-alerts.md | 2 +- .../rest-api/github-cli-install-and-auth.md | 2 +- data/reusables/search/syntax_tips.md | 2 +- data/reusables/secret-scanning/api-beta.md | 2 +- ...nterprise-resolving-and-closing-tickets.md | 2 +- data/variables/package_registry.yml | 2 +- data/variables/rest.yml | 2 +- 125 files changed, 225 insertions(+), 227 deletions(-) diff --git a/content/account-and-profile/index.md b/content/account-and-profile/index.md index d9c88496cacc..dee404770ff0 100644 --- a/content/account-and-profile/index.md +++ b/content/account-and-profile/index.md @@ -17,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: 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 024ad3fc41f0..b332241db2fb 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 a70f9071fc8b..c5b6886ab7d3 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/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 4d5e3fe99465..3201d4b7aeae 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 e226f1fb2a51..ed038d812760 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 a2e719c79a13..11e9db89d0f7 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 bb8e217d9b0a..0076ac163e96 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 fcaa85a12595..efe0a2f5c39b 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 2455f453cef9..dfcad8292cbc 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 0564ae15d42e..400132ea4f97 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/admin/configuration/configuring-github-connect/about-github-connect.md b/content/admin/configuration/configuring-github-connect/about-github-connect.md index 2997ae6dd138..3d3cc023c0a8 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/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 1f3e8db61c34..5eaec49fb25f 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/iam-configuration-reference/saml-configuration-reference.md b/content/admin/identity-and-access-management/iam-configuration-reference/saml-configuration-reference.md index 567615bbcf3a..67539a65c0fa 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 3daba543e01c..2f8f367360ac 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-saml-for-enterprise-iam/index.md b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/index.md index f3d5025e902d..4992bb4e943b 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 938c06089ef2..b7f7270cecaf 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 c1be9fcdf0d4..51163248101a 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/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 8bba0585302d..b6aaa3478e31 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 24e5b3bc1d15..355bfd4e6156 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 0c425bc7fdf7..c00cd4d0ae34 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 6900ff03aa0b..2ce6c23bec23 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 24440a826993..8bf53326b7a0 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/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 8f85e2699ed1..41a7e8ea2cf0 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 229bc2361787..fa69cd7d09de 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 e5563d5877b6..20dfa5f8b702 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/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 bcaab95c3fa9..2c32350e2761 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 33571185e16b..ce6f34dad57b 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 ecf8de9d44ff..2272746cdaa9 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 9dd5bd0505f7..66081beb6aed 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-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 cebe4b9cec30..d607cf44b954 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 d871ee4b5766..1d4da5423487 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 9c44fc4a49e4..370f4b87519b 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 d9921cf62f24..cc6cab68dec0 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 7e497466bd2c..12217d13827e 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 eb2e1cbdebe7..a1c5fb5009f8 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/sharing-github-apps/sharing-your-github-app.md b/content/apps/sharing-github-apps/sharing-your-github-app.md index 0ba90e883099..c8421ee14deb 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 179125a37bc1..7751a0f3f06b 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/using-ssh-agent-forwarding.md b/content/authentication/connecting-to-github-with-ssh/using-ssh-agent-forwarding.md index 4a2bf492e55c..607ca9cd3923 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/reviewing-your-security-log.md b/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md index f2efe9247f9c..12460bc8bdd8 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 @@ -47,7 +47,7 @@ The events listed in your security log are triggered by your actions. Actions ar | `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/managing-commit-signature-verification/about-commit-signature-verification.md b/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md index 86c7be69f272..93f3d617a54d 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 %} 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 e04618bc1de1..3dbc5661a1a2 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 8b7e41fe5ef7..70a2a7aed71a 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/configuring-notifications-for-dependabot-alerts.md b/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md index f3cdc3c7e85d..8ab3f481be44 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 @@ -33,7 +33,7 @@ When {% data variables.product.prodname_dependabot %} detects vulnerable depende {% 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/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 40d4a30a8f3f..076baa966b70 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 228941262967..1f00d6d1a2d5 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/secret-scanning-patterns.md b/content/code-security/secret-scanning/secret-scanning-patterns.md index e57b508c04b8..66283bcfae64 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 %} 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 b5b9485cffc3..22178c2729de 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 286cdb9298da..70908cf20960 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 @@ -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/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 fb845036a4d9..9091885642ab 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/get-started/onboarding/getting-started-with-your-github-account.md b/content/get-started/onboarding/getting-started-with-your-github-account.md index b804a539a9d9..a9f1d713402c 100644 --- a/content/get-started/onboarding/getting-started-with-your-github-account.md +++ b/content/get-started/onboarding/getting-started-with-your-github-account.md @@ -40,7 +40,7 @@ For more information on all of {% data variables.product.prodname_dotcom %}'s pl To ensure you can use all the features in your {% data variables.product.product_name %} plan, verify your email address after signing up for a new account. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address)." {% endif %} -{% ifversion ghes or ghae %} +{% ifversion ghes %} ### 1. Accessing your account @@ -145,7 +145,7 @@ To encourage collaborators in your repository, you need a community that encoura By adding files like contributing guidelines, a code of conduct, and a license to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions)." {% endif %} -{% ifversion ghes or ghae %} +{% ifversion ghes %} By adding files like contributing guidelines, a code of conduct, and support resources to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions)." {% endif %} diff --git a/content/get-started/using-github/communicating-on-github.md b/content/get-started/using-github/communicating-on-github.md index 1f17541995dd..ccb8ce73a035 100644 --- a/content/get-started/using-github/communicating-on-github.md +++ b/content/get-started/using-github/communicating-on-github.md @@ -61,7 +61,7 @@ You can create and participate in issues, pull requests and team discussions, de ### Team discussions - can be started on your team's page for conversations that span across projects and don't belong in a specific issue or pull request. Instead of opening an issue in a repository to discuss an idea, you can include the entire team by having a conversation in a team discussion. -- allow you to hold discussions with your team about planning, analysis, design, user research and general project decision making in one place.{% ifversion ghes or ghae %} +- allow you to hold discussions with your team about planning, analysis, design, user research and general project decision making in one place.{% ifversion ghes %} - provide a collaborative experience outside the codebase, allowing the brainstorming of ideas. - often don’t have a clear owner. - often do not result in an actionable task.{% endif %} diff --git a/content/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md b/content/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md index e1bd713d71a2..63a73d0361c9 100644 --- a/content/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md +++ b/content/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md @@ -44,7 +44,7 @@ You can pin gists to your profile so other people can see them easily. For more {% endif %} -You can discover {% ifversion ghae %}internal{% else %}public{% endif %} gists others have created by going to the {% data variables.gists.gist_homepage %} and clicking **All Gists**. This will take you to a page of all gists sorted and displayed by time of creation or update. You can also search gists by language with {% data variables.gists.gist_search_url %}. {% ifversion ghes or ghae %}Gist search uses the same search syntax as [code search](/search-github/searching-on-github/searching-code).{% endif %} +You can discover {% ifversion ghae %}internal{% else %}public{% endif %} gists others have created by going to the {% data variables.gists.gist_homepage %} and clicking **All Gists**. This will take you to a page of all gists sorted and displayed by time of creation or update. You can also search gists by language with {% data variables.gists.gist_search_url %}. {% ifversion ghes %}Gist search uses the same search syntax as [code search](/search-github/searching-on-github/searching-code).{% endif %} Since gists are Git repositories, you can view their full commit history, complete with diffs. You can also fork or clone gists. For more information, see "[AUTOTITLE](/get-started/writing-on-github/editing-and-sharing-content-with-gists/forking-and-cloning-gists)." diff --git a/content/graphql/guides/managing-enterprise-accounts.md b/content/graphql/guides/managing-enterprise-accounts.md index 078ad7e99df4..54f529618681 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/issues/index.md b/content/issues/index.md index ff003b8aa715..cdf3809fe12c 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/migrations/overview/migration-paths-to-github.md b/content/migrations/overview/migration-paths-to-github.md index 646ecd1d5d62..5ceffb5574cf 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-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 6eba448ac783..c75826c1b1bd 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/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 709e07f3f7a8..e7bcf620a5ce 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 @@ -11,7 +11,7 @@ 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-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 15876f61324c..8353fdd206f4 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/packages/learn-github-packages/introduction-to-github-packages.md b/content/packages/learn-github-packages/introduction-to-github-packages.md index bb0fe232fa0e..2666957915ce 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 ff8a829a0260..e14bd348e41f 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 6e5f82044184..4b1156e121c0 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 a16d40e2b537..d26480405f91 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 105e3060de60..e698fdd6be2c 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 c3e202bbf9b5..81ee3b6aa2ac 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 @@ -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: @@ -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 576a9bcf2820..dffc013b7e2d 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: @@ -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 3d2de5366629..c11e09540ddb 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/index.md b/content/pages/index.md index 0febf26fc722..c6a0f0283559 100644 --- a/content/pages/index.md +++ b/content/pages/index.md @@ -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 69741ef91e79..f8945450c3f6 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 @@ -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 {% data variables.location.product_location %} 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 737e61d1a3c1..d5b51c28b482 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/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 4d72b3983a44..e9c50a3c0f04 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 8f6a7ed26817..a111e588039a 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 @@ -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/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 b6a1ed7d7640..041a025573f2 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 08f455c07c28..58abb8ef8a4a 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/deleting-a-repository.md b/content/repositories/creating-and-managing-repositories/deleting-a-repository.md index ff8c6edbe35a..cb4fe480f2d3 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/restoring-a-deleted-repository.md b/content/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md index f151ca28ef70..28ac3a28a4c8 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/managing-repository-settings/setting-repository-visibility.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility.md index 31a760709a78..f270970cb5e4 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 9a4b8c2aea4e..d438008f08a6 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-large-files/configuring-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md index 392ac6156af5..f5a57541f2fe 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/rest/authentication/authenticating-to-the-rest-api.md b/content/rest/authentication/authenticating-to-the-rest-api.md index ec3135ce78b7..9c6cc119b336 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/guides/scripting-with-the-rest-api-and-javascript.md b/content/rest/guides/scripting-with-the-rest-api-and-javascript.md index 63e3a10eb3ce..a5fd9a883274 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 e26509a91b5b..2d0acd4c677c 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/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 c1487dd2692e..b098d6282bd8 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 e6cdf23813cd..30b96dea84e2 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 4491caa52a0d..c420e33189c9 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 7067f23f4591..ed0d2275a5bc 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 a45790fb234a..525715744e3e 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 c4d5759a07bc..9d3b91717de9 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. diff --git a/content/webhooks/testing-and-troubleshooting-webhooks/troubleshooting-webhooks.md b/content/webhooks/testing-and-troubleshooting-webhooks/troubleshooting-webhooks.md index 1587b8b439da..b66cfab664d9 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 5ee71c8814e9..aafca42ecea9 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 7f47430386db..8a651dac0089 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 acdcf6eee473..ea3248818f88 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 5ff83e973fd6..5393438c9045 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 b51b04ef9e75..a074bb1b4e02 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 a12ab0665d88..384e513054b0 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 194700bd6268..5121b8ea2e26 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 ff44d4d9f03a..9680f4a9a361 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 406a89dda605..de0b98b32f56 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/data/reusables/actions/allow-specific-actions-intro.md b/data/reusables/actions/allow-specific-actions-intro.md index 72985b229275..62bc46f16f82 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/disabling-github-actions.md b/data/reusables/actions/disabling-github-actions.md index ef2c62fe2f15..5600ce0f016b 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/self-hosted-runner-ports-protocols.md b/data/reusables/actions/self-hosted-runner-ports-protocols.md index fa711b3cb330..97bd3c272331 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/advanced-security/security-feature-availability.md b/data/reusables/advanced-security/security-feature-availability.md index ef965ceae37e..9141e7dbcfb2 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/apps/deprecating_auth_with_query_parameters.md b/data/reusables/apps/deprecating_auth_with_query_parameters.md index 70b201d9fc99..5dcb8b4407d6 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-search-by-repo.md b/data/reusables/audit_log/audit-log-search-by-repo.md index 477159be6318..e37783b24eb4 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/code-scanning/codeql-action-version-ghes.md b/data/reusables/code-scanning/codeql-action-version-ghes.md index 3dcbf5daf0f6..40bd35011d50 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 2ba9445c16cf..f0e0fb2a187c 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 3fdebf70bcf9..168833580d3f 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/dependency-review/action-enterprise.md b/data/reusables/dependency-review/action-enterprise.md index a4594a91719e..090c5be3127c 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/enterprise-accounts/options-tab.md b/data/reusables/enterprise-accounts/options-tab.md index db4daa031224..61a5d80fc425 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_site_admin_settings/business.md b/data/reusables/enterprise_site_admin_settings/business.md index 294572aa66fb..8f069750cbf7 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 e7812fd30d2d..104275e1251d 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 fda18241c1ef..666b0a16a841 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/gist/anonymous-gists-cannot-be-deleted.md b/data/reusables/gist/anonymous-gists-cannot-be-deleted.md index 331f4fe843b2..08240b244823 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 e8f714d69a02..b8f39b8511a2 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 151022cb11e8..7aaf3182ff36 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 fda36cc7e974..df327c3f2469 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 b11a59103e52..62dc04923241 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 89e9253b460d..a381bc2e0367 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/pull_requests/pull_request_merges_and_contributions.md b/data/reusables/pull_requests/pull_request_merges_and_contributions.md index 81bef02ac872..974e28e72659 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/enable-security-alerts.md b/data/reusables/repositories/enable-security-alerts.md index 56fda0f0c1cb..61b386aa3d0b 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/rest-api/github-cli-install-and-auth.md b/data/reusables/rest-api/github-cli-install-and-auth.md index b41e5a727a1d..b443f15429b5 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/search/syntax_tips.md b/data/reusables/search/syntax_tips.md index 8d3e299d35ca..0c7bcf97576d 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 b3fdea646240..a5579fe470f0 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/enterprise-resolving-and-closing-tickets.md b/data/reusables/support/enterprise-resolving-and-closing-tickets.md index 07a7e65c8401..f4c958c2dda9 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/variables/package_registry.yml b/data/variables/package_registry.yml index 8b52f7894d55..9a0395602186 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/rest.yml b/data/variables/rest.yml index 6ce315f536d8..8d3eb2d7a9b6 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' From 23cea62e0aa518201e9dc1d134016bcf71857920 Mon Sep 17 00:00:00 2001 From: Taylor Reis <76077878+taylorreis@users.noreply.github.com> Date: Tue, 23 Jan 2024 06:37:33 -0700 Subject: [PATCH 07/12] Update EMU guest collaborator docs to reflect current product behavior (#48554) Co-authored-by: Matt Pollard --- ...-single-sign-on-for-enterprise-managed-users.md | 6 +++++- .../roles-in-an-enterprise.md | 14 +++++--------- data/reusables/emus/guest-collaborators-note.md | 8 ++++++++ 3 files changed, 18 insertions(+), 10 deletions(-) create mode 100644 data/reusables/emus/guest-collaborators-note.md 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 046f3015b1d1..3c41f7e48304 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/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 90f323c2082c..35066ddc5153 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/data/reusables/emus/guest-collaborators-note.md b/data/reusables/emus/guest-collaborators-note.md new file mode 100644 index 000000000000..aa962136ecea --- /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 %} From cb3b67c328a5cc9b33edfa1a956f534af96c7ea5 Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Tue, 23 Jan 2024 09:40:45 -0500 Subject: [PATCH 08/12] CI with Elasticsearch v8.12 (#48763) --- .github/actions/setup-elasticsearch/action.yml | 2 +- .github/workflows/sync-search-pr.yml | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/actions/setup-elasticsearch/action.yml b/.github/actions/setup-elasticsearch/action.yml index b67842892a8f..34199495b9dd 100644 --- a/.github/actions/setup-elasticsearch/action.yml +++ b/.github/actions/setup-elasticsearch/action.yml @@ -17,7 +17,7 @@ runs: with: # Make sure this matches production # It might also need to match what's available on Docker hub - elasticsearch version: '8.8.2' + elasticsearch version: '8.12.0' host port: 9200 container port: 9200 host node port: 9300 diff --git a/.github/workflows/sync-search-pr.yml b/.github/workflows/sync-search-pr.yml index 9805b7e1459c..f2c5c2748b41 100644 --- a/.github/workflows/sync-search-pr.yml +++ b/.github/workflows/sync-search-pr.yml @@ -13,6 +13,8 @@ on: - 'package*.json' # Ultimately, for debugging this workflow itself - .github/workflows/sync-search-pr.yml + # Make sure we run this if the composite action changes + - .github/actions/setup-elasticsearch/action.yml permissions: contents: read From 2570661a4c67339bc6b1ab609d9a766c73693c5f Mon Sep 17 00:00:00 2001 From: David Jarzebowski Date: Tue, 23 Jan 2024 10:53:18 -0500 Subject: [PATCH 09/12] Update instructions to include workaround for known issue when installing SSL certificate authority certificates (#48797) Co-authored-by: Matt Pollard --- .../command-line-utilities.md | 6 ++++++ .../troubleshooting-tls-errors.md | 2 ++ .../using-cas-for-enterprise-iam/using-cas.md | 1 + 3 files changed, 9 insertions(+) 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 17a7cb2f6325..e427b55ebe16 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/hardening-security-for-your-enterprise/troubleshooting-tls-errors.md b/content/admin/configuration/hardening-security-for-your-enterprise/troubleshooting-tls-errors.md index a161a830046e..d2e088340de1 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/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 1a3128cbcbcc..540b5f997055 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 %} From 733415cdaaeaf631bcc5f3db562f742f1afeb3db Mon Sep 17 00:00:00 2001 From: Jorge <46056498+jorgectf@users.noreply.github.com> Date: Tue, 23 Jan 2024 17:55:03 +0100 Subject: [PATCH 10/12] Polish use of `changed-files`: Disable `safe_output` and use env var (#48787) Co-authored-by: Peter Bengtsson Co-authored-by: Peter Bengtsson --- .github/workflows/content-lint-markdown.yml | 11 ++++++++++- .github/workflows/test-changed-content.yml | 5 +++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/.github/workflows/content-lint-markdown.yml b/.github/workflows/content-lint-markdown.yml index 265fe6fb753e..47a1051eaa80 100644 --- a/.github/workflows/content-lint-markdown.yml +++ b/.github/workflows/content-lint-markdown.yml @@ -32,10 +32,19 @@ jobs: id: changed-files uses: tj-actions/changed-files@716b1e13042866565e00e85fd4ec490e186c4a2f # v41.0.1 with: + # No need to escape the file names because we make the output of + # tj-actions/changed-files be set as an environment variable. Not + # as a direct input to the line of bash that uses it. + safe_output: false files: | content/** data/** - name: Run content linter if changed content/data files if: steps.changed-files.outputs.any_changed == 'true' - run: npm run lint-content -- --errors-only --paths ${{ steps.changed-files.outputs.all_changed_files }} + env: + # Make it an environment variable so that its value doesn't need to be escaped. + # See https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions#using-an-intermediate-environment-variable + CHANGED_FILES: |- + ${{ steps.changed-files.outputs.all_changed_files }} + run: npm run lint-content -- --errors-only --paths "$CHANGED_FILES" diff --git a/.github/workflows/test-changed-content.yml b/.github/workflows/test-changed-content.yml index f24d7698949c..d6b2e551b6a6 100644 --- a/.github/workflows/test-changed-content.yml +++ b/.github/workflows/test-changed-content.yml @@ -47,6 +47,11 @@ jobs: id: changed-files uses: tj-actions/changed-files@716b1e13042866565e00e85fd4ec490e186c4a2f # v41.0.1 with: + # No need to escape the file names because we make the output of + # tj-actions/changed-files be set as an environment variable. Not + # as a direct input to the line of bash that uses it. + # See https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions#using-an-intermediate-environment-variable + safe_output: false files: 'content/**' # Necessary so we can know what the old name was when a # content file was renamed. From fe856057733f3ceaf07bf1b49aab9cc1673f5253 Mon Sep 17 00:00:00 2001 From: Sumaiya Tarannum Noor Date: Tue, 23 Jan 2024 22:58:46 +0600 Subject: [PATCH 11/12] Update working-with-the-npm-registry.md (#31207) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../working-with-the-npm-registry.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) 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 81ee3b6aa2ac..3b43c3324b8b 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 %} @@ -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 %} From c0a98f42816f9408c7921eda6abe67efbc5364be Mon Sep 17 00:00:00 2001 From: Sarah Edwards Date: Tue, 23 Jan 2024 08:58:59 -0800 Subject: [PATCH 12/12] Update comment based on feedback (#48807) --- src/workflows/get-preview-app-info.sh | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/workflows/get-preview-app-info.sh b/src/workflows/get-preview-app-info.sh index 094ff29687cf..3624f683d088 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#*\/}"