Document Actions Runner version for each GHES release (#50316)

ageorgou · Apr 30, 2024 · 2c199c2 · 2c199c2
1 parent 845cd81
commit 2c199c2
Show file tree

Hide file tree

Showing 9 changed files with 43 additions and 1 deletion.
diff --git a/content/admin/all-releases.md b/content/admin/all-releases.md
@@ -45,3 +45,27 @@ For more information about the latest release, see the [{% data variables.produc
 {%- for version in enterpriseServerReleases.deprecatedReleasesOnDeveloperSite %}
 | {{version}} | {{enterpriseServerReleases.dates[version].releaseDate}} | {{enterpriseServerReleases.dates[version].deprecationDate}} | [{{version}} developer documentation](https://developer.github.com/enterprise/{{version}}) |
 {%- endfor %}
+
+## Recommended {% data variables.product.prodname_codeql_cli %} versions for code scanning
+
+For instances with a {% data variables.product.prodname_GH_advanced_security %} license and code scanning enabled, the {% data variables.product.prodname_codeql %} action for code scanning analysis uses a minimum recommended version of the {% data variables.product.prodname_codeql_cli %} by default. We recommend that you use the same version of the {% data variables.product.prodname_codeql_cli %} if you run analysis in an external CI system. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance)."
+
+| {% data variables.product.product_name %} version | Recommended {% data variables.product.prodname_codeql_cli %} version |
+| ------------------------------------------------- | ---------------------- |
+| 3.12 | 2.15.5 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.15.5/)) |
+| 3.11 | 2.14.6 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.14.6/)) |
+| 3.10 | 2.13.5 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.13.5/)) |
+| 3.9  | 2.12.7 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.12.7/)) |
+
+## Minimum {% data variables.product.prodname_actions %} Runner application versions
+
+For instances with {% data variables.product.prodname_actions %} enabled, self-hosted {% data variables.product.prodname_actions %} runners must run a minimum required version of the {% data variables.product.prodname_actions %} Runner application.
+
+For most instances, the Runner application is updated automatically. If your instance uses ephemeral self-hosted runners and you've disabled automatic updates, you must upgrade your runners to the required version of the Runner application before upgrading your instance to a new {% data variables.product.prodname_ghe_server %} release. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#requirements-for-self-hosted-runner-machines)."
+
+| {% data variables.product.product_name %} version | Minimum Runner version |
+| ------------------------------------------------- | ---------------------- |
+| 3.12 | 2.311.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.311.0)) |
+| 3.11 | 2.309.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.309.0)) |
+| 3.10 | 2.304.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.304.0)) |
+| 3.9  | 2.303.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.303.0)) |
diff --git a/...he-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md b/...he-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md
@@ -48,7 +48,7 @@ To prepare for an upgrade, plan the upgrade path, optionally upgrade {% data var
 
    {% endnote %}
 
-1. If {% data variables.location.product_location %} uses ephemeral self-hosted runners for {% data variables.product.prodname_actions %} and you've disabled automatic updates, upgrade your runners to the version of the runner application that your upgraded instance will run.
+1. If {% data variables.location.product_location %} uses ephemeral self-hosted runners for {% data variables.product.prodname_actions %} and you've disabled automatic updates, upgrade your runners to the version of the runner application that your upgraded instance will run. To find the minimum required version for your release, see "[AUTOTITLE](/admin/all-releases#minimum-github-actions-runner-application-versions)."
 1. If you are upgrading using an upgrade package, schedule a maintenance window for {% data variables.product.prodname_ghe_server %} end users. If you are using a hotpatch, maintenance mode is not required.
 
    {% note %}

diff --git a/data/release-notes/PLACEHOLDER-TEMPLATE.yml b/data/release-notes/PLACEHOLDER-TEMPLATE.yml
@@ -84,6 +84,9 @@ sections:
 
     - heading: GitHub Actions
       notes:
+        # Required Actions Runner version
+        - |
+          {% data reusables.actions.actions-runner-release-note %}
         # LINK TO RELEASE ISSUE
         - |
           ...

diff --git a/data/release-notes/enterprise-server/3-10/0.yml b/data/release-notes/enterprise-server/3-10/0.yml
@@ -121,6 +121,9 @@ sections:
 
     - heading: GitHub Actions
       notes:
+        # Required Actions Runner version
+        - |
+          {% data reusables.actions.actions-runner-release-note %} [Updated: 2024-04-25]
         # https://github.com/github/releases/issues/3136
         - |
           Organization owners can increase instance security by preventing members from creating self-hosted runners at the repository level. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)."

