Skip to content

Commit 6cf4057

Browse files
Merge branch 'main' into patch-1
2 parents fbaabd2 + 424c467 commit 6cf4057

85 files changed

Lines changed: 1141 additions & 698 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.

CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# Docs changelog
22

3+
**23 September 2025**
4+
5+
We've added new documentation for Spark that answers some common customer questions, helps customers troubleshoot known issues, and guides users on the best ways to prompt and provide context to Spark.
6+
7+
See:
8+
- "[About GitHub Spark](https://docs.github.com/en/copilot/concepts/spark)"
9+
- "[Troubleshooting common issues with GitHub Spark](https://docs.github.com/en/copilot/how-tos/troubleshoot-copilot/troubleshoot-spark)"
10+
- "[Write effective prompts and provide useful context for Spark](https://docs.github.com/en/copilot/tutorials/spark/prompt-tips)"
11+
12+
<hr>
13+
314
**17 September 2025**
415

516
We added documentation for expanded features for reusing workflow configurations in GitHub Actions.
162 KB
Loading

content/admin/installing-your-enterprise-server/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance.md

Lines changed: 29 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,9 @@ If you want to test changes on an instance that contains the same data and confi
5757
5858
### 2. Set up a staging instance
5959

60-
Set up a new instance to act as your staging environment. You can use the same guides for provisioning and installing your staging instance as you did for your production instance. For more information, see [AUTOTITLE](/admin/installation/setting-up-a-github-enterprise-server-instance).
60+
Set up a new instance to act as your staging environment. When following the setup process, be sure to select the **New Install** option. This will ensure your staging environment is initialized properly and is ready for restoring a backup if needed.
61+
62+
You can use the same guides for provisioning and installing your staging instance as you did for your production instance. For more information, see [AUTOTITLE](/admin/installation/setting-up-a-github-enterprise-server-instance).
6163

6264
If you plan to restore a backup of your production instance, continue to the next step. Alternatively, you can configure the instance manually and skip the following steps.
6365

@@ -66,62 +68,43 @@ If you plan to restore a backup of your production instance, continue to the nex
6668
6769
### 3. Configure {% data variables.product.prodname_actions %}
6870

69-
Optionally, if you use {% data variables.product.prodname_actions %} on your production instance, configure the feature on the staging instance before restoring your production backup. If you don't use {% data variables.product.prodname_actions %}, skip to [1. Configure {% data variables.product.prodname_registry %}](#4-configure-github-packages).
71+
Optionally, if you use {% data variables.product.prodname_actions %} on your production instance, configure the feature on the staging instance before restoring your production backup. If you don't use {% data variables.product.prodname_actions %}, skip to [Configure {% data variables.product.prodname_registry %}](#4-configure-github-packages).
72+
73+
To configure {% data variables.product.prodname_actions %} on your staging instance, use the {% data variables.enterprise.management_console %}.
74+
75+
The {% data variables.enterprise.management_console %} provides a secure, browser-based interface for low-level configuration of your {% data variables.product.prodname_ghe_server %} instance, including {% data variables.product.prodname_actions %}. All configuration changes are audited, and access is protected via dedicated credentials and network controls.
7076

7177
> [!WARNING]
7278
> If you don't configure {% data variables.product.prodname_actions %} on the staging instance before restoring your production backup, your staging instance will use your production instance's external storage, which could result in loss of data. We strongly recommended that you use different external storage for your staging instance. For more information, see [AUTOTITLE](/admin/github-actions/advanced-configuration-and-troubleshooting/using-a-staging-environment).
7379
74-
{% data reusables.enterprise_installation.ssh-into-staging-instance %}
75-
1. To configure the staging instance to use an external storage provider for {% data variables.product.prodname_actions %}, enter one of the following commands.
76-
{% data reusables.actions.configure-storage-provider-platform-commands %}
77-
{% data reusables.actions.configure-storage-provider %}
78-
1. To prepare to enable {% data variables.product.prodname_actions %} on the staging instance, enter the following command.
79-
80-
```shell copy
81-
ghe-config app.actions.enabled true
82-
```
80+
1. Access the {% data variables.enterprise.management_console %}. See [AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-web-ui/accessing-the-management-console).
8381

84-
1. To apply the configuration changes, enter the following command.
82+
1. In the sidebar, open the **Actions** tab.
83+
1. Enable {% data variables.product.prodname_actions %} by checking **Enable {% data variables.product.prodname_actions %}**.
84+
1. Select your external storage provider for artifact and log storage.
85+
1. Enter the required storage and authentication details for your chosen provider.
86+
1. Test your configuration by clicking **Test storage settings**, then click **Save settings**.
8587

