Skip to content

Commit f5761bd

Browse files
Merge branch 'main' into issue-42851
2 parents 3f2e74c + 531d6dc commit f5761bd

204 files changed

Lines changed: 1385301 additions & 2613 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
-540 KB
Binary file not shown.

content/actions/how-tos/create-and-publish-actions/manage-custom-actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ To use a specific action version, users can configure their {% data variables.pr
5050

5151
### Using tags for release management
5252

53-
{% ifversion fpt or ghec %}
53+
{% ifversion immutable-releases %}
5454
> [!NOTE] If you have enabled immutable releases to help prevent supply chain attacks and accidental changes to your releases, instead see [AUTOTITLE](/actions/how-tos/create-and-publish-actions/using-immutable-releases-and-tags-to-manage-your-actions-releases).
5555
{% endif %}
5656

content/actions/how-tos/create-and-publish-actions/release-and-maintain-actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ To support the developer process in the next section, add two {% data variables.
5555
1. Add a workflow that triggers when a commit is pushed to a feature branch or to `main` or when a pull request is created. Configure the workflow to run your unit and integration tests. For an example, see [this workflow](https://github.com/actions/javascript-action/blob/main/.github/workflows/ci.yml).
5656
1. Add a workflow that triggers when a release is published or edited. Configure the workflow to ensure semantic tags are in place. You can use an action like [JasonEtco/build-and-tag-action](https://github.com/JasonEtco/build-and-tag-action) to compile and bundle the JavaScript and metadata file and force push semantic major, minor, and patch tags. For more information about semantic tags, see [About semantic versioning](https://docs.npmjs.com/about-semantic-versioning).
5757

58-
{% ifversion fpt or ghec %}
58+
{% ifversion immutable-releases %}
5959
> [!NOTE]
6060
> If you enable immutable releases for your repository, you cannot use this action to force push tags tied to releases on {% data variables.product.github %}. To learn how to manage your releases with immutable releases, see [AUTOTITLE](/actions/how-tos/create-and-publish-actions/using-immutable-releases-and-tags-to-manage-your-actions-releases).
6161
{% endif %}

content/actions/how-tos/create-and-publish-actions/using-immutable-releases-and-tags-to-manage-your-actions-releases.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@ title: Using immutable releases and tags to manage your action's releases
33
shortTitle: Use immutable releases
44
intro: 'Learn how you can use a combination of immutable releases on {% data variables.product.github %} and Git tags to manage your action''s releases.'
55
versions:
6-
fpt: '*'
7-
ghec: '*'
6+
feature: immutable-releases
87
topics:
98
- Actions
109
- Code Security

content/actions/how-tos/manage-runners/larger-runners/use-larger-runners.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,6 @@ Use the labels in the table below to run your workflows on the corresponding mac
4242

4343
{% data reusables.actions.larger-runners-table %}
4444

45-
> [!NOTE]
46-
> For macOS {% data variables.actions.hosted_runner %}s, the `-latest` runner label uses the macOS 12 runner image. For macOS Xlarge, the `-latest` runner label uses the macOS 13 runner image
47-
4845
{% endmac %}
4946

5047
{% ifversion repository-actions-runners %}

content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-with-reusable-workflows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ When combined with OpenID Connect (OIDC), reusable workflows let you enforce con
3838

3939
## How the token works with reusable workflows
4040

41-
During a workflow run, {% data variables.product.prodname_dotcom %}'s OIDC provider presents a OIDC token to the cloud provider which contains information about the job. If that job is part of a reusable workflow, the token will include the standard claims that contain information about the calling workflow, and will also include a custom claim called `job_workflow_ref` that contains information about the called workflow.
41+
During a workflow run, {% data variables.product.prodname_dotcom %}'s OIDC provider presents an OIDC token to the cloud provider which contains information about the job. If that job is part of a reusable workflow, the token will include the standard claims that contain information about the calling workflow, and will also include a custom claim called `job_workflow_ref` that contains information about the called workflow.
4242

4343
For example, the following OIDC token is for a job that was part of a called workflow. The `workflow`, `ref`, and other attributes describe the caller workflow, while `job_workflow_ref` refers to the called workflow:
4444

content/actions/how-tos/write-workflows/choose-what-workflows-do/use-variables.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ In addition to runner environment variables, {% data variables.product.prodname_
122122

123123
The `run` steps in a workflow, or in a referenced action, are processed by a runner. As a result, you can use runner environment variables here, using the appropriate syntax for the shell you are using on the runner - for example, `$NAME` for the bash shell on a Linux runner, or `$env:NAME` for PowerShell on a Windows runner. In most cases you can also use contexts, with the syntax {% raw %}`${{ CONTEXT.PROPERTY }}`{% endraw %}, to access the same value. The difference is that the context will be interpolated and replaced by a string before the job is sent to a runner.
124124

125-
However, you cannot use runner environment variables in parts of a workflow that are processed by {% data variables.product.prodname_actions %} and are not sent to the runner. Instead, you must use contexts. For example, an `if` conditional, which determines whether a job or step is sent to the runner, is always processed by {% data variables.product.prodname_actions %}. You must therefore use a context in an `if` conditional statement to access the value of an variable.
125+
However, you cannot use runner environment variables in parts of a workflow that are processed by {% data variables.product.prodname_actions %} and are not sent to the runner. Instead, you must use contexts. For example, an `if` conditional, which determines whether a job or step is sent to the runner, is always processed by {% data variables.product.prodname_actions %}. You must therefore use a context in an `if` conditional statement to access the value of a variable.
126126

127127
{% raw %}
128128

content/admin/all-releases.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ shortTitle: Releases
1414

1515
## Releases of {% data variables.product.prodname_ghe_server %}
1616

17-
{% data variables.product.company_short %} supports the **four** most recent feature releases.
17+
{% data variables.product.company_short %} supports at least the **four** most recent feature releases.
1818

1919
We provide documentation for both supported and unsupported versions of {% data variables.product.prodname_ghe_server %}. We do not maintain or update the documentation for unsupported versions.
2020

@@ -58,6 +58,7 @@ If you run analysis in an external CI system, we recommend using the same versio
5858

5959
| {% data variables.product.prodname_ghe_server %} version | Recommended {% data variables.product.prodname_codeql_cli %} version |
6060
| ------------------------------------------------- | ---------------------- |
61+
| 3.20 | 2.23.9 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.23.9/)) |
6162
| 3.19 | 2.22.4 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.22.4/)) |
6263
| 3.18 | 2.21.4 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.21.4/)) |
6364
| 3.17 | 2.20.7 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.20.7/)) |
@@ -79,6 +80,7 @@ For instances with {% data variables.product.prodname_actions %} enabled, self-h
7980

