From 318822480cdd513a03b93703da8e1d1e53914bd5 Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Mon, 6 Jan 2025 04:29:21 -0800 Subject: [PATCH 01/19] Update audit log event data (#53747) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- src/audit-logs/lib/config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/audit-logs/lib/config.json b/src/audit-logs/lib/config.json index 39421fd41e1a..9a9fdde4059f 100644 --- a/src/audit-logs/lib/config.json +++ b/src/audit-logs/lib/config.json @@ -3,5 +3,5 @@ "apiOnlyEvents": "This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", "apiRequestEvent": "This event is only available via audit log streaming." }, - "sha": "eafe424495cc22bd92b9122b9bb41a01f07314d9" + "sha": "20c2272a952ed0bd5281b59da7c6b538ed330b75" } \ No newline at end of file From 8d0c7bffc1f7f6e40fda8e54943aa62247749d84 Mon Sep 17 00:00:00 2001 From: RSKR Date: Mon, 6 Jan 2025 21:08:44 +0530 Subject: [PATCH 02/19] fix(docs): replaces `actions` with the right keyword `OWNER` (#35816) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../creating-actions/creating-a-composite-action.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/actions/sharing-automations/creating-actions/creating-a-composite-action.md b/content/actions/sharing-automations/creating-actions/creating-a-composite-action.md index ed1f8397c398..faa79ccf0324 100644 --- a/content/actions/sharing-automations/creating-actions/creating-a-composite-action.md +++ b/content/actions/sharing-automations/creating-actions/creating-a-composite-action.md @@ -155,7 +155,7 @@ Before you begin, you'll create a repository on {% data variables.product.github The following workflow code uses the completed hello world action that you made in [AUTOTITLE](/actions/creating-actions/creating-a-composite-action#creating-an-action-metadata-file). -Copy the workflow code into a `.github/workflows/main.yml` file in another repository, replacing `actions` and `SHA` with the repository owner and the SHA of the commit you want to use, respectively. You can also replace the `who-to-greet` input with your name. +Copy the workflow code into a `.github/workflows/main.yml` file in another repository, replacing `OWNER` and `SHA` with the repository owner and the SHA of the commit you want to use, respectively. You can also replace the `who-to-greet` input with your name. ```yaml copy on: [push] From a494a7bddaa0a03937fc2417edc5d55d2b15ef82 Mon Sep 17 00:00:00 2001 From: Jason Frey Date: Mon, 6 Jan 2025 10:39:50 -0500 Subject: [PATCH 03/19] Simplify the links for languages by pointing to the full list directly (#35811) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../migrating-from-travis-ci-to-github-actions.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/content/actions/migrating-to-github-actions/manually-migrating-to-github-actions/migrating-from-travis-ci-to-github-actions.md b/content/actions/migrating-to-github-actions/manually-migrating-to-github-actions/migrating-from-travis-ci-to-github-actions.md index fdca1ee9a597..e37b7d91df3f 100644 --- a/content/actions/migrating-to-github-actions/manually-migrating-to-github-actions/migrating-from-travis-ci-to-github-actions.md +++ b/content/actions/migrating-to-github-actions/manually-migrating-to-github-actions/migrating-from-travis-ci-to-github-actions.md @@ -183,13 +183,7 @@ The concurrent jobs and workflow execution times in {% data variables.product.pr ### Using different languages in {% data variables.product.prodname_actions %} -When working with different languages in {% data variables.product.prodname_actions %}, you can create a step in your job to set up your language dependencies. For more information about working with a particular language, see the specific guide: -* [Building and testing Node.js](/actions/automating-builds-and-tests/building-and-testing-nodejs) -* [Building and testing Python](/actions/automating-builds-and-tests/building-and-testing-python) -* [Building and testing PowerShell](/actions/automating-builds-and-tests/building-and-testing-powershell) -* [Building and testing Java with Maven](/actions/automating-builds-and-tests/building-and-testing-java-with-maven) -* [Building and testing Java with Gradle](/actions/automating-builds-and-tests/building-and-testing-java-with-gradle) -* [Building and testing Java with Ant](/actions/automating-builds-and-tests/building-and-testing-java-with-ant) +When working with different languages in {% data variables.product.prodname_actions %}, you can create a step in your job to set up your language dependencies. For more information about working with a particular language, see [AUTOTITLE](/actions/use-cases-and-examples/building-and-testing). ## Executing scripts From 4e8773ccb9311e8ef119fd786a15f30a782e916b Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Mon, 6 Jan 2025 23:40:55 +0800 Subject: [PATCH 04/19] Be sure to define 'description' (#35804) Co-authored-by: Felicity Chapman Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../using-issues/linking-a-pull-request-to-an-issue.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md b/content/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md index 3c090bd42abb..a11759f859e6 100644 --- a/content/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md +++ b/content/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md @@ -19,16 +19,16 @@ topics: shortTitle: Link PR to issue --- -> [!NOTE] -> The special keywords in a pull request description are interpreted when the pull request targets the repository's _default_ branch. However, if the PR's base is _any other branch_, then these keywords are ignored, no links are created and merging the PR has no effect on the issues. **If you want to link a pull request to an issue using a keyword, the PR must be on the default branch.** - ## About linked issues and pull requests -You can link an issue to a pull request manually or using a supported keyword in the pull request description. +You can link an issue to a pull request manually or using a supported keyword in the pull request description, that is, the summary text added by the author when they created the pull request. When you link a pull request to the issue the pull request addresses, collaborators can see that someone is working on the issue. -When you merge a linked pull request into the default branch of a repository, its linked issue is automatically closed. For more information about the default branch, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch). +When you merge a linked pull request into the **default branch** of a repository, its linked issue is automatically closed. For more information about the default branch, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch). + +> [!NOTE] +> The special keywords in a pull request description are interpreted only when the pull request targets the repository's _default_ branch. If the pull request targets _any other branch_, then these keywords are ignored, no links are created, and merging the PR has no effect on the issues. ## Linking a pull request to an issue using a keyword From 6c20e887bed0e6fb174bd697502f4f60cb657af9 Mon Sep 17 00:00:00 2001 From: StefanFB <68238380+StefanFB@users.noreply.github.com> Date: Mon, 6 Jan 2025 16:40:59 +0100 Subject: [PATCH 05/19] Fixed command for listing domains required for Codespaces (#35800) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../troubleshooting-your-connection-to-github-codespaces.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md b/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md index dea2a4501054..6221c90c30cd 100644 --- a/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md +++ b/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md @@ -36,7 +36,7 @@ If you see rejected connections, make sure the domains documented by the `/meta` To get the list of domains required by {% data variables.product.prodname_github_codespaces %}, execute the following command using {% data variables.product.prodname_cli %}: -`gh api meta | jq .domains.codespaces` +`gh api meta --jq .domains.codespaces` ### "We are having trouble fetching your codespace information" From 9c90fc89567b64b75852f5d7518cac598e4a513f Mon Sep 17 00:00:00 2001 From: Jacob Harris Date: Mon, 6 Jan 2025 10:42:07 -0500 Subject: [PATCH 06/19] use backticks to format _layouts directory in securing-your-github-pages-site-with-https#resolving-problems-with-mixed-content (#35795) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../securing-your-github-pages-site-with-https.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md b/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md index 53741c38af94..40a407842b71 100644 --- a/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md +++ b/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md @@ -46,7 +46,7 @@ If you enable HTTPS for your {% data variables.product.prodname_pages %} site bu To remove your site's mixed content, make sure all your assets are served over HTTPS by changing `http://` to `https://` in your site's HTML. Assets are commonly found in the following locations: -* If your site uses Jekyll, your HTML files will probably be found in the __layouts_ folder. +* If your site uses Jekyll, your HTML files will probably be found in the `_layouts` folder. * CSS is usually found in the `` section of your HTML file. * JavaScript is usually found in the `` section or just before the closing `` tag. * Images are often found in the `` section. From c422ad22dc8021c946cc00f1d3cb0d375e15994e Mon Sep 17 00:00:00 2001 From: Piyush Bhaskar <102078527+Piyush-r-bhaskar@users.noreply.github.com> Date: Mon, 6 Jan 2025 21:36:50 +0530 Subject: [PATCH 07/19] docs: Use backticks to format file name in working-with-the-npm-registry#installing-a-package. (#35793) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../working-with-the-npm-registry.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md index eb971e2eeb29..f44cbde6f1e1 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md @@ -58,9 +58,9 @@ This registry supports granular permissions. {% data reusables.package_registry. {% data reusables.package_registry.required-scopes %} -You can authenticate to {% data variables.product.prodname_registry %} with npm by either editing your per-user _~/.npmrc_ file to include your {% data variables.product.pat_v1 %} or by logging in to npm on the command line using your username and {% data variables.product.pat_generic %}. +You can authenticate to {% data variables.product.prodname_registry %} with npm by either editing your per-user `~/.npmrc` file to include your {% data variables.product.pat_v1 %} or by logging in to npm on the command line using your username and {% data variables.product.pat_generic %}. -To authenticate by adding your {% data variables.product.pat_v1 %} to your _~/.npmrc_ file, edit the _~/.npmrc_ file for your project to include the following line, replacing {% ifversion ghes %}HOSTNAME with the host name of {% data variables.location.product_location %} and {% endif %}TOKEN with your {% data variables.product.pat_generic %}. Create a new _~/.npmrc_ file if one doesn't exist. +To authenticate by adding your {% data variables.product.pat_v1 %} to your `~/.npmrc` file, edit the `~/.npmrc` file for your project to include the following line, replacing {% ifversion ghes %}HOSTNAME with the host name of {% data variables.location.product_location %} and {% endif %}TOKEN with your {% data variables.product.pat_generic %}. Create a new `~/.npmrc` file if one doesn't exist. {% ifversion ghes %} If your instance has subdomain isolation enabled: @@ -137,9 +137,9 @@ You can set up the scope mapping for your project using either a local `.npmrc` {% data reusables.package_registry.viewing-packages %} -### Publishing a package using a local _.npmrc_ file +### Publishing a package using a local `.npmrc` file -You can use an _.npmrc_ file to configure the scope mapping for your project. In the _.npmrc_ file, use the {% data variables.product.prodname_registry %} URL and account owner so {% data variables.product.prodname_registry %} knows where to route package requests. Using an _.npmrc_ file prevents other developers from accidentally publishing the package to npmjs.org instead of {% data variables.product.prodname_registry %}. +You can use an `.npmrc` file to configure the scope mapping for your project. In the `.npmrc` file, use the {% data variables.product.prodname_registry %} URL and account owner so {% data variables.product.prodname_registry %} knows where to route package requests. Using an `.npmrc` file prevents other developers from accidentally publishing the package to npmjs.org instead of {% data variables.product.prodname_registry %}. {% data reusables.package_registry.authenticate-step %} {% data reusables.package_registry.create-npmrc-owner-step %} @@ -194,7 +194,7 @@ You can install packages from {% data variables.product.prodname_registry %} by By default, you can add packages from one organization. For more information, see [Installing packages from other organizations](#installing-packages-from-other-organizations). -You also need to add the _.npmrc_ file to your project so that all requests to install packages will go through {% data variables.product.prodname_registry %}. When you route all package requests through {% data variables.product.prodname_registry %}, you can use both scoped and unscoped packages from _npmjs.org_. For more information, see [npm-scope](https://docs.npmjs.com/misc/scope) in the npm documentation. +You also need to add the `.npmrc` file to your project so that all requests to install packages will go through {% data variables.product.prodname_registry %}. When you route all package requests through {% data variables.product.prodname_registry %}, you can use both scoped and unscoped packages from _npmjs.org_. For more information, see [npm-scope](https://docs.npmjs.com/misc/scope) in the npm documentation. {% data reusables.package_registry.authenticate-step %} {% data reusables.package_registry.create-npmrc-owner-step %} @@ -223,7 +223,7 @@ You also need to add the _.npmrc_ file to your project so that all requests to i ### Installing packages from other organizations -By default, you can only use {% data variables.product.prodname_registry %} packages from one organization. If you'd like to route package requests to multiple organizations and users, you can add additional lines to your _.npmrc_ file, replacing {% ifversion ghes %}`HOSTNAME` with the host name of {% data variables.location.product_location %} and {% endif %}`NAMESPACE` with the name of the personal account or organization {% ifversion packages-npm-v2 %}to which the package is scoped{% else %}that owns the repository containing the project{% endif %}. +By default, you can only use {% data variables.product.prodname_registry %} packages from one organization. If you'd like to route package requests to multiple organizations and users, you can add additional lines to your `.npmrc` file, replacing {% ifversion ghes %}`HOSTNAME` with the host name of {% data variables.location.product_location %} and {% endif %}`NAMESPACE` with the name of the personal account or organization {% ifversion packages-npm-v2 %}to which the package is scoped{% else %}that owns the repository containing the project{% endif %}. {% ifversion ghes %} If your instance has subdomain isolation enabled: From 99024c5f0b76964dde2164bfbcd30b10d9a0b393 Mon Sep 17 00:00:00 2001 From: Piyush Bhaskar <102078527+Piyush-r-bhaskar@users.noreply.github.com> Date: Mon, 6 Jan 2025 21:37:10 +0530 Subject: [PATCH 08/19] Capitalize list line in working-with-the-apache-maven-registry#authenticating-to-github-packages. (#35792) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- data/reusables/package_registry/authenticate-packages.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/reusables/package_registry/authenticate-packages.md b/data/reusables/package_registry/authenticate-packages.md index c15920beb25b..fc5f87ddcbc2 100644 --- a/data/reusables/package_registry/authenticate-packages.md +++ b/data/reusables/package_registry/authenticate-packages.md @@ -6,4 +6,4 @@ You can use a {% data variables.product.pat_v1 %} to authenticate to {% data var To authenticate to a {% data variables.product.prodname_registry %} registry within a {% data variables.product.prodname_actions %} workflow, you can use: * `GITHUB_TOKEN` to publish packages associated with the workflow repository. -* a {% data variables.product.pat_v1 %} with at least `read:packages` scope to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). +* A {% data variables.product.pat_v1 %} with at least `read:packages` scope to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). From aa20214dd9d878400a2c558edf3458854097bd12 Mon Sep 17 00:00:00 2001 From: Piyush Bhaskar <102078527+Piyush-r-bhaskar@users.noreply.github.com> Date: Mon, 6 Jan 2025 21:37:26 +0530 Subject: [PATCH 09/19] Add colons in about-github-packages-and-github-actions#workflows-for-publishing-packages | issue/35774 (#35791) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../reusables/package_registry/about-packaging-and-actions.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/data/reusables/package_registry/about-packaging-and-actions.md b/data/reusables/package_registry/about-packaging-and-actions.md index b359bdfad755..bdcd36ed22e4 100644 --- a/data/reusables/package_registry/about-packaging-and-actions.md +++ b/data/reusables/package_registry/about-packaging-and-actions.md @@ -16,12 +16,12 @@ This will let you run the code in the pull request on your machine, which can he In addition to uploading packaging artifacts for testing in a continuous integration workflow, you can create workflows that build your project and publish packages to a package registry. -* **Publish packages to {% data variables.product.prodname_registry %}** +* **Publish packages to {% data variables.product.prodname_registry %}:** {% data variables.product.prodname_registry %} can act as a package hosting service for many types of packages. You can choose to share your packages with all of {% data variables.product.prodname_dotcom %}, or private packages to share with collaborators or an organization. For more information, see "[AUTOTITLE](/packages/learn-github-packages/introduction-to-github-packages)." You may want to publish packages to {% data variables.product.prodname_registry %} on every push into the default branch. This will allow developers on your project to always be able to run and test the latest build from the default branch easily, by installing it from {% data variables.product.prodname_registry %}. -* **Publish packages to a package registry** +* **Publish packages to a package registry:** For many projects, publishing to a package registry is performed whenever a new version of a project is released. For example, a project that produces a JAR file may upload new releases to the Maven Central repository. Or, a .NET project may produce a nuget package and upload it to the NuGet Gallery. You can automate this by creating a workflow that publishes packages to a package registry on every release creation. For more information, see "[AUTOTITLE](/repositories/releasing-projects-on-github/managing-releases-in-a-repository)." From 518420240dba326115bec4cbf4d1c9e14714bad8 Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Mon, 6 Jan 2025 08:35:01 -0800 Subject: [PATCH 10/19] Update audit log event data (#53769) --- src/audit-logs/lib/config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/audit-logs/lib/config.json b/src/audit-logs/lib/config.json index 9a9fdde4059f..39ea5d7c4e87 100644 --- a/src/audit-logs/lib/config.json +++ b/src/audit-logs/lib/config.json @@ -3,5 +3,5 @@ "apiOnlyEvents": "This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", "apiRequestEvent": "This event is only available via audit log streaming." }, - "sha": "20c2272a952ed0bd5281b59da7c6b538ed330b75" + "sha": "a91faaa776298030c2e9dbf2aa57e3698a00bfe8" } \ No newline at end of file From eef734ae68615738322db277bd29f74cc9407184 Mon Sep 17 00:00:00 2001 From: Shashwat Pathak <111122076+shashwatpathak98@users.noreply.github.com> Date: Mon, 6 Jan 2025 22:42:18 +0530 Subject: [PATCH 11/19] fix: Add missing period in about-github-pages#usage-limits (#35781) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../getting-started-with-github-pages/about-github-pages.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/pages/getting-started-with-github-pages/about-github-pages.md b/content/pages/getting-started-with-github-pages/about-github-pages.md index 5fe9a21bb32b..e2af4547ee82 100644 --- a/content/pages/getting-started-with-github-pages/about-github-pages.md +++ b/content/pages/getting-started-with-github-pages/about-github-pages.md @@ -117,7 +117,7 @@ Using {% data variables.product.prodname_pages %} to create a copy of an existin {% data variables.product.prodname_pages %} sites are subject to the following usage limits: -* {% data variables.product.prodname_pages %} source repositories have a recommended limit of 1 GB.{% ifversion fpt or ghec %} For more information, see [AUTOTITLE](/repositories/working-with-files/managing-large-files/about-large-files-on-github#file-and-repository-size-limitations){% endif %} +* {% data variables.product.prodname_pages %} source repositories have a recommended limit of 1 GB.{% ifversion fpt or ghec %} For more information, see [AUTOTITLE](/repositories/working-with-files/managing-large-files/about-large-files-on-github#file-and-repository-size-limitations){% endif %}. * Published {% data variables.product.prodname_pages %} sites may be no larger than 1 GB. * {% data variables.product.prodname_pages %} deployments will timeout if they take longer than 10 minutes. {% ifversion fpt or ghec %} From d31c0bad84b936549b922070b08faaaf498d995b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nikola=20Kolo=C5=A1njaji?= Date: Mon, 6 Jan 2025 18:12:18 +0100 Subject: [PATCH 12/19] Update building-and-testing-java-with-maven.md (#35777) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../building-and-testing-java-with-maven.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/actions/use-cases-and-examples/building-and-testing/building-and-testing-java-with-maven.md b/content/actions/use-cases-and-examples/building-and-testing/building-and-testing-java-with-maven.md index 13230c3a7323..4cd3b9aeccab 100644 --- a/content/actions/use-cases-and-examples/building-and-testing/building-and-testing-java-with-maven.md +++ b/content/actions/use-cases-and-examples/building-and-testing/building-and-testing-java-with-maven.md @@ -117,7 +117,7 @@ You can cache your dependencies to speed up your workflow runs. After a successf ```yaml copy steps: - uses: {% data reusables.actions.action-checkout %} - - name: Set up JDK 11 + - name: Set up JDK 17 uses: {% data reusables.actions.action-setup-java %} with: java-version: '17' From 17f081f68886e70712d0b61c24bafe8441282094 Mon Sep 17 00:00:00 2001 From: Jan Brasna <1784648+janbrasna@users.noreply.github.com> Date: Mon, 6 Jan 2025 18:12:56 +0100 Subject: [PATCH 13/19] Fit disable-selfhosted-runners reusable sentence in its ifversion (#35770) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- data/reusables/actions/disable-selfhosted-runners-crossrefs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/reusables/actions/disable-selfhosted-runners-crossrefs.md b/data/reusables/actions/disable-selfhosted-runners-crossrefs.md index 2cc86e9ea8fb..d275c5ae2767 100644 --- a/data/reusables/actions/disable-selfhosted-runners-crossrefs.md +++ b/data/reusables/actions/disable-selfhosted-runners-crossrefs.md @@ -1,4 +1,4 @@ -{% ifversion ghec or ghes %}Enterprise owners and organization {% elsif fpt %}Organization {% endif %}owners can choose which repositories are allowed to create repository-level self-hosted runners. {% ifversion custom-org-roles %}Users with the “Manage organization runners and runner groups” permission can only choose which repositories are allowed to create repository-level self-hosted runners for repositories in your organization{% endif %}. +{% ifversion ghec or ghes %}Enterprise owners and organization {% elsif fpt %}Organization {% endif %}owners can choose which repositories are allowed to create repository-level self-hosted runners. {% ifversion custom-org-roles %}Users with the “Manage organization runners and runner groups” permission can only choose which repositories are allowed to create repository-level self-hosted runners for repositories in your organization.{% endif %} {% ifversion custom-org-roles %}For more information about custom organization roles, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).{% endif %} From 5c0a7b2cff102332d47469427e49574cdd9fd0fa Mon Sep 17 00:00:00 2001 From: yolocat <81561018+yolocat-dev@users.noreply.github.com> Date: Mon, 6 Jan 2025 18:40:58 +0100 Subject: [PATCH 14/19] Use backtick to format references to file names in `working-with-the-npm-registry` (#35765) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- data/reusables/package_registry/verify_repository_field.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/reusables/package_registry/verify_repository_field.md b/data/reusables/package_registry/verify_repository_field.md index 462e08bc54ea..58ba6af4b6c0 100644 --- a/data/reusables/package_registry/verify_repository_field.md +++ b/data/reusables/package_registry/verify_repository_field.md @@ -1 +1 @@ -1. Verify the `repository` field in your project's _package.json_. The `repository` field must match the URL for your {% data variables.product.prodname_dotcom %} repository. For example, if your repository URL is `github.com/my-org/test` then the repository field should be `https://github.com/my-org/test.git`. +1. Verify the `repository` field in your project's `package.json`. The `repository` field must match the URL for your {% data variables.product.prodname_dotcom %} repository. For example, if your repository URL is `github.com/my-org/test` then the repository field should be `https://github.com/my-org/test.git`. From 6fb3316152c6e85b9ced6a81234924098be7f1c5 Mon Sep 17 00:00:00 2001 From: Michael21107 <121039033+Michael21107@users.noreply.github.com> Date: Mon, 6 Jan 2025 18:41:18 +0100 Subject: [PATCH 15/19] Update about-task-lists.md (#35764) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../working-with-advanced-formatting/about-task-lists.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists.md b/content/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists.md index 1ad7172042c6..83a4fd280108 100644 --- a/content/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists.md +++ b/content/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists.md @@ -44,7 +44,7 @@ If you add a task list to the body of an issue, the list has added functionality {% data reusables.repositories.task-list-markdown %} -> [!TIP] +> [!NOTE] > You cannot create task list items within closed issues or issues with linked pull requests. ## Reordering tasks From 6225df505c85c85a9b2cf3030ca2595f3714a420 Mon Sep 17 00:00:00 2001 From: satler <119724672+satler-git@users.noreply.github.com> Date: Tue, 7 Jan 2025 02:41:24 +0900 Subject: [PATCH 16/19] fix: payload and secret are translated in some langs(use inline code) (#35759) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../webhooks/using-webhooks/validating-webhook-deliveries.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/webhooks/using-webhooks/validating-webhook-deliveries.md b/content/webhooks/using-webhooks/validating-webhook-deliveries.md index 75cb20c2b573..4ad442197c6e 100644 --- a/content/webhooks/using-webhooks/validating-webhook-deliveries.md +++ b/content/webhooks/using-webhooks/validating-webhook-deliveries.md @@ -57,8 +57,8 @@ There are a few important things to keep in mind when validating webhook payload You can use the following `secret` and `payload` values to verify that your implementation is correct: -* `secret`: "It's a Secret to Everybody" -* `payload`: "Hello, World!" +* `secret`: `It's a Secret to Everybody` +* `payload`: `Hello, World!` If your implementation is correct, the signatures that you generate should match the following signature values: From b9191a72c9caafeeb9ec399aa86e8092e059b61d Mon Sep 17 00:00:00 2001 From: Shobhit Nagpal <74096450+Shobhit-Nagpal@users.noreply.github.com> Date: Mon, 6 Jan 2025 23:27:46 +0530 Subject: [PATCH 17/19] add: missing period (#35741) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- data/reusables/actions/about-oidc-short-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/reusables/actions/about-oidc-short-overview.md b/data/reusables/actions/about-oidc-short-overview.md index 2bbcbd9cd490..7232f31662e8 100644 --- a/data/reusables/actions/about-oidc-short-overview.md +++ b/data/reusables/actions/about-oidc-short-overview.md @@ -1,2 +1,2 @@ -If your {% data variables.product.prodname_actions %} workflows need to access resources from a cloud provider that supports OpenID Connect (OIDC), you can configure your workflows to authenticate directly to the cloud provider. This will let you stop storing these credentials as long-lived secrets and provide other security benefits. For more information, see [AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect) +If your {% data variables.product.prodname_actions %} workflows need to access resources from a cloud provider that supports OpenID Connect (OIDC), you can configure your workflows to authenticate directly to the cloud provider. This will let you stop storing these credentials as long-lived secrets and provide other security benefits. For more information, see [AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect). From 42f38c8c0e85f2133a91e0d6c4b7eced6b5c534a Mon Sep 17 00:00:00 2001 From: Christian Specht Date: Mon, 6 Jan 2025 18:58:01 +0100 Subject: [PATCH 18/19] =?UTF-8?q?add=20note=20about=20restarting=20the=20r?= =?UTF-8?q?unner=20service=20after=20changing=20the=20.env=20=E2=80=A6=20(?= =?UTF-8?q?#35356)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../running-scripts-before-or-after-a-job.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/running-scripts-before-or-after-a-job.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/running-scripts-before-or-after-a-job.md index 739fbb652f77..28fb850343eb 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/running-scripts-before-or-after-a-job.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/running-scripts-before-or-after-a-job.md @@ -49,7 +49,8 @@ The scripts are automatically executed when the runner has the following environ * `ACTIONS_RUNNER_HOOK_JOB_STARTED`: The script defined in this environment variable is triggered when a job has been assigned to a runner, but before the job starts running. * `ACTIONS_RUNNER_HOOK_JOB_COMPLETED`: The script defined in this environment variable is triggered at the end of the job, after all the steps defined in the workflow have run. -To set these environment variables, you can either add them to the operating system, or add them to a file named `.env` within the self-hosted runner application directory (that is, the directory into which you downloaded and unpacked the runner software). For example, the following `.env` entry will have the runner automatically run a script, saved as `/opt/runner/cleanup_script.sh` on the runner machine, before each job runs: +To set these environment variables, you can either add them to the operating system, or add them to a file named `.env` within the self-hosted runner application directory (that is, the directory into which you downloaded and unpacked the runner software). Note that any change to the `.env` file will require restarting the runner. +For example, the following `.env` entry will have the runner automatically run a script, saved as `/opt/runner/cleanup_script.sh` on the runner machine, before each job runs: ```bash ACTIONS_RUNNER_HOOK_JOB_STARTED=/opt/runner/cleanup_script.sh From 6c54e003254fc81c8863086a9f387bf7480cebf0 Mon Sep 17 00:00:00 2001 From: Nuru Date: Mon, 6 Jan 2025 09:58:12 -0800 Subject: [PATCH 19/19] Clarify use of labels and groups together (#35715) Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> --- .../using-self-hosted-runners-in-a-workflow.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/using-self-hosted-runners-in-a-workflow.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/using-self-hosted-runners-in-a-workflow.md index 3416f054f945..4cbdecc86572 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/using-self-hosted-runners-in-a-workflow.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/using-self-hosted-runners-in-a-workflow.md @@ -17,7 +17,7 @@ shortTitle: Use runners in a workflow You can target self-hosted runners for use in a workflow based on the labels assigned to the runners{% ifversion target-runner-groups %}, or their group membership, or a combination of these{% endif %}. ->[!NOTE]Actions Runner Controller does not support multiple labels, only the name of the runner can be used in place of a label +>[!IMPORTANT]Runner Scale Sets do not support multiple labels, only the name of the runner can be used in place of a label. See [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller). ## About self-hosted runner labels @@ -109,9 +109,9 @@ These labels operate cumulatively, so a self-hosted runner must have all four la ## Routing precedence for self-hosted runners -When routing a job to a self-hosted runner, {% data variables.product.prodname_dotcom %} looks for a runner that matches the job's `runs-on` labels{% ifversion target-runner-groups %} and/or groups{% endif %}: +When routing a job to a self-hosted runner, {% data variables.product.prodname_dotcom %} looks for a runner that matches the job's `runs-on` labels{% ifversion target-runner-groups %} and groups{% endif %}: -* If {% data variables.product.prodname_dotcom %} finds an online and idle runner that matches the job's `runs-on` labels{% ifversion target-runner-groups %} and/or groups{% endif %}, the job is then assigned and sent to the runner. +* If {% data variables.product.prodname_dotcom %} finds an online and idle runner that matches the job's `runs-on` labels{% ifversion target-runner-groups %} and groups{% endif %}, the job is then assigned and sent to the runner. * If the runner doesn't pick up the assigned job within 60 seconds, the job is re-queued so that a new runner can accept it. -* If {% data variables.product.prodname_dotcom %} doesn't find an online and idle runner that matches the job's `runs-on` labels {% ifversion target-runner-groups %} and/or groups{% endif %}, then the job will remain queued until a runner comes online. +* If {% data variables.product.prodname_dotcom %} doesn't find an online and idle runner that matches the job's `runs-on` labels {% ifversion target-runner-groups %} and groups{% endif %}, then the job will remain queued until a runner comes online. * If the job remains queued for more than 24 hours, the job will fail.