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

Repo sync #36395

Merged
merged 7 commits into from
Feb 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 @@ -16,9 +16,7 @@ type: how_to

To create an experience on {% data variables.product.github %} that fits your needs, you can customize the user interface. Accessibility settings can be essential for people with disabilities, but can be useful to anyone. For example, customization of keyboard shortcuts is essential to people who navigate using voice control, but can be useful to anyone when a keyboard shortcut for {% data variables.product.github %} clashes with another application shortcut.

You can decide whether you want to use some or all keyboard shortcuts, and control the display of animated images{% ifversion link-underlines %} and how links are displayed{% endif %}.

{% ifversion link-underlines %}
You can decide whether you want to use some or all keyboard shortcuts, and control the display of animated images and how links are displayed.

## Managing the appearance of links

Expand All @@ -32,8 +30,6 @@ You can control whether links in text blocks are underlined and therefore more d
* To disable underlines on links in text blocks, under "Link underlines", select **Hide link underlines**.
* To disable hovercards for previewing link content, deselect **Hovercards**.

{% endif %}

## Managing keyboard shortcuts

You can perform actions across the {% data variables.product.github %} website by using your keyboard alone. Keyboard shortcuts can be useful to save time, but can be activated accidentally or interfere with assistive technology.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Third-party systems can be observability systems, change management systems, cod

Use required reviewers to require a specific person or team to approve workflow jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

{% ifversion deployments-prevent-self-approval %}You also have the option to prevent self-reviews for deployments to protected environments. If you enable this setting, users who initiate a deployment cannot approve the deployment job, even if they are a required reviewer. This ensures that deployments to protected environments are always reviewed by more than one person.{% endif %}
You also have the option to prevent self-reviews for deployments to protected environments. If you enable this setting, users who initiate a deployment cannot approve the deployment job, even if they are a required reviewer. This ensures that deployments to protected environments are always reviewed by more than one person.

For more information on reviewing jobs that reference an environment with required reviewers, see [AUTOTITLE](/actions/managing-workflow-runs/reviewing-deployments).

Expand Down Expand Up @@ -82,12 +82,11 @@ Use deployment branches{% ifversion deployment-protections-tag-patterns %} and t
{%- else %}
* **All branches:** All branches in the repository can deploy to the environment.
{%- endif %}
* **Protected branches{% ifversion deployment-protections-tag-patterns %} only{% endif %}:** Only branches with branch protection rules enabled can deploy to the environment. If no branch protection rules are defined for any branch in the repository, then all branches can deploy. For more information about branch protection rules, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches).{% ifversion actions-protected-branches-restrictions %}
* **Protected branches{% ifversion deployment-protections-tag-patterns %} only{% endif %}:** Only branches with branch protection rules enabled can deploy to the environment. If no branch protection rules are defined for any branch in the repository, then all branches can deploy. For more information about branch protection rules, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches).

> [!NOTE]
> Deployment workflow runs triggered by tags with the same name as a protected branch and forks with branches that match the protected branch name cannot deploy to the environment.

{% endif %}
* **Selected branches{% ifversion deployment-protections-tag-patterns %} and tags{% endif %}:** Only branches{% ifversion deployment-protections-tag-patterns %} and tags{% endif %} that match your specified name patterns can deploy to the environment.

