diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 20fa5bdae05f..f65ef1d11220 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -95,6 +95,8 @@ A [pull request](https://docs.github.com/en/github/collaborating-with-issues-and When we merge those changes, they should be deployed to the live site within 24 hours. :earth_africa: To learn more about opening a pull request in this repo, see [Opening a pull request](#opening-a-pull-request) below. +We cannot accept contributions to the [REST API reference documentation](https://docs.github.com/en/rest/reference). If you spot an inaccuracy in the REST API reference documentation, open an issue in the [github/rest-api-description](https://github.com/github/rest-api-description/issues/new?template=schema-inaccuracy.md) repository. + ### :question: Support We are a small team working hard to keep up with the documentation demands of a continuously changing product. Unfortunately, we just can't help with support questions in this repository. If you are experiencing a problem with GitHub, unrelated to our documentation, please [contact GitHub Support directly](https://support.github.com/contact). Any issues, discussions, or pull requests opened here requesting support will be given information about how to contact GitHub Support, then closed and locked. diff --git a/content/admin/github-actions/using-the-latest-version-of-the-official-bundled-actions.md b/content/admin/github-actions/using-the-latest-version-of-the-official-bundled-actions.md index 3325c53ca0dd..ad09801a476d 100644 --- a/content/admin/github-actions/using-the-latest-version-of-the-official-bundled-actions.md +++ b/content/admin/github-actions/using-the-latest-version-of-the-official-bundled-actions.md @@ -14,16 +14,24 @@ topics: Your enterprise instance includes a number of built-in actions that you can use in your workflows. For more information about the bundled actions, see "[Official actions bundled with your enterprise instance](/admin/github-actions/about-using-actions-in-your-enterprise#official-actions-bundled-with-your-enterprise-instance)." -These bundled actions are a point-in-time snapshot of the official actions found at https://github.com/actions; as a result, these actions may be older versions that can be updated. To update these actions, you can use `actions-sync` to retrieve updated versions from {% data variables.product.prodname_dotcom_the_website %}. +These bundled actions are a point-in-time snapshot of the official actions found at https://github.com/actions, so there may be newer versions of these actions available. You can use the `actions-sync` tool to update these actions, or you can configure {% data variables.product.prodname_github_connect %} to allow access to the latest actions on {% data variables.product.prodname_dotcom_the_website %}. These options are described in the following sections. -These options are described in more detail in the following sections. +### Using `actions-sync` to update the bundled actions -### Using actions-sync to update a bundled action +To update the bundled actions, you can use the `actions-sync` tool to update the snapshot. For more information on using `actions-sync`, see "[Manually syncing actions from {% data variables.product.prodname_dotcom_the_website %}](/admin/github-actions/manually-syncing-actions-from-githubcom)." -To update the bundled actions, you can use the `actions-sync` tool to synchronize actions with {% data variables.product.prodname_dotcom_the_website %}. For more information on using `actions-sync`, see "[Manually syncing actions from {% data variables.product.prodname_dotcom_the_website %}](/admin/github-actions/manually-syncing-actions-from-githubcom)." +### Using {% data variables.product.prodname_github_connect %} to access the latest actions -### Using actions from {% data variables.product.prodname_dotcom_the_website %} +You can use {% data variables.product.prodname_github_connect %} to allow {% data variables.product.product_name %} to use actions from {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Enabling automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)." -To allow {% data variables.product.product_name %} to use actions directly from {% data variables.product.prodname_dotcom_the_website %}, you can use {% data variables.product.prodname_github_connect %}. For more information, see "[Enabling automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)." +Once {% data variables.product.prodname_github_connect %} is configured, you can use the latest version of an action by deleting its local repository in the `actions` organization on your instance. For example, if your enterprise instance is using the `actions/checkout@v1` action, and you need to use `actions/checkout@v2` which isn't available on your enterprise instance, perform the following steps to be able to use the latest `checkout` action from {% data variables.product.prodname_dotcom_the_website %}: -Once configured, you can use a new version of an action from {% data variables.product.prodname_dotcom_the_website %} by manually specifying the required version in the workflow file. For example, to use version `v2.2.1` of `actions/setup-python` from {% data variables.product.prodname_dotcom_the_website %}, you can specify the tag `actions/setup-python@v2.2.1` in your workflow file. +1. To get the required access to delete the `checkout` repository, use the `ghe-org-admin-promote` command to promote a user to be an owner of the bundled `actions` organization. For more information, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)" and "[`ghe-org-admin-promote`](/admin/configuration/command-line-utilities#ghe-org-admin-promote)." For example: + + ```shell + ghe-org-admin-promote -u USERNAME -o actions + ``` +1. On your {% data variables.product.product_name %} instance, delete the `checkout` repository within the `actions` organization. For information on how to delete a repository, see "[Deleting a repository +](/github/administering-a-repository/deleting-a-repository)." +1. Configure your workflow's YAML to use `actions/checkout@v2`. +1. Each time your workflow runs, the runner will use the `v2` version of `actions/checkout` from {% data variables.product.prodname_dotcom_the_website %}. diff --git a/content/developers/webhooks-and-events/webhook-events-and-payloads.md b/content/developers/webhooks-and-events/webhook-events-and-payloads.md index e2a9c0974c91..ff1404c40dcd 100644 --- a/content/developers/webhooks-and-events/webhook-events-and-payloads.md +++ b/content/developers/webhooks-and-events/webhook-events-and-payloads.md @@ -199,7 +199,9 @@ Also, the `User-Agent` for the requests will have the prefix `GitHub-Hookshot/`. Webhook events are triggered based on the specificity of the domain you register. For example, if you register a subdomain (`https://subdomain.example.com`) then only URLs for the subdomain trigger this event. If you register a domain (`https://example.com`) then URLs for domain and all subdomains trigger this event. See "[Create a content attachment](/rest/reference/apps#create-a-content-attachment)" to create a new content attachment. -Only {% data variables.product.prodname_github_app %}s can receive this event. {% data variables.product.prodname_github_app %}s must have the `content_references` `write` permission to subscribe to this event. +#### Availability + +- {% data variables.product.prodname_github_app %}s with the `content_references:write` permission #### Webhook payload example @@ -1008,12 +1010,6 @@ Deliveries for `review_requested` and `review_request_removed` events will have {% endnote %} -{% tip %} - -**Note**: The webhook payload example following the table differs significantly from the Events API payload described in the table. Among other differences, the webhook payload includes both `sender` and `pusher` objects. Sender and pusher are the same user who initiated the `push` event, but the `sender` object contains more detail. - -{% endtip %} - #### Availability - Repository webhooks diff --git a/data/reusables/secret-scanning/partner-secret-list-private-repo.md b/data/reusables/secret-scanning/partner-secret-list-private-repo.md index b6dae162f920..69cad3e6633b 100644 --- a/data/reusables/secret-scanning/partner-secret-list-private-repo.md +++ b/data/reusables/secret-scanning/partner-secret-list-private-repo.md @@ -3,6 +3,10 @@ Partner | Supported secret | API slug n/a | JSON Web Token | json_web_token n/a | OAuth Client Credential | api_credential_assignment Adafruit IO | Adafruit IO Key | adafruit_io_key +Adobe | Adobe Device Token | adobe_device_token +Adobe | Adobe Service Token | adobe_service_token +Adobe | Adobe Short-Lived Access Token | adobe_short_lived_access_token +Adobe | Adobe JSON Web Token | adobe_jwt Alibaba Cloud | Alibaba Cloud Access Key ID | alibaba_cloud_access_key_id Alibaba Cloud | Alibaba Cloud Access Key Secret | alibaba_cloud_access_key_secret Amazon Web Services (AWS) | Amazon AWS Access Key ID | aws_access_key_id @@ -31,9 +35,11 @@ Facebook | Facebook Access Token | facebook_access_token Finicity | Finicity App Key | finicity_app_key Frame.io | Frame.io JSON Web Token | frameio_jwt Frame.io| Frame.io Developer Token | frameio_developer_token -GitHub | GitHub SSH Private Key | github_ssh_private_key GitHub | GitHub Personal Access Token | github_personal_access_token +GitHub | GitHub OAuth Access Token | github_oauth_access_token +GitHub | GitHub Refresh Token | github_refresh_token GitHub | GitHub App Installation Access Token | github_app_installation_access_token +GitHub | GitHub SSH Private Key | github_ssh_private_key GoCardless | GoCardless Live Access Token | gocardless_live_access_token GoCardless | GoCardless Sandbox Access Token | gocardless_sandbox_access_token Google Cloud | Google API Key | google_api_key diff --git a/data/reusables/secret-scanning/partner-secret-list-public-repo.md b/data/reusables/secret-scanning/partner-secret-list-public-repo.md index ee8848546032..a3926d6d72cc 100644 --- a/data/reusables/secret-scanning/partner-secret-list-public-repo.md +++ b/data/reusables/secret-scanning/partner-secret-list-public-repo.md @@ -1,15 +1,19 @@ Partner | Supported secret --- | --- Adafruit IO | Adafruit IO Key +Adobe | Adobe Device Token +Adobe | Adobe Service Token +Adobe | Adobe Short-Lived Access Token +Adobe | Adobe JSON Web Token Alibaba Cloud | Alibaba Cloud Access Key ID and Access Key Secret pair Amazon Web Services (AWS) | Amazon AWS Access Key ID and Secret Access Key pair Atlassian | Atlassian API Token Atlassian | Atlassian JSON Web Token -Azure | Azure DevOps Personal Access Token | azure_devops_personal_access_token -Azure | Azure SAS Token | azure_sas_token -Azure | Azure Service Management Certificate | azure_management_certificate -Azure | Azure SQL Connection String | azure_sql_connection_string -Azure | Azure Storage Account Key | azure_storage_account_key +Azure | Azure DevOps Personal Access Token +Azure | Azure SAS Token +Azure | Azure Service Management Certificate +Azure | Azure SQL Connection String +Azure | Azure Storage Account Key Clojars | Clojars Deploy Token CloudBees CodeShip | CloudBees CodeShip Credential Databricks | Databricks Access Token @@ -26,9 +30,11 @@ Dynatrace | Dynatrace Internal Token Finicity | Finicity App Key Frame.io | Frame.io JSON Web Token Frame.io| Frame.io Developer Token -GitHub | GitHub SSH Private Key GitHub | GitHub Personal Access Token +GitHub | GitHub OAuth Access Token +GitHub | GitHub Refresh Token GitHub | GitHub App Installation Access Token +GitHub | GitHub SSH Private Key GoCardless | GoCardless Live Access Token GoCardless | GoCardless Sandbox Access Token Google Cloud | Google API Key diff --git a/includes/article.html b/includes/article.html index c561290bc972..ba58d0f82263 100644 --- a/includes/article.html +++ b/includes/article.html @@ -46,7 +46,7 @@

{{ page.title }}

{% endif %} {% if page.product %} -
+
{{ page.product }}
{% endif %} diff --git a/stylesheets/index.scss b/stylesheets/index.scss index c95be5737c21..ca807a051476 100644 --- a/stylesheets/index.scss +++ b/stylesheets/index.scss @@ -3,6 +3,7 @@ @import "@primer/css/forms/index.scss"; @import "@primer/css/navigation/index.scss"; @import "@primer/css/labels/index.scss"; +@import "@primer/css/avatars/avatar.scss"; $marketing-font-path: "/dist/fonts/"; @import "@primer/css/marketing/index.scss"; diff --git a/tests/rendering/server.js b/tests/rendering/server.js index ef799005a483..249730fba9d3 100644 --- a/tests/rendering/server.js +++ b/tests/rendering/server.js @@ -191,8 +191,8 @@ describe('server', () => { test('renders product frontmatter callouts', async () => { const $ = await getDOM('/en/articles/about-branch-restrictions') const note = $('.product-callout').eq(0) - expect(note.hasClass('color-border-info')).toBe(true) - expect(note.hasClass('color-bg-info')).toBe(true) + expect(note.hasClass('color-border-success')).toBe(true) + expect(note.hasClass('color-bg-success')).toBe(true) }) test('renders liquid within liquid within product frontmatter callouts', async () => {