diff --git a/assets/images/help/2fa/filter-org-collaborator-by-2fa-required.png b/assets/images/help/2fa/filter-org-collaborator-by-2fa-required.png deleted file mode 100644 index f465b5da65c5..000000000000 Binary files a/assets/images/help/2fa/filter-org-collaborator-by-2fa-required.png and /dev/null differ diff --git a/assets/images/help/2fa/filter-org-members-by-2fa-required.png b/assets/images/help/2fa/filter-org-members-by-2fa-required.png deleted file mode 100644 index e293b3784eeb..000000000000 Binary files a/assets/images/help/2fa/filter-org-members-by-2fa-required.png and /dev/null differ diff --git a/assets/images/help/2fa/filter-outside-collaborators-by-2fa.png b/assets/images/help/2fa/filter-outside-collaborators-by-2fa.png deleted file mode 100644 index db309c221a6c..000000000000 Binary files a/assets/images/help/2fa/filter-outside-collaborators-by-2fa.png and /dev/null differ diff --git a/assets/images/help/copilot/indexed-repo.png b/assets/images/help/copilot/indexed-repo.png deleted file mode 100644 index de9aff6cbe86..000000000000 Binary files a/assets/images/help/copilot/indexed-repo.png and /dev/null differ diff --git a/assets/images/help/security-overview/security-overview-codeql-pull-requests-alerts-report.png b/assets/images/help/security-overview/security-overview-codeql-pull-requests-alerts-report.png deleted file mode 100644 index e3f5582ead27..000000000000 Binary files a/assets/images/help/security-overview/security-overview-codeql-pull-requests-alerts-report.png and /dev/null differ diff --git a/content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/about-the-monitor-dashboards.md b/content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/about-the-monitor-dashboards.md index c152871ead30..a0ce63d4b216 100644 --- a/content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/about-the-monitor-dashboards.md +++ b/content/admin/monitoring-and-managing-your-instance/monitoring-your-instance/about-the-monitor-dashboards.md @@ -27,7 +27,7 @@ shortTitle: About the monitor {% ifversion ghes > 3.15 %}dashboards{% else %}das {% data reusables.enterprise_site_admin_settings.management-console %} 1. In the top navigation bar, click **Monitor**. - ![Screenshot of the header of the {% data variables.enterprise.management_console %}. A tab, labeled "Monitor", is highlighted with an orange outline.](/assets/images/enterprise/management-console/{% ifversion ghes > 3.15 %}monitor-dash-link.png{% else %}monitor-dash-link-old.png{% endif %}) + ![Screenshot of the header of the {% data variables.enterprise.management_console %}. A tab, labeled "Monitor", is highlighted with an orange outline.]({% ifversion ghes > 3.15 %}/assets/images/enterprise/management-console/monitor-dash-link.png{% else %}/assets/images/enterprise/management-console/monitor-dash-link-old.png{% endif %}) 1. In HA and cluster environments you can switch between nodes using the dropdown and clicking on a different hostname. {% ifversion ghes > 3.15 %} diff --git a/content/rest/about-the-rest-api/about-the-openapi-description-for-the-rest-api.md b/content/rest/about-the-rest-api/about-the-openapi-description-for-the-rest-api.md index dbbb398fe075..c551c6263cd3 100644 --- a/content/rest/about-the-rest-api/about-the-openapi-description-for-the-rest-api.md +++ b/content/rest/about-the-rest-api/about-the-openapi-description-for-the-rest-api.md @@ -1,7 +1,7 @@ --- title: About the OpenAPI description for the REST API shortTitle: OpenAPI description -intro: 'The {% data variables.product.product_name %} REST API is fully described in an OpenAPI compliant document.' +intro: 'The {% data variables.product.github %} REST API is fully described in an OpenAPI compliant document.' versions: fpt: '*' ghes: '*' diff --git a/content/rest/about-the-rest-api/breaking-changes.md b/content/rest/about-the-rest-api/breaking-changes.md index 4f2325d54ff5..151b02462eac 100644 --- a/content/rest/about-the-rest-api/breaking-changes.md +++ b/content/rest/about-the-rest-api/breaking-changes.md @@ -26,4 +26,4 @@ Once your integration is updated, test your integration to verify that it works ## Breaking changes for {{ initialRestVersioningReleaseDate }} -Version `{{ initialRestVersioningReleaseDate }}` is the first version of the {% data variables.product.product_name %} REST API after date-based versioning was introduced. This version does not include any breaking changes. +Version `{{ initialRestVersioningReleaseDate }}` is the first version of the {% data variables.product.github %} REST API after date-based versioning was introduced. This version does not include any breaking changes. diff --git a/content/rest/about-the-rest-api/comparing-githubs-rest-api-and-graphql-api.md b/content/rest/about-the-rest-api/comparing-githubs-rest-api-and-graphql-api.md index d5848586a94c..1efab397e231 100644 --- a/content/rest/about-the-rest-api/comparing-githubs-rest-api-and-graphql-api.md +++ b/content/rest/about-the-rest-api/comparing-githubs-rest-api-and-graphql-api.md @@ -1,7 +1,7 @@ --- title: Comparing GitHub's REST API and GraphQL API shortTitle: Comparing GitHub's APIs -intro: 'Learn about {% data variables.product.prodname_dotcom %}''s APIs to extend and customize your {% data variables.product.prodname_dotcom %} experience.' +intro: 'Learn about {% data variables.product.github %}''s APIs to extend and customize your {% data variables.product.github %} experience.' redirect_from: - /v3/versions - /articles/getting-started-with-the-api @@ -29,7 +29,7 @@ This article discusses the benefits of each API. For more information about the The GraphQL API returns exactly the data that you request. GraphQL also returns the data in a pre-known structure based on your request. In contrast, the REST API returns more data than you requested and returns it in a pre-determined structure. You can also accomplish the equivalent of multiple REST API request in a single GraphQL request. The ability to make fewer requests and fetch less data makes GraphQL appealing to developers of mobile applications. -For example, to get the {% data variables.product.product_name %} login of ten of your followers, and the login of ten followers of each of your followers, you can send a single request like: +For example, to get the {% data variables.product.github %} login of ten of your followers, and the login of ten followers of each of your followers, you can send a single request like: ```graphql { diff --git a/content/rest/activity/events.md b/content/rest/activity/events.md index 033d838907ef..e2002e9d83c4 100644 --- a/content/rest/activity/events.md +++ b/content/rest/activity/events.md @@ -3,7 +3,7 @@ title: REST API endpoints for events shortTitle: Events allowTitleToDifferFromFilename: true intro: >- - Use the REST API to interact with {% data variables.product.prodname_dotcom %} + Use the REST API to interact with {% data variables.product.github %} events. versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 fpt: '*' @@ -14,11 +14,11 @@ topics: autogenerated: rest --- -## About {% data variables.product.prodname_dotcom %} events +## About {% data variables.product.github %} events -{% data variables.product.prodname_dotcom %} events power the various activity streams on the site. +{% data variables.product.github %} events power the various activity streams on the site. -You can use the REST API to return different types of events triggered by activity on {% data variables.product.product_name %}. For more information about the specific events that you can receive, see [AUTOTITLE](/webhooks-and-events/events/github-event-types). Endpoints for repository issues are also available. For more information, see [AUTOTITLE](/rest/issues/events). +You can use the REST API to return different types of events triggered by activity on {% data variables.product.github %}. For more information about the specific events that you can receive, see [AUTOTITLE](/webhooks-and-events/events/github-event-types). Endpoints for repository issues are also available. For more information, see [AUTOTITLE](/rest/issues/events). Events are optimized for polling with the "ETag" header. If no new events have been triggered, you will see a "304 Not Modified" response, and your current rate limit will be untouched. There is also an "X-Poll-Interval" header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header. diff --git a/content/rest/activity/notifications.md b/content/rest/activity/notifications.md index 16bec847fc69..5dc1e20614fa 100644 --- a/content/rest/activity/notifications.md +++ b/content/rest/activity/notifications.md @@ -3,7 +3,7 @@ title: REST API endpoints for notifications shortTitle: Notifications allowTitleToDifferFromFilename: true intro: >- - Use the REST API to manage {% data variables.product.product_name %} + Use the REST API to manage {% data variables.product.github %} notifications. versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 fpt: '*' @@ -14,11 +14,11 @@ topics: autogenerated: rest --- -## About {% data variables.product.product_name %} notifications +## About {% data variables.product.github %} notifications {% data reusables.user-settings.notifications-api-classic-pat-only %} -You can use the REST API to manage {% data variables.product.product_name %} notifications. For more information about notifications, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications). +You can use the REST API to manage {% data variables.product.github %} notifications. For more information about notifications, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications). All calls to these endpoints require the `notifications` or `repo` scopes. You will need the `repo` scope to access issues and commits from their respective endpoints. diff --git a/content/rest/dependency-graph/sboms.md b/content/rest/dependency-graph/sboms.md index 904c8f62f520..b832e6c2716b 100644 --- a/content/rest/dependency-graph/sboms.md +++ b/content/rest/dependency-graph/sboms.md @@ -16,7 +16,8 @@ allowTitleToDifferFromFilename: true This article gives details about the REST API endpoint. {% ifversion ghes %} -{% data variables.product.product_name %} does not retrieve license information for dependencies, and does not calculate information about dependents, the repositories and packages that depend on a repository. These fields will not be populated in the response. +> [!NOTE] +> {% data variables.product.prodname_ghe_server %} does not retrieve license information for dependencies, and does not calculate information about dependents, the repositories and packages that depend on a repository. These fields will not be populated in the response. {% endif %} diff --git a/content/rest/enterprise-admin/index.md b/content/rest/enterprise-admin/index.md index 1a3aac673780..8d774ec931e8 100644 --- a/content/rest/enterprise-admin/index.md +++ b/content/rest/enterprise-admin/index.md @@ -70,11 +70,11 @@ http(s)://HOSTNAME:ADMINISTRATION-PORT/ ## Authentication -Your {% data variables.product.product_name %} installation's API endpoints accept the same authentication methods as the {% data variables.product.prodname_dotcom %} API. For more information, see [AUTOTITLE](/rest/overview/authenticating-to-the-rest-api). +Your {% data variables.product.prodname_ghe_server %} installation's API endpoints accept the same authentication methods as the {% data variables.product.github %} API. For more information, see [AUTOTITLE](/rest/overview/authenticating-to-the-rest-api). OAuth tokens must have the `site_admin` [OAuth scope](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes) when used with these endpoints. -These endpoints are only accessible to authenticated {% data variables.product.product_name %} site administrators, except for endpoints of the [AUTOTITLE](/rest/enterprise-admin/manage-ghes) API{% ifversion ghes < 3.15 %} and [AUTOTITLE](/rest/enterprise-admin/management-console) API{% endif %}, which allow authentication as a Management Console user. See [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console). +These endpoints are only accessible to authenticated {% data variables.product.prodname_ghe_server %} site administrators, except for endpoints of the [AUTOTITLE](/rest/enterprise-admin/manage-ghes) API{% ifversion ghes < 3.15 %} and [AUTOTITLE](/rest/enterprise-admin/management-console) API{% endif %}, which allow authentication as a Management Console user. See [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console). {% data reusables.enterprise_management_console.api-deprecation %} diff --git a/content/rest/enterprise-admin/ldap.md b/content/rest/enterprise-admin/ldap.md index 2f8cef19bd05..da003accee2b 100644 --- a/content/rest/enterprise-admin/ldap.md +++ b/content/rest/enterprise-admin/ldap.md @@ -3,8 +3,7 @@ title: REST API endpoints for LDAP shortTitle: LDAP allowTitleToDifferFromFilename: true intro: >- - Use the REST API to update account relationships between a {% data - variables.product.product_name %} user or team and its linked LDAP entry or + Use the REST API to update account relationships between a {% data variables.product.prodname_ghe_server %} user or team and its linked LDAP entry or queue a new synchronization. versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 ghes: '*' @@ -15,7 +14,7 @@ autogenerated: rest ## About LDAP -You can use these endpoints to update the Distinguished Name (DN) that a user or team maps to. Note that in most cases, you must have [LDAP Sync enabled](/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap) for your {% data variables.product.product_name %} appliance. The [Update LDAP mapping for a user](#update-ldap-mapping-for-a-user) endpoint can be used when LDAP is enabled, even if LDAP Sync is disabled. +You can use these endpoints to update the Distinguished Name (DN) that a user or team maps to. Note that in most cases, you must have [LDAP Sync enabled](/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap) for your {% data variables.product.prodname_ghe_server %} appliance. The [Update LDAP mapping for a user](#update-ldap-mapping-for-a-user) endpoint can be used when LDAP is enabled, even if LDAP Sync is disabled. {% data reusables.user-settings.enterprise-admin-api-classic-pat-only %} diff --git a/content/rest/enterprise-admin/manage-ghes.md b/content/rest/enterprise-admin/manage-ghes.md index b30c11b97697..dc8e8d76ff06 100644 --- a/content/rest/enterprise-admin/manage-ghes.md +++ b/content/rest/enterprise-admin/manage-ghes.md @@ -3,7 +3,7 @@ title: REST API endpoints for managing GitHub Enterprise Server allowTitleToDifferFromFilename: true shortTitle: Manage GHES intro: >- - Use the REST API to manage your {% data variables.product.product_name %} + Use the REST API to manage your {% data variables.product.prodname_ghe_server %} instance. versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 ghes: '*' diff --git a/content/rest/enterprise-admin/management-console.md b/content/rest/enterprise-admin/management-console.md index ba5cb868332a..cde095be9746 100644 --- a/content/rest/enterprise-admin/management-console.md +++ b/content/rest/enterprise-admin/management-console.md @@ -3,7 +3,7 @@ title: REST API endpoints for Management Console shortTitle: Management Console allowTitleToDifferFromFilename: true intro: >- - Use the REST API to manage your {% data variables.product.product_name %} + Use the REST API to manage your {% data variables.product.prodname_ghe_server %} installation. versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 ghes: <=3.14 @@ -14,7 +14,7 @@ autogenerated: rest ## About the Management Console endpoints -The full functionality of the Management Console endpoints was added to the [Manage GHES](/rest/enterprise-admin/manage-ghes) endpoints in {% data variables.product.prodname_ghe_server %} version 3.12. With feature parity achieved, the Management Console API endpoints {% ifversion ghes < 3.15 %}will be{% else %}were{% endif %} removed in version 3.15. +The full functionality of the Management Console endpoints was added to the [Manage GHES](/rest/enterprise-admin/manage-ghes) endpoints in {% data variables.product.prodname_ghe_server %} version 3.12. With feature parity achieved, the Management Console API endpoints were removed in version 3.15. {% ifversion management-console-manage-ghes-parity %} @@ -42,7 +42,7 @@ You should explicitly set the port number when making API calls to the Managemen If you cannot provide a port number, you'll need to configure your tool to automatically follow redirects. -You may also need to add the [`-k` flag](http://curl.haxx.se/docs/manpage.html#-k) when using `curl`, since {% data variables.product.product_name %} uses a self-signed certificate before you [add your own TLS certificate](/admin/configuration/configuring-network-settings/configuring-tls). +You may also need to add the [`-k` flag](http://curl.haxx.se/docs/manpage.html#-k) when using `curl`, since {% data variables.product.github %} uses a self-signed certificate before you [add your own TLS certificate](/admin/configuration/configuring-network-settings/configuring-tls). ### Authentication as the root site administrator diff --git a/content/rest/enterprise-admin/pre-receive-environments.md b/content/rest/enterprise-admin/pre-receive-environments.md index b802cb64c93a..234581ad55bd 100644 --- a/content/rest/enterprise-admin/pre-receive-environments.md +++ b/content/rest/enterprise-admin/pre-receive-environments.md @@ -26,7 +26,7 @@ These endpoints are only available to [authenticated](/rest/overview/authenticat |-----------------------|-----------|----------------------------------------------------------------------------| | `name` | `string` | The name of the environment as displayed in the UI. | | `image_url` | `string` | URL to the tarball that will be downloaded and extracted. | -| `default_environment` | `boolean` | Whether this is the default environment that ships with {% data variables.product.product_name %}. | +| `default_environment` | `boolean` | Whether this is the default environment that ships with {% data variables.product.github %}. | | `download` | `object` | This environment's download status. | | `hooks_count` | `integer` | The number of pre-receive hooks that use this environment. | diff --git a/content/rest/enterprise-admin/scim.md b/content/rest/enterprise-admin/scim.md index 04d79ad9469c..d72d6c26be30 100644 --- a/content/rest/enterprise-admin/scim.md +++ b/content/rest/enterprise-admin/scim.md @@ -41,7 +41,7 @@ To authenticate API requests, the person who configures SCIM on the IdP must use ### Mapping of SAML and SCIM data -After a {% data variables.enterprise.prodname_managed_user %} successfully authenticates to access your enterprise using SAML SSO, {% data variables.product.product_name %} links the user to a SCIM provisioned identity. To link the identities successfully, the SAML identity provider and the SCIM integration must use matching unique identifiers. +After a {% data variables.enterprise.prodname_managed_user %} successfully authenticates to access your enterprise using SAML SSO, {% data variables.product.github %} links the user to a SCIM provisioned identity. To link the identities successfully, the SAML identity provider and the SCIM integration must use matching unique identifiers. {% data variables.product.company_short %} requires the following SAML claim and SCIM attribute to successfully match the user with the identity provisioned by SCIM. Identity providers may differ in the field used to uniquely identify a user. @@ -96,19 +96,19 @@ To use other IdPs for SAML, the following SAML claims and SCIM attribute must ma {% data reusables.user-settings.enterprise-admin-api-classic-pat-only %} -{% data variables.product.product_name %} provides endpoints for use by SCIM-enabled Identity Providers (IdPs). An integration on the IdP can use the REST API to automatically provision, manage, or deprovision user accounts on a {% data variables.product.product_name %} instance that uses SAML single sign-on (SSO) for authentication. See [AUTOTITLE](/admin/managing-iam/provisioning-user-accounts-with-scim/user-provisioning-with-scim-on-ghes). +{% data variables.product.github %} provides endpoints for use by SCIM-enabled Identity Providers (IdPs). An integration on the IdP can use the REST API to automatically provision, manage, or deprovision user accounts on a {% data variables.product.prodname_ghe_server %} instance that uses SAML single sign-on (SSO) for authentication. See [AUTOTITLE](/admin/managing-iam/provisioning-user-accounts-with-scim/user-provisioning-with-scim-on-ghes). These endpoints are based on SCIM 2.0. For more information, refer to your IdP's documentation or see the [specification on the IETF website](https://datatracker.ietf.org/doc/html/rfc7644). ### Root URLs -An IdP can use the following root URL to communicate with the endpoints in this category for a {% data variables.product.product_name %} instance. +An IdP can use the following root URL to communicate with the endpoints in this category for a {% data variables.product.prodname_ghe_server %} instance. ```http {% data variables.product.rest_url %}/scim/v2/ ``` -Do **not** include the `enterprises/{enterprise}/` portion of the URLs provided in the endpoint documentation below. This part of the path is not applicable to {% data variables.product.product_name %}. In the future, this documentation will display the correct URLs for {% data variables.product.product_name %}. +Do **not** include the `enterprises/{enterprise}/` portion of the URLs provided in the endpoint documentation below. This part of the path is not applicable to {% data variables.product.prodname_ghe_server %}. In the future, this documentation will display the correct URLs for {% data variables.product.prodname_ghe_server %}. Endpoints in this category are case-sensitive. For example, the first letter in the `Users` endpoint must be capitalized. @@ -118,7 +118,7 @@ GET /scim/v2/Users/{scim_user_id} ### Authentication -The SCIM integration on the IdP performs actions on behalf of an enterprise owner for the {% data variables.product.product_name %} instance. For more information, see [AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owners). +The SCIM integration on the IdP performs actions on behalf of an enterprise owner for the {% data variables.product.prodname_ghe_server %} instance. For more information, see [AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owners). To authenticate API requests, the person who configures SCIM on the IdP must use a {% data variables.product.pat_v1 %} with the {% ifversion scim-enterprise-scope %}`scim:enterprise`{% else %}`admin:enterprise`{% endif %} scope, which the IdP must provide in the request's `Authorization` header. For more information about {% data variables.product.pat_v1_plural %}, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). @@ -127,12 +127,12 @@ To authenticate API requests, the person who configures SCIM on the IdP must use ### Mapping of SAML and SCIM data -The {% data variables.product.product_name %} instance links each user who authenticates successfully with SAML SSO to a SCIM identity. To link the identities successfully, the SAML IdP and the SCIM integration must use matching SAML `NameID` and SCIM `userName` values for each user. +The {% data variables.product.prodname_ghe_server %} instance links each user who authenticates successfully with SAML SSO to a SCIM identity. To link the identities successfully, the SAML IdP and the SCIM integration must use matching SAML `NameID` and SCIM `userName` values for each user. {% ifversion ghes %} > [!NOTE] -> If the {% data variables.product.product_name %} uses Entra ID as a SAML IdP, {% data variables.product.product_name %} will also check the SCIM `externalId` claim and SAML `http://schemas.microsoft.com/identity/claims/objectidentifier` claim to match users first, instead of using `NameID` and `userName`. +> If the {% data variables.product.prodname_ghe_server %} instance uses Entra ID as a SAML IdP, {% data variables.product.github %} will also check the SCIM `externalId` claim and SAML `http://schemas.microsoft.com/identity/claims/objectidentifier` claim to match users first, instead of using `NameID` and `userName`. {% endif %} @@ -149,7 +149,7 @@ The {% data variables.product.product_name %} instance links each user who authe | `userName` | String | The username for the user, generated by the IdP. Undergoes [normalization](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication#about-username-normalization) before being used. | `emails` | Array | List of the user's emails. | | `roles` | Array | List of the user's roles. | -| `externalId` | String | This identifier is generated by an IdP provider. You can find the `externalId` for a user either on the IdP, or by using the [List SCIM provisioned identities](#list-scim-provisioned-identities-for-an-enterprise) endpoint and filtering on other known attributes, such as a user's username or email address on the {% data variables.product.product_name %} instance. | +| `externalId` | String | This identifier is generated by an IdP provider. You can find the `externalId` for a user either on the IdP, or by using the [List SCIM provisioned identities](#list-scim-provisioned-identities-for-an-enterprise) endpoint and filtering on other known attributes, such as a user's username or email address on the {% data variables.product.prodname_ghe_server %} instance. | | `id` | String | Identifier generated by the instance's SCIM endpoint. | | `active` | Boolean | Indicates whether the identity is active (`true`) or should be suspended (`false`). | diff --git a/content/rest/gists/index.md b/content/rest/gists/index.md index ac797e49b207..ea142d7919b9 100644 --- a/content/rest/gists/index.md +++ b/content/rest/gists/index.md @@ -2,7 +2,7 @@ title: REST API endpoints for gists and gist comments shortTitle: Gists allowTitleToDifferFromFilename: true -intro: 'Use the REST API to list, create, update and delete the public gists on {% data variables.product.product_name %}.' +intro: 'Use the REST API to list, create, update and delete the public gists on {% data variables.product.github %}.' redirect_from: - /v3/gists - /rest/reference/gists diff --git a/content/rest/git/blobs.md b/content/rest/git/blobs.md index 19b758b65d85..7a6d1f9e2b04 100644 --- a/content/rest/git/blobs.md +++ b/content/rest/git/blobs.md @@ -17,6 +17,6 @@ autogenerated: rest ## About Git blobs A Git blob (binary large object) is the object type used to store the contents of each file in a repository. The file's SHA-1 hash is computed and stored in the blob object. These endpoints allow you to read and write [blob objects](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects) -to your Git database on {% data variables.product.product_name %}. Blobs leverage [these custom media types](#custom-media-types-for-blobs). For more information about the use of media types in the API, see [AUTOTITLE](/rest/overview/media-types). +to your Git database on {% data variables.product.github %}. Blobs leverage [these custom media types](#custom-media-types-for-blobs). For more information about the use of media types in the API, see [AUTOTITLE](/rest/overview/media-types). diff --git a/content/rest/git/commits.md b/content/rest/git/commits.md index 3b651a4a53fc..fdf483d4dab0 100644 --- a/content/rest/git/commits.md +++ b/content/rest/git/commits.md @@ -4,7 +4,7 @@ shortTitle: Commits allowTitleToDifferFromFilename: true intro: >- Use the REST API to interact with commit objects in your Git database on {% - data variables.product.product_name %}. + data variables.product.github %}. versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 fpt: '*' ghec: '*' @@ -16,6 +16,6 @@ autogenerated: rest ## About Git commits -A Git commit is a snapshot of the hierarchy ([Git tree](/rest/git/trees)) and the contents of the files ([Git blob](/rest/git/blobs)) in a Git repository. These endpoints allow you to read and write [commit objects](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects#_git_commit_objects) to your Git database on {% data variables.product.product_name %}. +A Git commit is a snapshot of the hierarchy ([Git tree](/rest/git/trees)) and the contents of the files ([Git blob](/rest/git/blobs)) in a Git repository. These endpoints allow you to read and write [commit objects](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects#_git_commit_objects) to your Git database on {% data variables.product.github %}. diff --git a/content/rest/git/index.md b/content/rest/git/index.md index c7862449a706..68c0370f8b5d 100644 --- a/content/rest/git/index.md +++ b/content/rest/git/index.md @@ -1,7 +1,7 @@ --- title: REST API endpoints for Git database shortTitle: Git database -intro: 'Use the REST API to interact with raw Git objects in your Git database on {% data variables.product.product_name %} and to list and update Git references (branch heads and tags).' +intro: 'Use the REST API to interact with raw Git objects in your Git database on {% data variables.product.github %} and to list and update Git references (branch heads and tags).' allowTitleToDifferFromFilename: true redirect_from: - /v3/git @@ -23,6 +23,6 @@ autogenerated: rest ## About Git database -The REST API gives you access to read and write raw Git objects to your Git database on {% data variables.product.product_name %} and to list and update your references (branch heads and tags). For more information about using the REST API to interact with your Git database, see [AUTOTITLE](/rest/guides/using-the-rest-api-to-interact-with-your-git-database). +The REST API gives you access to read and write raw Git objects to your Git database on {% data variables.product.github %} and to list and update your references (branch heads and tags). For more information about using the REST API to interact with your Git database, see [AUTOTITLE](/rest/guides/using-the-rest-api-to-interact-with-your-git-database). diff --git a/content/rest/git/refs.md b/content/rest/git/refs.md index 32887ee8f8cd..0f597f6bf88e 100644 --- a/content/rest/git/refs.md +++ b/content/rest/git/refs.md @@ -3,7 +3,7 @@ title: REST API endpoints for Git references shortTitle: References intro: >- Use the REST API to interact with references in your Git database on {% data - variables.product.product_name %} + variables.product.github %} versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 fpt: '*' ghec: '*' @@ -16,6 +16,6 @@ autogenerated: rest ## About Git references -A Git reference (`git ref`) is a file that contains a Git commit SHA-1 hash. When referring to a Git commit, you can use the Git reference, which is an easy-to-remember name, rather than the hash. The Git reference can be rewritten to point to a new commit. A branch is a Git reference that stores the new Git commit hash. These endpoints allow you to read and write [references](https://git-scm.com/book/en/v2/Git-Internals-Git-References) to your Git database on {% data variables.product.product_name %}. +A Git reference (`git ref`) is a file that contains a Git commit SHA-1 hash. When referring to a Git commit, you can use the Git reference, which is an easy-to-remember name, rather than the hash. The Git reference can be rewritten to point to a new commit. A branch is a Git reference that stores the new Git commit hash. These endpoints allow you to read and write [references](https://git-scm.com/book/en/v2/Git-Internals-Git-References) to your Git database on {% data variables.product.github %}. diff --git a/content/rest/git/tags.md b/content/rest/git/tags.md index 27a161651d1c..b1bd5c992683 100644 --- a/content/rest/git/tags.md +++ b/content/rest/git/tags.md @@ -4,7 +4,7 @@ shortTitle: Tags allowTitleToDifferFromFilename: true intro: >- Use the REST API to interact with tag objects in your Git database on {% data - variables.product.product_name %}. + variables.product.github %}. versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 fpt: '*' ghec: '*' @@ -16,6 +16,6 @@ autogenerated: rest ## About Git tags -A Git tag is similar to a [Git reference](/rest/git/refs), but the Git commit that it points to never changes. Git tags are helpful when you want to point to specific releases. These endpoints allow you to read and write [tag objects](https://git-scm.com/book/en/v2/Git-Internals-Git-References#_tags) to your Git database on {% data variables.product.product_name %}. The API only supports [annotated tag objects](https://git-scm.com/book/en/v2/Git-Internals-Git-References#_tags), not lightweight tags. +A Git tag is similar to a [Git reference](/rest/git/refs), but the Git commit that it points to never changes. Git tags are helpful when you want to point to specific releases. These endpoints allow you to read and write [tag objects](https://git-scm.com/book/en/v2/Git-Internals-Git-References#_tags) to your Git database on {% data variables.product.github %}. The API only supports [annotated tag objects](https://git-scm.com/book/en/v2/Git-Internals-Git-References#_tags), not lightweight tags. diff --git a/content/rest/git/trees.md b/content/rest/git/trees.md index 8e81b557950a..354eb7f1f857 100644 --- a/content/rest/git/trees.md +++ b/content/rest/git/trees.md @@ -4,7 +4,7 @@ shortTitle: Trees allowTitleToDifferFromFilename: true intro: >- Use the REST API to interact with tree objects in your Git database on {% data - variables.product.product_name %}. + variables.product.github %}. versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 fpt: '*' ghec: '*' @@ -16,6 +16,6 @@ autogenerated: rest ## About Git trees -A Git tree object creates the hierarchy between files in a Git repository. You can use the Git tree object to create the relationship between directories and the files they contain. These endpoints allow you to read and write [tree objects](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects#_tree_objects) to your Git database on {% data variables.product.product_name %}. +A Git tree object creates the hierarchy between files in a Git repository. You can use the Git tree object to create the relationship between directories and the files they contain. These endpoints allow you to read and write [tree objects](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects#_tree_objects) to your Git database on {% data variables.product.github %}. diff --git a/content/rest/gitignore/gitignore.md b/content/rest/gitignore/gitignore.md index 48815542ffff..153fcfded005 100644 --- a/content/rest/gitignore/gitignore.md +++ b/content/rest/gitignore/gitignore.md @@ -18,6 +18,6 @@ autogenerated: rest ## About gitignore -When you create a new repository on {% data variables.product.github %} via the API, you can specify a [.gitignore template](/get-started/getting-started-with-git/ignoring-files) to apply to the repository upon creation. You can use the REST API to get .gitignore templates from the {% data variables.product.product_name %} [.gitignore repository](https://github.com/github/gitignore). +When you create a new repository on {% data variables.product.github %} via the API, you can specify a [.gitignore template](/get-started/getting-started-with-git/ignoring-files) to apply to the repository upon creation. You can use the REST API to get .gitignore templates from the {% data variables.product.github %} [.gitignore repository](https://github.com/github/gitignore). diff --git a/content/rest/guides/building-a-ci-server.md b/content/rest/guides/building-a-ci-server.md index d0a698d4da99..cb5460a6456c 100644 --- a/content/rest/guides/building-a-ci-server.md +++ b/content/rest/guides/building-a-ci-server.md @@ -16,7 +16,7 @@ topics: You can use the REST API to tie together commits with a testing service, so that every push you make can be tested and represented -in a {% data variables.product.product_name %} pull request. For more information about the relevant endpoints, see [AUTOTITLE](/rest/commits/statuses). +in a {% data variables.product.github %} pull request. For more information about the relevant endpoints, see [AUTOTITLE](/rest/commits/statuses). This guide will use that API to demonstrate a setup that you can use. In our scenario, we will: @@ -74,7 +74,7 @@ Great! Click on **Let me select individual events**, and select the following: * Status * Pull Request -These are the events {% data variables.product.product_name %} will send to our server whenever the relevant action +These are the events {% data variables.product.github %} will send to our server whenever the relevant action occurs. Let's update our server to _just_ handle the Pull Request scenario right now: ``` ruby @@ -96,7 +96,7 @@ helpers do end ``` -What's going on? Every event that {% data variables.product.product_name %} sends out attached a `X-GitHub-Event` +What's going on? Every event that {% data variables.product.github %} sends out attached a `X-GitHub-Event` HTTP header. We'll only care about the PR events for now. From there, we'll take the payload of information, and return the title field. In an ideal scenario, our server would be concerned with every time a pull request is updated, not just @@ -113,7 +113,7 @@ setting (and updating) CI statuses. Note that at any time you update your server you can click **Redeliver** to send the same payload. There's no need to make a new pull request every time you make a change! -Since we're interacting with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we'll use [Octokit.rb](https://github.com/octokit/octokit.rb) +Since we're interacting with the {% data variables.product.github %} API, we'll use [Octokit.rb](https://github.com/octokit/octokit.rb) to manage our interactions. We'll configure that client with [a {% data variables.product.pat_generic %}](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token): @@ -127,7 +127,7 @@ before do end ``` -After that, we'll just need to update the pull request on {% data variables.product.product_name %} to make clear +After that, we'll just need to update the pull request on {% data variables.product.github %} to make clear that we're processing on the CI: ``` ruby diff --git a/content/rest/guides/delivering-deployments.md b/content/rest/guides/delivering-deployments.md index 57c166787d13..dda22a49ef45 100644 --- a/content/rest/guides/delivering-deployments.md +++ b/content/rest/guides/delivering-deployments.md @@ -15,7 +15,7 @@ topics: -You can use the REST API to deploy your projects hosted on {% data variables.product.product_name %} on a server that you own. For more information about the endpoints to manage deployments and statuses, see [AUTOTITLE](/rest/deployments). You can also use the REST API to coordinate your deployments the moment your code lands on the default branch. For more information, see [AUTOTITLE](/rest/guides/building-a-ci-server). +You can use the REST API to deploy your projects hosted on {% data variables.product.github %} on a server that you own. For more information about the endpoints to manage deployments and statuses, see [AUTOTITLE](/rest/deployments). You can also use the REST API to coordinate your deployments the moment your code lands on the default branch. For more information, see [AUTOTITLE](/rest/guides/building-a-ci-server). This guide will use the REST API to demonstrate a setup that you can use. In our scenario, we will: @@ -76,7 +76,7 @@ Great! Click on **Let me select individual events.**, and select the following: * Deployment status * Pull Request -These are the events {% data variables.product.product_name %} will send to our server whenever the relevant action +These are the events {% data variables.product.github %} will send to our server whenever the relevant action occurs. We'll configure our server to _just_ handle when pull requests are merged right now: @@ -93,7 +93,7 @@ post '/event_handler' do end ``` -What's going on? Every event that {% data variables.product.product_name %} sends out attached a `X-GitHub-Event` +What's going on? Every event that {% data variables.product.github %} sends out attached a `X-GitHub-Event` HTTP header. We'll only care about the PR events for now. When a pull request is merged (its state is `closed`, and `merged` is `true`), we'll kick off a deployment. diff --git a/content/rest/guides/discovering-resources-for-a-user.md b/content/rest/guides/discovering-resources-for-a-user.md index 8c1eb86fa60b..af0e17fc6283 100644 --- a/content/rest/guides/discovering-resources-for-a-user.md +++ b/content/rest/guides/discovering-resources-for-a-user.md @@ -15,9 +15,9 @@ shortTitle: Discover resources for a user -When making authenticated requests to the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, applications often need to fetch the current user's repositories and organizations. In this guide, we'll explain how to reliably discover those resources. +When making authenticated requests to the {% data variables.product.github %} API, applications often need to fetch the current user's repositories and organizations. In this guide, we'll explain how to reliably discover those resources. -To interact with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we'll be using [Octokit.rb](https://github.com/octokit/octokit.rb). You can find the complete source code for this project in the [platform-samples](https://github.com/github/platform-samples/tree/master/api/ruby/discovering-resources-for-a-user) repository. +To interact with the {% data variables.product.github %} API, we'll be using [Octokit.rb](https://github.com/octokit/octokit.rb). You can find the complete source code for this project in the [platform-samples](https://github.com/github/platform-samples/tree/master/api/ruby/discovering-resources-for-a-user) repository. ## Getting started diff --git a/content/rest/guides/index.md b/content/rest/guides/index.md index 9c8c312b7d91..3612fc15bf10 100644 --- a/content/rest/guides/index.md +++ b/content/rest/guides/index.md @@ -23,6 +23,6 @@ children: - /encrypting-secrets-for-the-rest-api --- This section of the documentation is intended to get you up-and-running with -real-world {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API applications. We'll go over everything you need to know, from authentication to results manipulation to integrating results with other apps. +real-world {% data variables.product.github %} API applications. We'll go over everything you need to know, from authentication to results manipulation to integrating results with other apps. Every tutorial will include a project, and each project will be saved and documented in our public [platform-samples](https://github.com/github/platform-samples) repository. diff --git a/content/rest/guides/rendering-data-as-graphs.md b/content/rest/guides/rendering-data-as-graphs.md index 95ec32a3fe50..3ebd3a6e6946 100644 --- a/content/rest/guides/rendering-data-as-graphs.md +++ b/content/rest/guides/rendering-data-as-graphs.md @@ -17,7 +17,7 @@ topics: In this guide, we're going to use the API to fetch information about repositories that we own, and the programming languages that make them up. Then, we'll visualize that information in a couple of different ways using the [D3.js](https://d3js.org/) library. To -interact with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we'll be using the excellent Ruby library, [Octokit](https://github.com/octokit/octokit.rb). +interact with the {% data variables.product.github %} API, we'll be using the excellent Ruby library, [Octokit](https://github.com/octokit/octokit.rb). If you haven't already, you should read the [Basics of Authentication](/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app) guide before starting this example. You can find the complete source code for this project in the [platform-samples](https://github.com/github/platform-samples/tree/master/api/ruby/rendering-data-as-graphs) repository. @@ -26,7 +26,7 @@ Let's jump right in! ## Setting up an {% data variables.product.prodname_oauth_app %} -First, [register a new application](https://github.com/settings/applications/new) on {% data variables.product.product_name %}. Set the main and callback +First, [register a new application](https://github.com/settings/applications/new) on {% data variables.product.github %}. Set the main and callback URLs to `http://localhost:4567/`. As [before](/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app), we're going to handle authentication for the API by implementing a Rack middleware using [sinatra-auth-github](https://github.com/atmos/sinatra_auth_github): @@ -81,7 +81,7 @@ run Example::MyGraphApp ## Fetching repository information -This time, in order to talk to the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, we're going to use the [Octokit +This time, in order to talk to the {% data variables.product.github %} API, we're going to use the [Octokit Ruby library](https://github.com/octokit/octokit.rb). This is much easier than directly making a bunch of REST calls. Plus, Octokit was developed by a GitHubber, and is actively maintained, so you know it'll work. @@ -106,7 +106,7 @@ With Octokit, that looks like this: repos = client.repositories ``` -Next, we'll iterate over each repository, and count the language that {% data variables.product.product_name %} +Next, we'll iterate over each repository, and count the language that {% data variables.product.github %} associates with it: ``` ruby diff --git a/content/rest/guides/using-the-rest-api-to-interact-with-your-git-database.md b/content/rest/guides/using-the-rest-api-to-interact-with-your-git-database.md index ab065fc1e8b4..7e48672c6ac8 100644 --- a/content/rest/guides/using-the-rest-api-to-interact-with-your-git-database.md +++ b/content/rest/guides/using-the-rest-api-to-interact-with-your-git-database.md @@ -1,6 +1,6 @@ --- title: Using the REST API to interact with your Git database -intro: 'Use the REST API to read and write raw Git objects to your Git database on {% data variables.product.product_name %} and to list and update your references (branch heads and tags).' +intro: 'Use the REST API to read and write raw Git objects to your Git database on {% data variables.product.github %} and to list and update your references (branch heads and tags).' versions: fpt: '*' ghes: '*' @@ -17,7 +17,7 @@ redirect_from: This basically allows you to reimplement a lot of Git functionality with the REST API - by creating raw objects directly into the database and updating branch references you could technically do just about anything that Git can do without having Git installed. The REST API will return a `409 Conflict` if the Git repository is empty -or unavailable. An unavailable repository typically means {% data variables.product.product_name %} is in the process of creating the repository. For an empty repository, you can use the [`PUT /repos/{owner}/{repo}/contents/{path}`](/rest/repos/contents#create-or-update-file-contents) REST API endpoint to create content and initialize the repository so you can use the API to manage the Git database. Contact {% data variables.contact.contact_support %} if this response status persists. +or unavailable. An unavailable repository typically means {% data variables.product.github %} is in the process of creating the repository. For an empty repository, you can use the [`PUT /repos/{owner}/{repo}/contents/{path}`](/rest/repos/contents#create-or-update-file-contents) REST API endpoint to create content and initialize the repository so you can use the API to manage the Git database. Contact {% data variables.contact.contact_support %} if this response status persists. For more information on the Git object database, please read the [Git Internals](https://git-scm.com/book/en/v2/Git-Internals-Plumbing-and-Porcelain) chapter of diff --git a/content/rest/guides/working-with-comments.md b/content/rest/guides/working-with-comments.md index 3b90380c061b..0c86129cae4a 100644 --- a/content/rest/guides/working-with-comments.md +++ b/content/rest/guides/working-with-comments.md @@ -14,11 +14,11 @@ topics: -For any Pull Request, {% data variables.product.product_name %} provides three kinds of comment views: +For any Pull Request, {% data variables.product.github %} provides three kinds of comment views: [comments on the Pull Request](https://github.com/octocat/Spoon-Knife/pull/1176#issuecomment-24114792) as a whole, [comments on a specific line](https://github.com/octocat/Spoon-Knife/pull/1176#discussion_r6252889) within the Pull Request, and [comments on a specific commit](https://github.com/octocat/Spoon-Knife/commit/cbc28e7c8caee26febc8c013b0adfb97a4edd96e#commitcomment-4049848) within the Pull Request. -Each of these types of comments goes through a different portion of the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API. +Each of these types of comments goes through a different portion of the {% data variables.product.github %} API. In this guide, we'll explore how you can access and manipulate each one. For every example, we'll be using [this sample Pull Request made](https://github.com/octocat/Spoon-Knife/pull/1176) on the "octocat" repository. As always, samples can be found in [our platform-samples repository](https://github.com/github/platform-samples/tree/master/api/ruby/working-with-comments). diff --git a/content/rest/interactions/orgs.md b/content/rest/interactions/orgs.md index f2983073a1ba..192a79885786 100644 --- a/content/rest/interactions/orgs.md +++ b/content/rest/interactions/orgs.md @@ -15,7 +15,7 @@ autogenerated: rest ## About organization interactions -Organization owners can temporarily restrict which type of user can comment, open issues, or create pull requests in the organization's public repositories. {% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: +Organization owners can temporarily restrict which type of user can comment, open issues, or create pull requests in the organization's public repositories. {% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.github %} users: * {% data reusables.interactions.existing-user-limit-definition %} in the organization. * {% data reusables.interactions.contributor-user-limit-definition %} in the organization. diff --git a/content/rest/interactions/repos.md b/content/rest/interactions/repos.md index 6a1d7a3fc6d2..cb31e29636c3 100644 --- a/content/rest/interactions/repos.md +++ b/content/rest/interactions/repos.md @@ -18,7 +18,7 @@ autogenerated: rest ## About repository interactions -People with owner or admin access can use the REST API to temporarily restrict which type of user can comment, open issues, or create pull requests in a public repository. {% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: +People with owner or admin access can use the REST API to temporarily restrict which type of user can comment, open issues, or create pull requests in a public repository. {% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.github %} users: * {% data reusables.interactions.existing-user-limit-definition %} in the repository. * {% data reusables.interactions.contributor-user-limit-definition %} in the repository. diff --git a/content/rest/interactions/user.md b/content/rest/interactions/user.md index fb2ff54290ac..867e26411015 100644 --- a/content/rest/interactions/user.md +++ b/content/rest/interactions/user.md @@ -15,7 +15,7 @@ autogenerated: rest ## About user interactions -You can use the REST API to temporarily restrict which type of user can comment, open issues, or create pull requests on your public repositories. {% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.product_name %} users: +You can use the REST API to temporarily restrict which type of user can comment, open issues, or create pull requests on your public repositories. {% data reusables.interactions.interactions-detail %} Here's more about the types of {% data variables.product.github %} users: * {% data reusables.interactions.existing-user-limit-definition %} from interacting with your repositories. * {% data reusables.interactions.contributor-user-limit-definition %} from interacting with your repositories. diff --git a/content/rest/metrics/statistics.md b/content/rest/metrics/statistics.md index c614a08608bb..88fdbb0b48ed 100644 --- a/content/rest/metrics/statistics.md +++ b/content/rest/metrics/statistics.md @@ -3,7 +3,7 @@ title: REST API endpoints for repository statistics shortTitle: Statistics allowTitleToDifferFromFilename: true intro: >- - Use the REST API to fetch the data that {% data variables.product.product_name + Use the REST API to fetch the data that {% data variables.product.github %} uses for visualizing different types of repository activity. versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 fpt: '*' @@ -16,7 +16,7 @@ autogenerated: rest ## About repository statistics -You can use the REST API to fetch the data that {% data variables.product.product_name %} uses for visualizing different types of repository activity. +You can use the REST API to fetch the data that {% data variables.product.github %} uses for visualizing different types of repository activity. ### Best practices for caching diff --git a/content/rest/repos/index.md b/content/rest/repos/index.md index 1eb4f0c8ca6e..6b237623025b 100644 --- a/content/rest/repos/index.md +++ b/content/rest/repos/index.md @@ -3,7 +3,7 @@ title: REST API endpoints for repositories shortTitle: Repositories intro: >- Use the REST API to create, manage and control the workflow of public and - private {% data variables.product.product_name %} repositories. + private {% data variables.product.github %} repositories. allowTitleToDifferFromFilename: true redirect_from: - /v3/repos diff --git a/content/rest/scim/scim.md b/content/rest/scim/scim.md index beb5a67c7318..fa456c57df77 100644 --- a/content/rest/scim/scim.md +++ b/content/rest/scim/scim.md @@ -20,7 +20,7 @@ autogenerated: rest ### SCIM Provisioning for Organizations -These endpoints are used by SCIM-enabled Identity Providers (IdPs) to automate provisioning of {% data variables.product.product_name %} organization membership and are based on version 2.0 of the [SCIM standard](http://www.simplecloud.info/). IdPs should use the base URL `{% data variables.product.rest_url %}/scim/v2/organizations/{org}/` for {% data variables.product.product_name %} SCIM endpoints. +These endpoints are used by SCIM-enabled Identity Providers (IdPs) to automate provisioning of {% data variables.product.github %} organization membership and are based on version 2.0 of the [SCIM standard](http://www.simplecloud.info/). IdPs should use the base URL `{% data variables.product.rest_url %}/scim/v2/organizations/{org}/` for {% data variables.product.github %} SCIM endpoints. > [!NOTE] > * These endpoints are only available for individual organizations that use {% data variables.product.prodname_ghe_cloud %} with SAML SSO enabled. For more information about SCIM, see [AUTOTITLE](/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations). For more information about authorizing a token for a SAML SSO organization, see [AUTOTITLE](/rest/overview/authenticating-to-the-rest-api). @@ -28,7 +28,7 @@ These endpoints are used by SCIM-enabled Identity Providers (IdPs) to automate p ### Authentication -You must authenticate as an owner of a {% data variables.product.product_name %} organization to use these endpoints. The REST API expects an OAuth 2.0 Bearer token (for example, a {% data variables.product.prodname_github_app %} user access token) to be included in the `Authorization` header. If you use a {% data variables.product.pat_v1 %} for authentication, it must have the `admin:org` scope and you must also [authorize it for use with your SAML SSO organization](/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on). +You must authenticate as an owner of a {% data variables.product.github %} organization to use these endpoints. The REST API expects an OAuth 2.0 Bearer token (for example, a {% data variables.product.prodname_github_app %} user access token) to be included in the `Authorization` header. If you use a {% data variables.product.pat_v1 %} for authentication, it must have the `admin:org` scope and you must also [authorize it for use with your SAML SSO organization](/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on). ### Mapping of SAML and SCIM data diff --git a/content/rest/search/search.md b/content/rest/search/search.md index 324c8290c4bd..4f778062696e 100644 --- a/content/rest/search/search.md +++ b/content/rest/search/search.md @@ -4,7 +4,7 @@ shortTitle: Search allowTitleToDifferFromFilename: true intro: >- Use the REST API to search for specific items on {% data - variables.product.product_name %}. + variables.product.github %}. versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 fpt: '*' ghec: '*' @@ -18,7 +18,7 @@ autogenerated: rest ## About search -You can use the REST API to search for the specific item you want to find. For example, you can find a user or a specific file in a repository. Think of it the way you think of performing a search on Google. It's designed to help you find the one result you're looking for (or maybe the few results you're looking for). Just like searching on Google, you sometimes want to see a few pages of search results so that you can find the item that best meets your needs. To satisfy that need, the {% data variables.product.product_name %} REST API provides **up to 1,000 results for each search**. +You can use the REST API to search for the specific item you want to find. For example, you can find a user or a specific file in a repository. Think of it the way you think of performing a search on Google. It's designed to help you find the one result you're looking for (or maybe the few results you're looking for). Just like searching on Google, you sometimes want to see a few pages of search results so that you can find the item that best meets your needs. To satisfy that need, the {% data variables.product.github %} REST API provides **up to 1,000 results for each search**. You can narrow your search using queries. To learn more about the search query syntax, see [AUTOTITLE](/rest/search/search#constructing-a-search-query). @@ -37,9 +37,9 @@ For information about how to determine your current rate limit status, see [Rate ### Constructing a search query -Each endpoint for searching uses [query parameters](https://en.wikipedia.org/wiki/Query_string) to perform searches on {% data variables.product.product_name %}. See the individual endpoints for examples that include the endpoint and query parameters. +Each endpoint for searching uses [query parameters](https://en.wikipedia.org/wiki/Query_string) to perform searches on {% data variables.product.github %}. See the individual endpoints for examples that include the endpoint and query parameters. -A query can contain any combination of search qualifiers supported on {% data variables.product.product_name %}. The format of the search query is: +A query can contain any combination of search qualifiers supported on {% data variables.product.github %}. The format of the search query is: ```text SEARCH_KEYWORD_1 SEARCH_KEYWORD_N QUALIFIER_1 QUALIFIER_N diff --git a/content/rest/teams/index.md b/content/rest/teams/index.md index ec2c2686d491..107846967f91 100644 --- a/content/rest/teams/index.md +++ b/content/rest/teams/index.md @@ -2,7 +2,7 @@ title: REST API endpoints for teams shortTitle: Teams allowTitleToDifferFromFilename: true -intro: 'Use the REST API to create and manage teams in your {% data variables.product.product_name %} organization.' +intro: 'Use the REST API to create and manage teams in your {% data variables.product.github %} organization.' redirect_from: - /v3/teams - /rest/reference/teams diff --git a/content/rest/teams/team-sync.md b/content/rest/teams/team-sync.md index 6bdae627c08a..ea24cce32d6c 100644 --- a/content/rest/teams/team-sync.md +++ b/content/rest/teams/team-sync.md @@ -3,7 +3,7 @@ title: REST API endpoints for team synchronization shortTitle: Team synchronization intro: >- Use the REST API to manage connections between {% data - variables.product.product_name %} teams and external identity provider (IdP) + variables.product.github %} teams and external identity provider (IdP) groups. versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 ghec: '*' @@ -17,7 +17,7 @@ autogenerated: rest To use these endpoints, the authenticated user must be a team maintainer or an owner of the organization associated with the team. The token you use to authenticate will also need to be authorized for use with your IdP (SSO) provider. For more information, see [AUTOTITLE](/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on). -You can manage {% data variables.product.product_name %} team members through your IdP with team synchronization. Team synchronization must be enabled to use these endpoints. For more information, see [AUTOTITLE](/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization). +You can manage {% data variables.product.github %} team members through your IdP with team synchronization. Team synchronization must be enabled to use these endpoints. For more information, see [AUTOTITLE](/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization). > [!NOTE] > These endpoints cannot be used with {% data variables.product.prodname_emus %}. To learn more about managing an {% data variables.enterprise.prodname_emu_org %}, see [AUTOTITLE](/enterprise-cloud@latest/rest/teams/external-groups). diff --git a/content/rest/using-the-rest-api/best-practices-for-using-the-rest-api.md b/content/rest/using-the-rest-api/best-practices-for-using-the-rest-api.md index 6615d8d4190a..d44ba7060c7a 100644 --- a/content/rest/using-the-rest-api/best-practices-for-using-the-rest-api.md +++ b/content/rest/using-the-rest-api/best-practices-for-using-the-rest-api.md @@ -52,7 +52,7 @@ Continuing to make requests while you are rate limited may result in the banning ## Follow redirects -The {% data variables.product.product_name %} REST API uses HTTP redirection where appropriate. You should assume that any +The {% data variables.product.github %} REST API uses HTTP redirection where appropriate. You should assume that any request may result in a redirection. Receiving an HTTP redirection is not an error, and you should follow the redirect. A `301` status code indicates permanent redirection. You should repeat your request to the URL specified by the `location` header. Additionally, you should update your code to use this URL for future requests. diff --git a/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md b/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md index 9feeaecf64b4..cf629c0458f4 100644 --- a/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md +++ b/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md @@ -1,7 +1,7 @@ --- title: Getting started with the REST API shortTitle: Getting started -intro: 'Learn how to use the {% data variables.product.prodname_dotcom %} REST API.' +intro: 'Learn how to use the {% data variables.product.github %} REST API.' versions: fpt: '*' ghes: '*' @@ -20,7 +20,7 @@ redirect_from: ## Introduction -This article describes how to use the {% data variables.product.prodname_dotcom %} REST API with {% data variables.product.prodname_cli %}, `curl`, or JavaScript. For a quickstart guide, see [AUTOTITLE](/rest/quickstart). +This article describes how to use the {% data variables.product.github %} REST API with {% data variables.product.prodname_cli %}, `curl`, or JavaScript. For a quickstart guide, see [AUTOTITLE](/rest/quickstart). {% curl %} @@ -53,7 +53,7 @@ The HTTP method of an endpoint defines the type of action it performs on a given For example, the HTTP method for the ["List repository issues" endpoint](/rest/issues/issues#list-repository-issues) is `GET`." -Where possible, the {% data variables.product.product_name %} REST API strives to use an appropriate HTTP method for each action. +Where possible, the {% data variables.product.github %} REST API strives to use an appropriate HTTP method for each action. * `GET`: Used for retrieving resources. * `POST`: Used for creating resources. @@ -87,19 +87,19 @@ All API requests must include a valid `User-Agent` header. The `User-Agent` head {% cli %} -By default, {% data variables.product.prodname_cli %} sends a valid `User-Agent` header. However, {% data variables.product.prodname_dotcom %} recommends using your {% data variables.product.product_name %} username, or the name of your application, for the `User-Agent` header value. This allows {% data variables.product.prodname_dotcom %} to contact you if there are problems. +By default, {% data variables.product.prodname_cli %} sends a valid `User-Agent` header. However, {% data variables.product.prodname_dotcom %} recommends using your {% data variables.product.github %} username, or the name of your application, for the `User-Agent` header value. This allows {% data variables.product.prodname_dotcom %} to contact you if there are problems. {% endcli %} {% curl %} -By default, `curl` sends a valid `User-Agent` header. However {% data variables.product.prodname_dotcom %} recommends using your {% data variables.product.product_name %} username, or the name of your application, for the `User-Agent` header value. This allows {% data variables.product.prodname_dotcom %} to contact you if there are problems. +By default, `curl` sends a valid `User-Agent` header. However {% data variables.product.prodname_dotcom %} recommends using your {% data variables.product.github %} username, or the name of your application, for the `User-Agent` header value. This allows {% data variables.product.prodname_dotcom %} to contact you if there are problems. {% endcurl %} {% javascript %} -If you use the Octokit.js SDK, the SDK will send a valid `User-Agent` header for you. However, {% data variables.product.prodname_dotcom %} recommends using your {% data variables.product.product_name %} username, or the name of your application, for the `User-Agent` header value. This allows {% data variables.product.prodname_dotcom %} to contact you if there are problems. +If you use the Octokit.js SDK, the SDK will send a valid `User-Agent` header for you. However, {% data variables.product.prodname_dotcom %} recommends using your {% data variables.product.github %} username, or the name of your application, for the `User-Agent` header value. This allows {% data variables.product.prodname_dotcom %} to contact you if there are problems. {% endjavascript %} @@ -126,7 +126,7 @@ The most common media types supported by the {% data variables.product.prodname_ There are custom media types that you can use with some endpoints. For example, the REST API to manage [commits](/rest/commits/commits#get-a-commit) and [pull requests](/rest/pulls/pulls) support the media types `diff`, `patch`, and `sha`. The media types `full`, `raw`, `text`, or `html` are used by some other endpoints. -All custom media types for {% data variables.product.product_name %} look like this: `application/vnd.github.PARAM+json`, where `PARAM` is the name of the media type. For example, to specify the `raw` media type, you would use `application/vnd.github.raw+json`. +All custom media types for {% data variables.product.github %} look like this: `application/vnd.github.PARAM+json`, where `PARAM` is the name of the media type. For example, to specify the `raw` media type, you would use `application/vnd.github.raw+json`. For an example of a request that uses media types, see [Making a request](#making-a-request). @@ -150,7 +150,7 @@ For an example of a request that uses an authentication token, see [Making a req {% cli %} -Although some REST API endpoints are accessible without authentication, {% data variables.product.prodname_cli %} requires you to authenticate before you can use the `api` subcommand to make an API request. Use the `auth login` subcommand to authenticate to {% data variables.product.product_name %}. For more information, see [Making a request](#making-a-request). +Although some REST API endpoints are accessible without authentication, {% data variables.product.prodname_cli %} requires you to authenticate before you can use the `api` subcommand to make an API request. Use the `auth login` subcommand to authenticate to {% data variables.product.github %}. For more information, see [Making a request](#making-a-request). {% endcli %} @@ -218,7 +218,7 @@ Install {% data variables.product.prodname_cli %} on macOS, Windows, or Linux. F ### 3. Choose an endpoint for your request -1. Choose an endpoint to make a request to. You can explore {% data variables.product.product_name %}'s [REST API documentation](/rest) to discover endpoints that you can use to interact with {% data variables.product.product_name %}. +1. Choose an endpoint to make a request to. You can explore {% data variables.product.github %}'s [REST API documentation](/rest) to discover endpoints that you can use to interact with {% data variables.product.github %}. 1. Identify the HTTP method and path of the endpoint. You will send these with your request. For more information, see [HTTP method](#http-method) and [Path](#path). For example, the ["Create an issue" endpoint](/rest/issues/issues#create-an-issue) uses the HTTP method `POST` and the path `/repos/{owner}/{repo}/issues`. @@ -295,7 +295,7 @@ You must have `curl` installed on your machine. To check if `curl` is already in ### 2. Choose an endpoint for your request -1. Choose an endpoint to make a request to. You can explore {% data variables.product.product_name %}'s [REST API documentation](/rest) to discover endpoints that you can use to interact with {% data variables.product.product_name %}. +1. Choose an endpoint to make a request to. You can explore {% data variables.product.github %}'s [REST API documentation](/rest) to discover endpoints that you can use to interact with {% data variables.product.github %}. 1. Identify the HTTP method and path of the endpoint. You will send these with your request. For more information, see [HTTP method](#http-method) and [Path](#path). For example, the ["Create an issue" endpoint](/rest/issues/issues#create-an-issue) uses the HTTP method `POST` and the path `/repos/{owner}/{repo}/issues`. @@ -381,7 +381,7 @@ You must install `octokit` to use the Octokit.js library shown in the following ### 2. Choose an endpoint for your request -1. Choose an endpoint to make a request to. You can explore {% data variables.product.product_name %}'s [REST API documentation](/rest) to discover endpoints that you can use to interact with {% data variables.product.product_name %}. +1. Choose an endpoint to make a request to. You can explore {% data variables.product.github %}'s [REST API documentation](/rest) to discover endpoints that you can use to interact with {% data variables.product.github %}. 1. Identify the HTTP method and path of the endpoint. You will send these with your request. For more information, see [HTTP method](#http-method) and [Path](#path). For example, the ["Create an issue" endpoint](/rest/issues/issues#create-an-issue) uses the HTTP method `POST` and the path `/repos/{owner}/{repo}/issues`. diff --git a/content/rest/using-the-rest-api/rate-limits-for-the-rest-api.md b/content/rest/using-the-rest-api/rate-limits-for-the-rest-api.md index 5927acbc1c01..4c3184707d36 100644 --- a/content/rest/using-the-rest-api/rate-limits-for-the-rest-api.md +++ b/content/rest/using-the-rest-api/rate-limits-for-the-rest-api.md @@ -14,7 +14,7 @@ redirect_from: {% ifversion ghes %} -Rate limits are disabled by default for {% data variables.product.product_name %}. Contact your site administrator to confirm the rate limits for your instance. +Rate limits are disabled by default for {% data variables.product.prodname_ghe_server %}. Contact your site administrator to confirm the rate limits for your instance. If you are a site administrator, you can set rate limits, including secondary rate limits, for your instance. See [AUTOTITLE](/admin/configuration/configuring-user-applications-for-your-enterprise/configuring-rate-limits). diff --git a/content/rest/using-the-rest-api/timezones-and-the-rest-api.md b/content/rest/using-the-rest-api/timezones-and-the-rest-api.md index 5092e39f629e..1c84f2625a7e 100644 --- a/content/rest/using-the-rest-api/timezones-and-the-rest-api.md +++ b/content/rest/using-the-rest-api/timezones-and-the-rest-api.md @@ -43,7 +43,7 @@ For example, the API to manage contents generates a git commit for each addition ### Using the last known timezone for the user -If no `Time-Zone` header is specified and you make an authenticated call to the API, we use the last known timezone for the authenticated user. The last known timezone is updated whenever you browse the {% data variables.product.product_name %} website. +If no `Time-Zone` header is specified and you make an authenticated call to the API, we use the last known timezone for the authenticated user. The last known timezone is updated whenever you browse the {% data variables.product.github %} website. ### Defaulting to UTC without other timezone information diff --git a/content/rest/using-the-rest-api/troubleshooting-the-rest-api.md b/content/rest/using-the-rest-api/troubleshooting-the-rest-api.md index 5550700227c9..9022798a652c 100644 --- a/content/rest/using-the-rest-api/troubleshooting-the-rest-api.md +++ b/content/rest/using-the-rest-api/troubleshooting-the-rest-api.md @@ -89,9 +89,9 @@ Basic authentication with your username and password is not supported. Instead, ## Timeouts -If {% data variables.product.product_name %} takes more than 10 seconds to process an API request, {% data variables.product.product_name %} will terminate the request and you will receive a timeout response and a "Server Error" message. +If {% data variables.product.github %} takes more than 10 seconds to process an API request, {% data variables.product.github %} will terminate the request and you will receive a timeout response and a "Server Error" message. -{% data variables.product.product_name %} reserves the right to change the timeout window to protect the speed and reliability of the API. +{% data variables.product.github %} reserves the right to change the timeout window to protect the speed and reliability of the API. You can check the status of the REST API at [githubstatus.com](https://www.githubstatus.com/) to determine whether the timeout is due to a problem with the API. You can also try to simplify your request or try your request later. For example, if you are requesting 100 items on a page, you can try requesting fewer items. diff --git a/content/rest/using-the-rest-api/using-cors-and-jsonp-to-make-cross-origin-requests.md b/content/rest/using-the-rest-api/using-cors-and-jsonp-to-make-cross-origin-requests.md index 74afd6c22c55..c130e40d3361 100644 --- a/content/rest/using-the-rest-api/using-cors-and-jsonp-to-make-cross-origin-requests.md +++ b/content/rest/using-the-rest-api/using-cors-and-jsonp-to-make-cross-origin-requests.md @@ -43,7 +43,7 @@ Access-Control-Max-Age: 86400 ## JSON-P callbacks You can send a `?callback` parameter to any GET call to have the results -wrapped in a JSON function. This is typically used when browsers want to embed {% data variables.product.product_name %} content in web pages and avoid cross-domain problems. The response includes the same data output as the regular API, plus the relevant HTTP Header information. +wrapped in a JSON function. This is typically used when browsers want to embed {% data variables.product.github %} content in web pages and avoid cross-domain problems. The response includes the same data output as the regular API, plus the relevant HTTP Header information. ```shell $ curl {% data variables.product.rest_url %}?callback=foo diff --git a/data/reusables/dependabot/automatically-pause-dependabot-updates.md b/data/reusables/dependabot/automatically-pause-dependabot-updates.md deleted file mode 100644 index fcaf65da0533..000000000000 --- a/data/reusables/dependabot/automatically-pause-dependabot-updates.md +++ /dev/null @@ -1,24 +0,0 @@ -When maintainers of a repository stop interacting with {% data variables.product.prodname_dependabot %} pull requests, {% data variables.product.prodname_dependabot %} temporarily pauses its updates and lets you know. This automatic opt-out behavior means that {% data variables.product.prodname_dependabot %} no longer creates pull requests for version and security updates, and no longer rebases {% data variables.product.prodname_dependabot %} pull requests for inactive repositories. - -The automatic deactivation of {% data variables.product.prodname_dependabot %} updates only applies to repositories where {% data variables.product.prodname_dependabot %} has opened pull requests but the pull requests remain untouched. If {% data variables.product.prodname_dependabot %} hasn't opened any pull requests, {% data variables.product.prodname_dependabot %} will never become paused. - -An active repository is a repository for which a user (not {% data variables.product.prodname_dependabot %}) has carried out _any_ of the actions below in the last 90 days: - -* Merge or close a {% data variables.product.prodname_dependabot %} pull request on the repository. -* Make a change to the `dependabot.yml` file for the repository. -* Manually trigger a security update or a version update. -* Enable {% data variables.product.prodname_dependabot_security_updates %} for the repository. -* Use `@dependabot` commands on pull requests. - -An inactive repository is a repository that has at least one {% data variables.product.prodname_dependabot %} pull request open for more than 90 days, has been enabled for the full period, and where none of the actions listed above has been taken by a user. - -When {% data variables.product.prodname_dependabot %} is paused, {% data variables.product.prodname_dotcom %} adds a banner notice: -* To all open {% data variables.product.prodname_dependabot %} pull requests. -* To the UI of the **Settings** tab of the repository (under **{% ifversion code-security-wording-only %}**Code security**{% else %}**Code security and analysis**{% endif %}**, then **{% data variables.product.prodname_dependabot %}**). -* To the list of {% data variables.product.prodname_dependabot_alerts %} (if {% data variables.product.prodname_dependabot_security_updates %} are affected). - -{% ifversion dependabot-updates-paused-enterprise-orgs %} Additionally, you will be able to see whether {% data variables.product.prodname_dependabot %} is paused at the organization-level in the security overview. The `paused` status will also be visible via the API. For more information, see [AUTOTITLE](/rest/repos#enable-automated-security-fixes).{% endif %} - -As soon as a maintainer interacts with a {% data variables.product.prodname_dependabot %} pull request again, {% data variables.product.prodname_dependabot %} will unpause itself: -* Security updates are automatically resumed for {% data variables.product.prodname_dependabot_alerts %}. -* Version updates are automatically resumed with the schedule specified in the `dependabot.yml` file. diff --git a/data/reusables/dependabot/configuration-options.md b/data/reusables/dependabot/configuration-options.md deleted file mode 100644 index 45f4d56cfde2..000000000000 --- a/data/reusables/dependabot/configuration-options.md +++ /dev/null @@ -1,30 +0,0 @@ -| Option | Required | Security Updates | Version Updates | Description | -|:---|:---:|:---:|:---:|:---| -| [`package-ecosystem`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#package-ecosystem) | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | Package manager to use | -| [`directory`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#directory) | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | Location of package manifests | -| {% ifversion dependabot-updates-multidirectory-support %} | -| [`directories`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#directories) | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | Locations of package manifests (multiple directories) | -| {% endif %} | -| [`schedule.interval`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#scheduleinterval) | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | How often to check for updates | -| [`allow`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#allow) | {% octicon "x" aria-label="Not supported" %}| {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | Customize which updates are allowed | -| [`assignees`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#assignees) | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | Assignees to set on pull requests | -| [`commit-message`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#commit-message) | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | Commit message preferences | -| [`enable-beta-ecosystems`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#enable-beta-ecosystems) | {% octicon "x" aria-label="Not supported" %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | Enable ecosystems that have {% data variables.release-phases.public_preview %}-level support | -| {% ifversion dependabot-version-updates-groups %} | -| [`groups`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#groups) | {% octicon "x" aria-label="Not supported" %} | {% ifversion dependabot-grouped-security-updates-config %}{% octicon "check" aria-label="Supported" %}{% else %}{% octicon "x" aria-label="Not supported" %}{% endif %} | {% octicon "check" aria-label="Supported" %} | Group updates for certain dependencies | -| {% endif %} | -| [`ignore`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#ignore) | {% octicon "x" aria-label="Not supported" %} | See [`ignore`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#ignore) | See [`ignore`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#ignore) | Ignore certain dependencies or versions | -| [`insecure-external-code-execution`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#insecure-external-code-execution) | {% octicon "x" aria-label="Not supported" %}| {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | Allow or deny code execution in manifest files | -| [`labels`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#labels) | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | Labels to set on pull requests | -| [`milestone`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#milestone) | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | Milestone to set on pull requests | -| [`open-pull-requests-limit`](#open-pull-requests-limit) | {% octicon "x" aria-label="Not supported" %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | Limit number of open pull requests for version updates | -| [`pull-request-branch-name.separator`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#pull-request-branch-nameseparator) | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | Change separator for pull request branch names | -| [`rebase-strategy`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#rebase-strategy) | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | Disable automatic rebasing | -| [`registries`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#registries) | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | Private registries that {% data variables.product.prodname_dependabot %} can access| -| [`reviewers`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#reviewers) | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | Reviewers to set on pull requests | -| [`schedule.day`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#scheduleday) | {% octicon "x" aria-label="Not supported" %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | Day of week to check for updates | -| [`schedule.time`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#scheduletime) | {% octicon "x" aria-label="Not supported" %}| {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | Time of day to check for updates (hh:mm) | -| [`schedule.timezone`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#scheduletimezone) | {% octicon "x" aria-label="Not supported" %}| {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | Timezone for time of day (zone identifier) | -| [`target-branch`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#target-branch) | {% octicon "x" aria-label="Not supported" %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | Branch to create pull requests against | -| [`vendor`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#vendor) | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | Update vendored or cached dependencies | -| [`versioning-strategy`](/code-security/dependabot/working-with-dependabot/dependabot-options-reference#versioning-strategy) | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | How to update manifest version requirements | diff --git a/data/reusables/dependabot/default-dependencies-allow-ignore.md b/data/reusables/dependabot/default-dependencies-allow-ignore.md deleted file mode 100644 index 46368bacd430..000000000000 --- a/data/reusables/dependabot/default-dependencies-allow-ignore.md +++ /dev/null @@ -1 +0,0 @@ -By default all dependencies that are explicitly defined in a manifest are kept up to date by {% data variables.product.prodname_dependabot %} version updates. In addition, {% data variables.product.prodname_dependabot %} security updates also update vulnerable dependencies that are defined in lock files. You can use `allow` and `ignore` to customize which dependencies to maintain. {% data variables.product.prodname_dependabot %} checks for all allowed dependencies and then filters out any ignored dependencies or versions. So a dependency that is matched by both an `allow` and an `ignore` will be ignored. diff --git a/data/reusables/dependabot/dependabot-security-updates-groups-supported.md b/data/reusables/dependabot/dependabot-security-updates-groups-supported.md deleted file mode 100644 index 7c28b22f73a8..000000000000 --- a/data/reusables/dependabot/dependabot-security-updates-groups-supported.md +++ /dev/null @@ -1,5 +0,0 @@ -{% ifversion dependabot-grouped-security-updates-config %}You can use the `dependabot.yml` file to create separate rules to group {% data variables.product.prodname_dependabot_version_updates %} and {% data variables.product.prodname_dependabot_security_updates %}.{% else %} -You can only use the `dependabot.yml` file to create groups for {% data variables.product.prodname_dependabot_version_updates %}. Grouped {% data variables.product.prodname_dependabot_security_updates %} are enabled or disabled in your repository or organization settings and do not support customization. For more information, see [AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates#about-grouped-security-updates).{% endif %} - -> [!NOTE] -> If a grouped pull request for {% data variables.product.prodname_dependabot_version_updates %} contains a vulnerable package, {% data variables.product.prodname_dependabot_security_updates %} will still attempt to create a _separate_ pull request to update the vulnerable package to a secure version. Creating a separate pull request for security updates ensures you have visibility into package vulnerabilities. diff --git a/data/reusables/dependabot/dependabot-version-updates-groups-about.md b/data/reusables/dependabot/dependabot-version-updates-groups-about.md deleted file mode 100644 index d7ab1497cbb2..000000000000 --- a/data/reusables/dependabot/dependabot-version-updates-groups-about.md +++ /dev/null @@ -1 +0,0 @@ -By default, {% data variables.product.prodname_dependabot %} raises a single pull request for each dependency that needs to be updated to a newer version. You can use `groups` to create sets of dependencies (per package manager), so that {% data variables.product.prodname_dependabot %} opens a single pull request to update multiple dependencies at the same time. diff --git a/data/reusables/dependabot/dependabot-version-updates-groups-semver.md b/data/reusables/dependabot/dependabot-version-updates-groups-semver.md deleted file mode 100644 index 53755a248b0c..000000000000 --- a/data/reusables/dependabot/dependabot-version-updates-groups-semver.md +++ /dev/null @@ -1,4 +0,0 @@ -You can also specify grouping settings based on how updates affect a specific ecosystem and follow semantic versioning (SemVer). This means you can, for example, group all patch updates together. This approach helps {% data variables.product.prodname_dependabot %} create as few pull requests as possible, while also reducing the chances of accidentally accepting changes that could cause issues. If a package follows SemVer, there's a higher chance (but not a guarantee) that minor and patch updates will be backwards compatible. - -> [!NOTE] -> SemVer is an accepted standard for defining versions of software packages, in the form `x.y.z`. {% data variables.product.prodname_dependabot %} assumes that versions in this form are always `major.minor.patch`. diff --git a/data/reusables/dependabot/dependabot-version-updates-supported-options-for-groups.md b/data/reusables/dependabot/dependabot-version-updates-supported-options-for-groups.md deleted file mode 100644 index 593cabff7a46..000000000000 --- a/data/reusables/dependabot/dependabot-version-updates-supported-options-for-groups.md +++ /dev/null @@ -1,9 +0,0 @@ -When you first configure a group, you specify a group name that will display in pull request titles and branch names{% ifversion dependabot-grouped-security-updates-config %}, and whether the group rule applies to version updates or security updates{% endif %}. You can then define other options to include or exclude specific dependencies from the group. You must use the `patterns`, `exclude-patterns`, `dependency-type`, or `update-types` options to define the group, or any combination thereof. - -Option | Description | --------|-------------| -| `applies-to` | Use to specify whether the rules in the group apply to version updates or security updates. `applies-to` can be `version-updates` or `security-updates`. | -| `dependency-type` | Use to specify a dependency type to be included in the group. `dependency-type` can be `development` or `production`. | -| `patterns` | Use to define strings of characters that match with a dependency name (or multiple dependency names) to include those dependencies in the group. | -| `exclude-patterns` | Use to exclude certain dependencies from the group. If a dependency is excluded from a group, {% data variables.product.prodname_dependabot %} will continue to raise single pull requests to update the dependency to its latest version. | -| `update-types` | Use to specify the semantic versioning level to include in the group. Possible values are `minor`, `patch`, and `major`. | diff --git a/data/reusables/dependabot/directories-option-overview.md b/data/reusables/dependabot/directories-option-overview.md deleted file mode 100644 index a8373f8e0660..000000000000 --- a/data/reusables/dependabot/directories-option-overview.md +++ /dev/null @@ -1 +0,0 @@ -You can use `directories` instead of `directory` to apply the same configuration to a list of multiple directories. The `directory` or `directories` entries must be unique and cannot overlap with the `directory` or `directories` entries in blocks that have the same ecosystem and `target-branch`. You can have one block specifying multiple directories and another block with specifications for one directory only, but both keys can't be present in the same block. diff --git a/data/reusables/dependabot/directory-directories-required.md b/data/reusables/dependabot/directory-directories-required.md deleted file mode 100644 index f7c518321dd9..000000000000 --- a/data/reusables/dependabot/directory-directories-required.md +++ /dev/null @@ -1,2 +0,0 @@ -> [!NOTE] -> You cannot use both `directory` and `directories` in the same configuration block. Only one option is required, not both. diff --git a/data/reusables/dependabot/directory-vs-directories-guidance.md b/data/reusables/dependabot/directory-vs-directories-guidance.md deleted file mode 100644 index a4960b2abef4..000000000000 --- a/data/reusables/dependabot/directory-vs-directories-guidance.md +++ /dev/null @@ -1 +0,0 @@ -Using `directory`, `directories`, or a mixture of both, are all valid approaches. You should tailor your configuration to your requirements. We recommend you use `directories` when you want to apply the exact same configuration to multiple directories or group dependency updates across multiple directories, and `directory` when you want to apply a configuration to only one directory, or if you want each directory to have a different configuration. diff --git a/data/reusables/dependabot/multidirectory-vs-pr-grouping.md b/data/reusables/dependabot/multidirectory-vs-pr-grouping.md deleted file mode 100644 index 5d4b30736769..000000000000 --- a/data/reusables/dependabot/multidirectory-vs-pr-grouping.md +++ /dev/null @@ -1,5 +0,0 @@ -Multidirectory support is different than update grouping in pull requests. -* The `directories` option in the `dependabot.yml` file allows you to apply {% data variables.product.prodname_dependabot_updates %} to multiple directories at the same time. -* The `groups` option in the `dependabot.yml` file creates sets of dependencies (per package manager) for {% data variables.product.prodname_dependabot %} to put in the same single pull request. - -If you want to use both features on your repositories, you need to enable these features independently and explicitly by using the two keys described above. diff --git a/data/reusables/dependabot/no-security-impact-if-not-default-branch.md b/data/reusables/dependabot/no-security-impact-if-not-default-branch.md deleted file mode 100644 index 4a9b7585feaa..000000000000 --- a/data/reusables/dependabot/no-security-impact-if-not-default-branch.md +++ /dev/null @@ -1,2 +0,0 @@ -> [!TIP] -> For security updates, this option has an impact only if this `package-ecosystem` creates pull requests against the default branch for the repository. This option has no impact if `target-branch` is used to define updates to a non-default branch. diff --git a/data/reusables/rai/copilot/copilot-chat-dotcom-beta.md b/data/reusables/rai/copilot/copilot-chat-dotcom-beta.md deleted file mode 100644 index b61dc381e83d..000000000000 --- a/data/reusables/rai/copilot/copilot-chat-dotcom-beta.md +++ /dev/null @@ -1 +0,0 @@ -{% data variables.product.prodname_copilot_chat %} is currently in {% data variables.release-phases.public_preview %} for users with a {% data variables.product.prodname_copilot_pro_short %} or {% data variables.product.prodname_copilot_business_short %} subscription.