8081
| {% data variables.product.prodname_ghe_server %} version | Minimum Runner version |
8182
| ------------------------------------------------- | ---------------------- |
83+
| 3.20 | 2.330.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.330.0)) |
8284
| 3.19 | 2.328.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.328.0)) |
8385
| 3.18 | 2.324.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.324.0)) |
8486
| 3.17 | 2.322.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.322.0)) |

content/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/about-the-backup-service-for-github-enterprise-server.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ topics:
1212
- Infrastructure
1313
---
1414

15+
{% ifversion ghes < 3.20 %}
1516
>[!NOTE] {% data variables.product.prodname_enterprise_backup_service %} is currently in {% data variables.release-phases.public_preview %} and subject to change. The service is available at no additional cost and will remain free.
17+
{% endif %}
1618

1719
## About the {% data variables.product.prodname_enterprise_backup_service %}
1820

@@ -29,7 +31,9 @@ Compared to the legacy backup utilities, the {% data variables.product.prodname_
2931
* Doesn’t require a separate host for backup software.
3032
* Stores backups on a dedicated storage volume directly accessible by your instance.
3133

34+
{% ifversion ghes < 3.20 %}
3235
>[!NOTE] {% data variables.product.prodname_enterprise_backup_service %} is currently only supported on standalone instances and high availability primary nodes. Cluster configurations and replica nodes are not yet supported.
36+
{% endif %}
3337

3438
## How does the backup service differ from a High Availability replica?
3539

@@ -47,8 +51,7 @@ The backup service is a disaster recovery solution. It captures full, timestampe
4751

4852
## Further reading
4953

50-
* [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/configuring-backups-on-your-instance)
51-
* [About {% data variables.product.prodname_enterprise_backup_utilities %}](https://github.com/github/backup-utils#readme)
52-
* [AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh)
53-
* [AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)
54-
* [AUTOTITLE](/admin/github-actions/advanced-configuration-and-troubleshooting/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled)
54+
* [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/understanding-the-backup-service)
55+
* [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/configuring-the-backup-service)
56+
* [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/restoring-from-a-backup)
57+
* [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/restoring-with-github-actions-enabled)
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Backup from replica in high availability
3+
shortTitle: Backup from replica
4+
intro: 'Enable backup from a high availability replica node.'
5+
versions:
6+
ghes: '> 3.19'
7+
type: how_to
8+
topics:
9+
- Backups
10+
---
11+
12+
## Configuring backups from a replica node
13+
14+
For high availability, you can designate a replica node as your backup server. To minimize latency, {% data variables.product.github %} recommends picking a replica node in the same region or datacenter as your primary node.
15+
16+
> [!IMPORTANT]
17+
> Backups from cache replica nodes or active geo replica nodes are not supported.
18+
19+
To configure your backup server, run the following commands, replacing `HOSTNAME` with the hostname of the node:
20+
21+
```shell
22+
ghe-config cluster.HOSTNAME.backup-server true
23+
24+
ghe-config-apply
25+
```
26+
27+
You can now run `ghe-backup` directly on your replica node.
28+
29+
> [!WARNING]
30+
> Due to the latency between primary and replica nodes, you may lose data when backing up from a replica node.

0 commit comments

Comments
 (0)