86-
```shell copy
87-
ghe-config-apply
88-
```
88+
Once you've configured and enabled {% data variables.product.prodname_actions %}, proceed to the next step.
8989

9090
### 4. Configure {% data variables.product.prodname_registry %}
9191

92-
Optionally, if you use {% data variables.product.prodname_registry %} on your production instance, configure the feature on the staging instance before restoring your production backup. If you don't use {% data variables.product.prodname_registry %}, skip to [1. Restore your production backup](#5-restore-your-production-backup).
92+
Optionally, if you use {% data variables.product.prodname_registry %} on your production instance, configure the feature on the staging instance before restoring your production backup. If you don't use {% data variables.product.prodname_registry %}, skip to [Restore your production backup](#5-restore-your-production-backup).
9393

9494
> [!WARNING]
95-
> If you don't configure {% data variables.product.prodname_registry %} on the staging instance before restoring your production backup, your staging instance will use your production instance's external storage, which could result in loss of data. We strongly recommended that you use different external storage for your staging instance.
96-
97-
1. Review the backup you will restore to the staging instance.
98-
* If you took the backup with {% data variables.product.prodname_enterprise_backup_utilities %} 3.5 or later, the backup includes the configuration for {% data variables.product.prodname_registry %}. Continue to the next step.
99-
* If you took the backup with {% data variables.product.prodname_enterprise_backup_utilities %} 3.4 or earlier, configure {% data variables.product.prodname_registry %} on the staging instance. For more information, see [AUTOTITLE](/admin/packages/getting-started-with-github-packages-for-your-enterprise).
100-
{% data reusables.enterprise_installation.ssh-into-staging-instance %}
101-
1. Configure the external storage connection by entering the following commands, replacing the placeholder values with actual values for your connection.
102-
* Azure Blob Storage:
103-
104-
```shell copy
105-
ghe-config secrets.packages.blob-storage-type "azure"
106-
ghe-config secrets.packages.azure-container-name "AZURE CONTAINER NAME"
107-
ghe-config secrets.packages.azure-connection-string "CONNECTION STRING"
108-
```
109-
110-
* Amazon S3:
111-
112-
```shell copy
113-
ghe-config secrets.packages.blob-storage-type "s3"
114-
ghe-config secrets.packages.service-url "S3 SERVICE URL"
115-
ghe-config secrets.packages.s3-bucket "S3 BUCKET NAME"
116-
ghe-config secrets.packages.aws-access-key "S3 ACCESS KEY ID"
117-
ghe-config secrets.packages.aws-secret-key "S3 ACCESS SECRET"
118-
```
119-
120-
1. To prepare to enable {% data variables.product.prodname_registry %} on the staging instance, enter the following command.
121-
122-
```shell copy
123-
ghe-config app.packages.enabled true
124-
```
95+
> If you don't configure {% data variables.product.prodname_registry %} on the staging instance before restoring your production backup, your staging instance will use your production instance's external storage, which could result in loss of data. We strongly recommended that you use different external storage for your staging instance. For more information, see [AUTOTITLE](/admin/github-actions/advanced-configuration-and-troubleshooting/using-a-staging-environment).
96+
97+
To configure {% data variables.product.prodname_registry %} for your staging instance:
98+
99+
1. Access the {% data variables.enterprise.management_console %}. See [Accessing the Management Console](/admin/administering-your-instance/administering-your-instance-from-the-web-ui/accessing-the-management-console).
100+
1. In the sidebar, open the **Packages** tab.
101+
1. Enable GitHub Packages by checking the **Enable GitHub Packages** box.
102+
1. Under **Packages Storage Settings**, select your external storage provider.
103+
1. Test your storage configuration by clicking **Test storage settings**.
104+
1. Click **Save settings** to apply your configuration.
105+
106+
> [!NOTE]
107+
> You can use ecosystem toggles to enable, disable, or set individual package types to read-only for your instance as needed.
125108
126109
### 5. Restore your production backup
127110

content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ topics:
2525

2626
SARIF (Static Analysis Results Interchange Format) is an [OASIS Standard](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html) that defines an output file format. The SARIF standard is used to streamline how static analysis tools share their results. {% data variables.product.prodname_code_scanning_caps %} supports a subset of the SARIF 2.1.0 JSON schema.
2727