diff --git a/data/release-notes/enterprise-server/3-11/0.yml b/data/release-notes/enterprise-server/3-11/0.yml
@@ -145,6 +145,9 @@ sections:
 
     - heading: GitHub Actions
       notes:
+        # Required Actions Runner version
+        - |
+          {% data reusables.actions.actions-runner-release-note %} [Updated: 2024-04-25]
         # https://github.com/github/releases/issues/3247
         - |
           To better navigate, trace, understand, and monitor deployments, users can view and track the full history of deployments in a repository or filter across environments. For more information, see "[AUTOTITLE](/actions/deployment/managing-your-deployments/viewing-deployment-history)."

diff --git a/data/release-notes/enterprise-server/3-12/0.yml b/data/release-notes/enterprise-server/3-12/0.yml
@@ -78,6 +78,9 @@ sections:
 
     - heading: GitHub Actions
       notes:
+        # Required Actions Runner version
+        - |
+          {% data reusables.actions.actions-runner-release-note %} [Updated: 2024-04-25]
         # https://github.com/github/releases/issues/3227
         - |
           Users can set up organization-wide rules to enforce their CI/CD workflows, ensuring workflows pass before pull requests can be merged into target repositories. You can fine-tune your rule by selecting a specific branch, tag, or SHA, and provide maximum control over the version expected to run. To reduce risk, you can "evaluate" workflow rules to validate rules are working correctly. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#require-workflows-to-pass-before-merging)".

diff --git a/data/release-notes/enterprise-server/3-9/0.yml b/data/release-notes/enterprise-server/3-9/0.yml
@@ -146,6 +146,9 @@ sections:
 
     - heading: GitHub Actions
       notes:
+        # Required Actions Runner version
+        - |
+          {% data reusables.actions.actions-runner-release-note %} [Updated: 2024-04-25]
         # https://github.com/github/releases/issues/3006
         - |
           On instances in a cluster configuration, GitHub Actions is available as a private beta. Beta features are subject to change. For more information, and to enroll in the beta, [contact your representative on GitHub's Sales team](https://github.com/enterprise/contact).

diff --git a/data/reusables/actions/actions-runner-release-note.md b/data/reusables/actions/actions-runner-release-note.md
@@ -0,0 +1 @@
+For self-hosted {% data variables.product.prodname_actions %} runners on this {% data variables.product.prodname_ghe_server %} release, the minimum required version of the {% data variables.product.prodname_actions %} Runner application is {% data variables.product.runner_controller_required_version %}. See the release notes for this version in the [`actions/runner` repository](https://github.com/actions/runner/releases/tag/v{% data variables.product.runner_controller_required_version %}) on {% data variables.product.prodname_dotcom_the_website %}. If your instance uses ephemeral self-hosted runners and you've disabled automatic updates, you must upgrade your runners to this version of the Runner application before upgrading your instance to this {% data variables.product.prodname_ghe_server %} release.
diff --git a/data/variables/product.yml b/data/variables/product.yml
@@ -136,6 +136,8 @@ prodname_unfurls: 'Content Attachments'
 ## Use this variable only when referring to GitHub Actions the product. When referring to the thing that someone creates using the product, call it an action (small a). See the terminology page of the Brand Guide for more.
 prodname_actions: 'GitHub Actions'
 prodname_actions_runner_controller: 'Actions Runner Controller'
+runner_controller_required_version: >-
+  {% ifversion ghes < 3.10 %}2.303.0{% elsif ghes < 3.11 %}2.304.0{% elsif ghes < 3.12 %}2.309.0{% elsif ghes < 3.13 %}2.311.0{% elsif ghes < 3.14 %}2.314.1{% endif %}
 
 # GitHub Debug
 prodname_debug: 'GitHub Debug'
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		For self-hosted {% data variables.product.prodname_actions %} runners on this {% data variables.product.prodname_ghe_server %} release, the minimum required version of the {% data variables.product.prodname_actions %} Runner application is {% data variables.product.runner_controller_required_version %}. See the release notes for this version in the [`actions/runner` repository](https://github.com/actions/runner/releases/tag/v{% data variables.product.runner_controller_required_version %}) on {% data variables.product.prodname_dotcom_the_website %}. If your instance uses ephemeral self-hosted runners and you've disabled automatic updates, you must upgrade your runners to this version of the Runner application before upgrading your instance to this {% data variables.product.prodname_ghe_server %} release.