Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pull] main from github:main #3

Merged
merged 21 commits into from
Jan 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
3188224
Update audit log event data (#53747)
docs-bot Jan 6, 2025
1d9feef
Merge pull request #35840 from github/repo-sync
docs-bot Jan 6, 2025
8d0c7bf
fix(docs): replaces `actions` with the right keyword `OWNER` (#35816)
rskrishnar Jan 6, 2025
a494a7b
Simplify the links for languages by pointing to the full list directl…
Fryguy Jan 6, 2025
4e8773c
Be sure to define 'description' (#35804)
MichaelChirico Jan 6, 2025
6c20e88
Fixed command for listing domains required for Codespaces (#35800)
StefanFB Jan 6, 2025
9c90fc8
use backticks to format _layouts directory in securing-your-github-pa…
bocsir Jan 6, 2025
c422ad2
docs: Use backticks to format file name in working-with-the-npm-regis…
Piyush-r-bhaskar Jan 6, 2025
99024c5
Capitalize list line in working-with-the-apache-maven-registry#authen…
Piyush-r-bhaskar Jan 6, 2025
aa20214
Add colons in about-github-packages-and-github-actions#workflows-for-…
Piyush-r-bhaskar Jan 6, 2025
5184202
Update audit log event data (#53769)
docs-bot Jan 6, 2025
eef734a
fix: Add missing period in about-github-pages#usage-limits (#35781)
shashwatpathak98 Jan 6, 2025
d31c0ba
Update building-and-testing-java-with-maven.md (#35777)
nkolosnjaji Jan 6, 2025
17f081f
Fit disable-selfhosted-runners reusable sentence in its ifversion (#3…
janbrasna Jan 6, 2025
5c0a7b2
Use backtick to format references to file names in `working-with-the-…
yolocat-dev Jan 6, 2025
6fb3316
Update about-task-lists.md (#35764)
Michael21107 Jan 6, 2025
6225df5
fix: payload and secret are translated in some langs(use inline code)…
satler-git Jan 6, 2025
b9191a7
add: missing period (#35741)
Shobhit-Nagpal Jan 6, 2025
42f38c8
add note about restarting the runner service after changing the .env …
christianspecht Jan 6, 2025
6c54e00
Clarify use of labels and groups together (#35715)
Nuru Jan 6, 2025
c78e55b
Merge pull request #35842 from github/repo-sync
docs-bot Jan 6, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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 %}
Expand Down Expand Up @@ -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 %}
Expand Down Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<head>` section of your HTML file.
* JavaScript is usually found in the `<head>` section or just before the closing `</body>` tag.
* Images are often found in the `<body>` section.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion data/reusables/actions/about-oidc-short-overview.md
Original file line number Diff line number Diff line change
@@ -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).
Original file line number Diff line number Diff line change
@@ -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 %}

Expand Down
Loading