28-
To upload a SARIF file from a third-party static code analysis engine, you'll need to ensure that uploaded files use the SARIF 2.1.0 version. {% data variables.product.prodname_dotcom %} will parse the SARIF file and show alerts using the results in your repository as a part of the {% data variables.product.prodname_code_scanning %} experience. For more information, see [AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github). For more information about the SARIF 2.1.0 JSON schema, see [`sarif-schema-2.1.0.json`](https://github.com/oasis-tcs/sarif-spec/blob/123e95847b13fbdd4cbe2120fa5e33355d4a042b/Schemata/sarif-schema-2.1.0.json).
28+
To upload a SARIF file from a third-party static code analysis engine, you'll need to ensure that uploaded files use the SARIF 2.1.0 version. {% data variables.product.prodname_dotcom %} will parse the SARIF file and show alerts using the results in your repository as a part of the {% data variables.product.prodname_code_scanning %} experience. For more information, see [AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github). For more information about the SARIF 2.1.0 JSON schema, see [`sarif-schema-2.1.0.json`](https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/schemas/sarif-schema-2.1.0.json).
2929

3030
If you're using {% data variables.product.prodname_actions %} with the {% data variables.code-scanning.codeql_workflow %} or using the {% data variables.product.prodname_codeql_cli %}, then the {% data variables.product.prodname_code_scanning %} results will automatically use the supported subset of SARIF 2.1.0. For more information, see [AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning) or [AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/using-code-scanning-with-your-existing-ci-system).
3131

content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/sarif-output.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ considered "optional". This document details the output produced when using the
2323

2424
## SARIF specification and schema
2525

26-
This article is intended to be read alongside the detailed SARIF specification. For more information on the specification and the SARIF schema, see the [SARIF specification documentation](https://github.com/oasis-tcs/sarif-spec/blob/123e95847b13fbdd4cbe2120fa5e33355d4a042b/Schemata/sarif-schema-2.1.0.json).
26+
This article is intended to be read alongside the detailed SARIF specification. For more information on the specification and the SARIF schema, see the [SARIF specification documentation](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html).
2727

2828
## Change notes
2929

@@ -53,7 +53,7 @@ This details each SARIF component that may be generated, along with any specific
5353

5454
| JSON property name| Always generated?| Notes|
5555
|-------------------|------------------------|---------|
56-
| `$schema`| {% octicon "check" aria-label="Always" %}| Provides a link to the [SARIF schema](https://github.com/oasis-tcs/sarif-spec/blob/123e95847b13fbdd4cbe2120fa5e33355d4a042b/Schemata/sarif-schema-2.1.0.json).|
56+
| `$schema`| {% octicon "check" aria-label="Always" %}| Provides a link to the [SARIF schema](https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/schemas/sarif-schema-2.1.0.json).|
5757
| `version`| {% octicon "check" aria-label="Always" %}| The version of the SARIF used to generate the output.|
5858
| `runs`| {% octicon "check" aria-label="Always" %}| An array containing a single run object, for one language.|
5959

content/code-security/dependabot/working-with-dependabot/dependabot-options-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -782,7 +782,7 @@ When `versioning-strategy` is defined, {% data variables.product.prodname_depend
782782
|--------|--------|
783783
| `auto` | Default behavior.|
784784
| `increase`| Always increase the minimum version requirement to match the new version. If a range already exists, typically this only increases the lower bound. |
785-
| `increase-if-necessary` | Leave the constraint if the original constraint allows the new version, otherwise, bump the constraint. |
785+
| `increase-if-necessary` | Leave the version requirement unchanged if it already allows the new release (Dependabot still updates the resolved version). Otherwise widen the requirement. |
786786
| `lockfile-only` | Only create pull requests to update lockfiles. Ignore any new versions that would require package manifest changes. |
787787
| `widen`| Widen the allowed version requirements to include both the new and old versions, when possible. Typically, this only increases the maximum allowed version requirement. |
788788

content/contributing/style-guide-and-content-model/style-guide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1440,29 +1440,29 @@ The following example shows part of a table from [AUTOTITLE](/code-security/depe
14401440
<td align=center>
14411441
{% octicon "check" aria-label="Supported" %}
14421442
</td>
1443-
</td>
1443+
14441444
<td align=center>
14451445
{% octicon "x" aria-label="Not supported" %}
14461446
</td>
14471447
<td align=center>
14481448
{% octicon "check" aria-label="Supported" %}
14491449
</td>
1450-
</td>
1450+
14511451
<td align=left>Location of package manifests</td>
14521452
</tr>
14531453
<tr>
14541454
<td style="text-align:left"><code>schedule.interval</code></td>
14551455
<td align=center>
14561456
{% octicon "check" aria-label="Supported" %}
14571457
</td>
1458-
</td>
1458+
14591459
<td align=center>
14601460
{% octicon "x" aria-label="Not supported" %}
14611461
</td>
14621462
<td align=center>
14631463
{% octicon "check" aria-label="Supported" %}
14641464
</td>
1465-
</td>
1465+
14661466
<td align=left>How often to check for updates</td>
14671467
</tr>
14681468
</tbody>

0 commit comments

Comments
 (0)