If you specify `releases/*` as a deployment branch{% ifversion deployment-protections-tag-patterns %} or tag{% endif %} rule, only a branch{% ifversion deployment-protections-tag-patterns %} or tag{% endif %} whose name begins with `releases/` can deploy to the environment. (Wildcard characters will not match `/`. To match branches{% ifversion deployment-protections-tag-patterns %} or tags{% endif %} that begin with `release/` and contain an additional single slash, use `release/*/*`.) If you add `main` as a branch rule, a branch named `main` can also deploy to the environment. For more information about syntax options for deployment branches, see the [Ruby `File.fnmatch` documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).
Expand Down Expand Up @@ -180,7 +179,7 @@ Variables stored in an environment are only available to workflow jobs that refe
1. Optionally, specify people or teams that must approve workflow jobs that use this environment. For more information, see [Required reviewers](#required-reviewers).
1. Select **Required reviewers**.
1. Enter up to 6 people or teams. Only one of the required reviewers needs to approve the job for it to proceed.
{% ifversion deployments-prevent-self-approval %}1. Optionally, to prevent users from approving workflows runs that they triggered, select **Prevent self-review**.{% endif %}
1. Optionally, to prevent users from approving workflows runs that they triggered, select **Prevent self-review**.
1. Click **Save protection rules**.
1. Optionally, specify the amount of time to wait before allowing workflow jobs that use this environment to proceed. For more information, see [Wait timer](#wait-timer).
1. Select **Wait timer**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,9 @@ For more information about environments and required approvals, see [AUTOTITLE](
* To approve the job, click **Approve and deploy**. Once a job is approved (and any other deployment protection rules have passed), the job will proceed. At this point, the job can access any secrets stored in the environment.
* To reject the job, click **Reject**. If a job is rejected, the workflow will fail.

{% ifversion deployments-prevent-self-approval %}

> [!NOTE]
> If the targeted environment is configured to prevent self-approvals for deployments, you will not be able to approve a deployment from a workflow run you initiated. For more information, see [AUTOTITLE](/actions/deployment/targeting-different-environments/managing-environments-for-deployment#required-reviewers).
{% endif %}

## Bypassing deployment protection rules

If you have configured deployment protection rules that control whether software can be deployed to an environment, you can bypass these rules and force all pending jobs referencing the environment to proceed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ redirect_from:
- /actions/deployment/viewing-deployment-history
- /actions/deployment/managing-your-deployments/viewing-deployment-history
---
{% ifversion actions-deployment-history-beta %}

## About deployment history

Expand Down Expand Up @@ -49,17 +48,3 @@ By default, the deployments page shows currently active deployments from select
1. Depending on the qualifier you chose, fill out information in the "Operator" and "Value" columns.
1. Optionally, click **{% octicon "plus" aria-hidden="true" %} Add a filter** to add another filter.
1. Click **Apply**.{% endif %}

{% else %}

{% data reusables.actions.about-deployment-with-github-actions %}

To view current and past deployments, click **Environments** in the sidebar of the home page of your repository.

The deployments page displays the last active deployment of each environment for your repository. If the deployment includes an environment URL, a **View deployment** button that links to the URL is shown next to the deployment.

The activity log shows the deployment history for your environments. By default, only the most recent deployment for an environment has an `Active` status; all previously active deployments have an `Inactive` status. For more information on automatic inactivation of deployments, see [AUTOTITLE](/rest/deployments#inactive-deployments).

You can also use the REST API to get information about deployments. For more information, see [AUTOTITLE](/rest/repos#deployments).

{% endif %}
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Once you complete this project, you should understand how to build your own Java

Before you begin, you'll need to download Node.js and create a public {% data variables.product.prodname_dotcom %} repository.

1. Download and install Node.js {% ifversion actions-node20-support %}20.x{% else %}16.x{% endif %}, which includes npm.
1. Download and install Node.js 20.x, which includes npm.

https://nodejs.org/en/download/
1. Create a new public repository on {% data variables.product.github %} and call it "hello-world-javascript-action". For more information, see [AUTOTITLE](/repositories/creating-and-managing-repositories/creating-a-new-repository).
Expand Down Expand Up @@ -71,7 +71,7 @@ outputs:
time: # id of output
description: 'The time we greeted you'
runs:
using: {% ifversion actions-node20-support %}'node20'{% else %}'node16'{% endif %}
using: 'node20'
main: 'index.js'
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -150,19 +150,19 @@ For more information on how to use context syntax, see [AUTOTITLE](/actions/lear

**Required** Configures the path to the action's code and the runtime used to execute the code.

### Example: Using Node.js {% ifversion actions-node20-support %}v20{% else %}v16{% endif %}
### Example: Using Node.js v20

```yaml
runs:
using: {% ifversion actions-node20-support %}'node20'{% else %}'node16'{% endif %}
using: 'node20'
main: 'main.js'
```

### `runs.using` for JavaScript actions

**Required** The runtime used to execute the code specified in [`main`](#runsmain).

* Use {% ifversion actions-node20-support %}`node20` for Node.js v20{% else %}`node16` for Node.js v16{% endif %}.
* Use `node20` for Node.js v20.

### `runs.main`

Expand All @@ -176,7 +176,7 @@ In this example, the `pre:` action runs a script called `setup.js`:

```yaml
runs:
using: {% ifversion actions-node20-support %}'node20'{% else %}'node16'{% endif %}
using: 'node20'
pre: 'setup.js'
main: 'index.js'
post: 'cleanup.js'
Expand All @@ -203,7 +203,7 @@ In this example, the `post:` action runs a script called `cleanup.js`:

```yaml
runs:
using: {% ifversion actions-node20-support %}'node20'{% else %}'node16'{% endif %}
using: 'node20'
main: 'index.js'
post: 'cleanup.js'
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ jobs:
- name: Use Node.js
uses: {% data reusables.actions.action-setup-node %}
with:
node-version: {% ifversion actions-node20-support %}'20.x'{% else %}'18.x'{% endif %}
node-version: '20.x'
- run: npm ci
- run: npm run build --if-present
- run: npm test
Expand All @@ -162,7 +162,7 @@ steps:
- name: Use Node.js
uses: {% data reusables.actions.action-setup-node %}
with:
node-version: {% ifversion actions-node20-support %}'20.x'{% else %}'18.x'{% endif %}
node-version: '20.x'
- name: Install dependencies
run: npm ci
```
Expand All @@ -175,7 +175,7 @@ steps:
- name: Use Node.js
uses: {% data reusables.actions.action-setup-node %}
with:
node-version: {% ifversion actions-node20-support %}'20.x'{% else %}'18.x'{% endif %}
node-version: '20.x'
- name: Install dependencies
run: npm install
```
Expand All @@ -190,7 +190,7 @@ steps:
- name: Use Node.js
uses: {% data reusables.actions.action-setup-node %}
with:
node-version: {% ifversion actions-node20-support %}'20.x'{% else %}'18.x'{% endif %}
node-version: '20.x'
- name: Install dependencies
run: yarn --frozen-lockfile
```
Expand All @@ -203,7 +203,7 @@ steps:
- name: Use Node.js
uses: {% data reusables.actions.action-setup-node %}
with:
node-version: {% ifversion actions-node20-support %}'20.x'{% else %}'18.x'{% endif %}
node-version: '20.x'
- name: Install dependencies
run: yarn
```
Expand All @@ -225,7 +225,7 @@ steps:
uses: {% data reusables.actions.action-setup-node %}
with:
always-auth: true
node-version: {% ifversion actions-node20-support %}'20.x'{% else %}'18.x'{% endif %}
node-version: '20.x'
registry-url: https://registry.npmjs.org
scope: '@octocat'
- name: Install dependencies
Expand Down Expand Up @@ -253,7 +253,7 @@ steps:
- uses: {% data reusables.actions.action-checkout %}
- uses: {% data reusables.actions.action-setup-node %}
with:
node-version: {% ifversion actions-node20-support %}'20'{% else %}'18'{% endif %}
node-version: '20'
cache: 'npm'
- run: npm install
- run: npm test
Expand All @@ -266,7 +266,7 @@ steps:
- uses: {% data reusables.actions.action-checkout %}
- uses: {% data reusables.actions.action-setup-node %}
with:
node-version: {% ifversion actions-node20-support %}'20'{% else %}'18'{% endif %}
node-version: '20'
cache: 'yarn'
- run: yarn
- run: yarn test
Expand All @@ -286,7 +286,7 @@ steps:
version: 6.10.0
- uses: {% data reusables.actions.action-setup-node %}
with:
node-version: {% ifversion actions-node20-support %}'20'{% else %}'18'{% endif %}
node-version: '20'
cache: 'pnpm'
- run: pnpm install
- run: pnpm test
Expand All @@ -304,7 +304,7 @@ steps:
- name: Use Node.js
uses: {% data reusables.actions.action-setup-node %}
with:
node-version: {% ifversion actions-node20-support %}'20.x'{% else %}'18.x'{% endif %}
node-version: '20.x'
- run: npm install
- run: npm run build --if-present
- run: npm test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ jobs:
# Setup .npmrc file to publish to npm
- uses: {% data reusables.actions.action-setup-node %}
with:
node-version: {% ifversion actions-node20-support %}'20.x'{% else %}'16.x'{% endif %}
node-version: '20.x'
registry-url: 'https://registry.npmjs.org'
- run: npm ci
- run: npm publish {% ifversion artifact-attestations %}--provenance --access public{% endif %}
Expand Down Expand Up @@ -141,7 +141,7 @@ jobs:
# Setup .npmrc file to publish to GitHub Packages
- uses: {% data reusables.actions.action-setup-node %}
with:
node-version: {% ifversion actions-node20-support %}'20.x'{% else %}'16.x'{% endif %}
node-version: '20.x'
registry-url: 'https://npm.pkg.github.com'
# Defaults to the user or organization that owns the workflow file
scope: '@octocat'
Expand Down Expand Up @@ -176,7 +176,7 @@ jobs:
# Setup .npmrc file to publish to npm
- uses: {% data reusables.actions.action-setup-node %}
with:
node-version: {% ifversion actions-node20-support %}'20.x'{% else %}'16.x'{% endif %}
node-version: '20.x'
registry-url: 'https://registry.npmjs.org'
# Defaults to the user or organization that owns the workflow file
scope: '@octocat'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ shortTitle: Concurrency
intro: Run a single job at a time.
versions:
fpt: '*'
ghes: '> 3.1'
ghes: '*'
ghec: '*'
redirect_from:
- /actions/using-jobs/using-concurrency
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,12 @@ shortTitle: Permissions for `GITHUB_TOKEN`
intro: Modify the default permissions granted to `GITHUB_TOKEN`.
versions:
fpt: '*'
ghes: '> 3.1'
ghes: '*'
ghec: '*'
redirect_from:
- /actions/using-jobs/assigning-permissions-to-jobs
- >-
/actions/writing-workflows/choosing-what-your-workflow-does/assigning-permissions-to-jobs
- >-
/actions/writing-workflows/choosing-what-your-workflow-does/controlling-permissions-for-github-token
- /actions/writing-workflows/choosing-what-your-workflow-does/assigning-permissions-to-jobs
- /actions/writing-workflows/choosing-what-your-workflow-does/controlling-permissions-for-github-token
---

{% data reusables.actions.enterprise-github-hosted-runners %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ shortTitle: Environments
intro: Specify a deployment environment in your workflow.
versions:
fpt: '*'
ghes: '> 3.0'
ghes: '*'
ghec: '*'
redirect_from:
- /actions/using-jobs/using-environments-for-jobs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -649,13 +649,9 @@ You can make an environment variable available to any subsequent steps in a work

{% data reusables.actions.environment-variables-are-fixed %} For more information about the default environment variables, see [AUTOTITLE](/actions/learn-github-actions/environment-variables#default-environment-variables).

{% ifversion github-env-node-options %}

> [!NOTE]
> Due to security restrictions, `GITHUB_ENV` cannot be used to set the `NODE_OPTIONS` environment variable.

{% endif %}

### Example of writing an environment variable to `GITHUB_ENV`

{% bash %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -543,7 +543,6 @@ This utility returns webhook delivery logs for administrators to review and iden
ghe-webhook-logs
```

{% ifversion ghes > 3.10 %}
To show all hook deliveries filtered by a given event:

```shell
Expand All @@ -554,7 +553,6 @@ To show all hook deliveries filtered by a given event and action:

```shell
ghe-webhook-logs --event issues.opened
{% endif %}
To show all failed hook deliveries in the past day:

```shell
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
title: Configuring host keys for your instance
shortTitle: Configure host keys
intro: 'You can increase the security of {% data variables.location.product_location %} by configuring the algorithms that your instance uses to generate and advertise host keys for incoming SSH connections.'
permissions: 'Site administrators'
permissions: Site administrators
redirect_from:
- /admin/configuration/configuring-your-enterprise/configuring-host-keys-for-your-instance
- /admin/configuration/hardening-security-for-your-enterprise/configuring-host-keys-for-your-instance
versions:
ghes: '>= 3.6'
ghes: '*'
type: how_to
topics:
- Authentication
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
title: Configuring SSH connections to your instance
shortTitle: Configure SSH connections
intro: 'You can increase the security of {% data variables.location.product_location %} by configuring the SSH algorithms that clients can use to establish a connection.'
permissions: 'Site administrators'
permissions: Site administrators
redirect_from:
- /admin/configuration/configuring-your-enterprise/configuring-ssh-connections-to-your-instance
- /admin/configuration/hardening-security-for-your-enterprise/configuring-ssh-connections-to-your-instance
versions:
ghes: '>= 3.6'
ghes: '*'
type: how_to
topics:
- Authentication
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ redirect_from:
- /admin/github-actions/enabling-github-actions-for-github-enterprise-server/managing-self-hosted-runners-for-dependabot-updates
allowTitleToDifferFromFilename: true
versions:
ghes: '> 3.2'
ghes: '*'
topics:
- Enterprise
- Security
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Enabling encrypted assertions
shortTitle: Enable encrypted assertions
intro: 'You can improve {% data variables.location.product_location %}''s security with SAML single sign-on (SSO) by encrypting the messages that your SAML identity provider (IdP) sends.'
permissions: 'Site administrators'
permissions: Site administrators
versions:
ghes: '> 3.3'
ghes: '*'
type: how_to
topics:
- Accounts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,6 @@ If you're interested in creating an app for {% data variables.product.prodname_m

### {% data variables.product.prodname_copilot_extensions %}

{% data reusables.copilot.copilot-extensions.public-preview-note %}

{% data reusables.copilot.copilot-extensions.copilot-extensions-intro %}

To learn more about {% data variables.product.prodname_copilot_extensions_short %}, see [AUTOTITLE](/copilot/github-copilot-chat/github-copilot-extensions/using-github-copilot-extensions).
Expand Down
Loading