Skip to content

Commit 5eb1b6f

Browse files
Merge branch 'main' into demographic
2 parents 0418dac + 0718f54 commit 5eb1b6f

File tree

53 files changed

+3071
-2720
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+3071
-2720
lines changed

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,8 @@ You can check which access policies are being applied to a secret in your organi
167167
> [!NOTE]
168168
> * {% data reusables.actions.forked-secrets %}
169169
> * Secrets are not automatically passed to reusable workflows. For more information, see [AUTOTITLE](/actions/using-workflows/reusing-workflows#passing-inputs-and-secrets-to-a-reusable-workflow).
170-
> {% data reusables.actions.about-oidc-short-overview %}
170+
> * Secrets are not available to workflows triggered by {% data variables.product.prodname_dependabot %} events. For more information, see [AUTOTITLE](/code-security/dependabot/troubleshooting-dependabot/troubleshooting-dependabot-on-github-actions#accessing-secrets).
171+
> * {% data reusables.actions.about-oidc-short-overview %}
171172
172173
> [!WARNING] Mask all sensitive information that is not a {% data variables.product.prodname_dotcom %} secret by using `::add-mask::VALUE`. This causes the value to be treated as a secret and redacted from logs.
173174

content/actions/tutorials/use-containerized-services/create-redis-service-containers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ This guide shows you workflow examples that configure a service container using
3535
You may also find it helpful to have a basic understanding of YAML, the syntax for {% data variables.product.prodname_actions %}, and Redis. For more information, see:
3636

3737
* [AUTOTITLE](/actions/learn-github-actions)
38-
* [Getting Started with Redis](https://redislabs.com/get-started-with-redis/) in the Redis documentation
38+
* [Getting Started with Redis](https://redis.io/learn/howtos/quick-start) in the Redis documentation
3939

4040
## Running jobs in containers
4141

content/admin/managing-iam/configuring-authentication-for-enterprise-managed-users/configuring-saml-single-sign-on-for-enterprise-managed-users.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,11 +108,14 @@ After the initial configuration of SAML SSO, the only setting you can update on
108108
{% data reusables.enterprise-accounts.identity-provider-tab %}
109109
{% data reusables.enterprise-accounts.sso-configuration %}
110110

111-
1. Under "SAML single sign-on", select **Add SAML configuration**.
111+
1. Under "SAML single sign-on," select **Add SAML configuration**.
112112
1. Under **Sign on URL**, type the HTTPS endpoint of your IdP for SSO requests that you noted while configuring your IdP.
113113
1. Under **Issuer**, type your SAML issuer URL that you noted while configuring your IdP, to verify the authenticity of sent messages.
114114
1. Under **Public Certificate**, paste the certificate that you noted while configuring your IdP, to verify SAML responses.
115-
1. Under **Public Certificate**, select the **Signature Method** and **Digest Method** dropdown menus, then click the hashing algorithm used by your SAML issuer.
115+
116+
> [!NOTE]
117+
> {% data variables.product.github %} does not enforce the expiration of this SAML IdP certificate. This means that even if this certificate expires, your SAML authentication will continue to work. However, if your IdP administrator regenerates the SAML certificate, and you don't update it on the {% data variables.product.github %} side, users will encounter a `digest mismatch` error during SAML authentication attempts due to the certificate mismatch. See [Error: Digest mismatch](/admin/managing-iam/using-saml-for-enterprise-iam/troubleshooting-saml-authentication#error-digest-mismatch).
118+
1. Under the same **Public Certificate** section, select the **Signature Method** and **Digest Method** dropdown menus, then click the hashing algorithm used by your SAML issuer.
116119
1. Before enabling SAML SSO for your enterprise, to ensure that the information you've entered is correct, click **Test SAML configuration**. {% data reusables.saml.test-must-succeed %}
117120
1. Click **Save SAML settings**.
118121

content/admin/managing-iam/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ For more detailed information about how to enable SAML using Okta, see [AUTOTITL
9292
{% data reusables.enterprise-accounts.access-enterprise %}
9393
{% data reusables.enterprise-accounts.settings-tab %}
9494
{% data reusables.enterprise-accounts.security-tab %}
95+
9596
1. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %}
9697
1. Under "SAML single sign-on", select **Require SAML authentication**.
9798
1. In the **Sign on URL** field, type the HTTPS endpoint of your IdP for single sign-on requests. This value is available in your IdP configuration.
@@ -101,6 +102,7 @@ For more detailed information about how to enable SAML using Okta, see [AUTOTITL
101102
To find the certificate, refer to the documentation for your IdP. Some IdPs call this an X.509 certificate.
102103

103104
{% data reusables.saml.edit-signature-and-digest-methods %}
105+
104106
1. Before enabling SAML SSO for your enterprise, to ensure that the information you've entered is correct, click **Test SAML configuration** . {% data reusables.saml.test-must-succeed %}
105107
1. Click **Save**.
106108
{% data reusables.enterprise-accounts.download-recovery-codes %}
@@ -117,6 +119,7 @@ You can enable or disable SAML authentication for {% data variables.location.pro
117119
{% data reusables.enterprise_site_admin_settings.access-settings %}
118120
{% data reusables.enterprise_site_admin_settings.management-console %}
119121
{% data reusables.enterprise_management_console.authentication %}
122+
120123
1. Under "Authentication", select **SAML**.
121124
1. {% data reusables.enterprise_user_management.built-in-authentication-option %}
122125
1. Optionally, to enable unsolicited response SSO, select **IdP initiated SSO**. By default, {% data variables.product.prodname_ghe_server %} will reply to an unsolicited Identity Provider (IdP) initiated request with an `AuthnRequest` back to the IdP.
@@ -129,18 +132,23 @@ You can enable or disable SAML authentication for {% data variables.location.pro
129132

130133
You must ensure that your IdP supports encrypted assertions and that the encryption and key transport methods in the management console match the values configured on your IdP. You must also provide {% data variables.location.product_location %}'s public certificate to your IdP. For more information, see [AUTOTITLE](/admin/identity-and-access-management/using-saml-for-enterprise-iam/enabling-encrypted-assertions).
131134

132-
1. Under "Single sign-on URL," type the HTTP or HTTPS endpoint on your IdP for single sign-on requests. This value is provided by your IdP configuration. If the host is only available from your internal network, you may need to [configure {% data variables.location.product_location %} to use internal nameservers](/admin/configuration/configuring-network-settings/configuring-dns-nameservers).
135+
1. In the **Single sign-on URL** field, type the HTTP or HTTPS endpoint on your IdP for single sign-on requests. This value is provided by your IdP configuration. If the host is only available from your internal network, you may need to [configure {% data variables.location.product_location %} to use internal nameservers](/admin/configuration/configuring-network-settings/configuring-dns-nameservers).
133136
1. Optionally, in the **Issuer** field, type your SAML issuer's name. This verifies the authenticity of messages sent to {% data variables.location.product_location %}.
134137
1. Select the **Signature Method** and **Digest Method** dropdown menus, then click the hashing algorithm used by your SAML issuer to verify the integrity of the requests from {% data variables.location.product_location %}.
135138
1. Select the **Name Identifier Format** dropdown menu, then click a format.
136-
1. Under "Verification certificate," click **Choose File**, then choose a certificate to validate SAML responses from the IdP.
139+
1. Under "Verification certificate", click **Choose File**, then choose a certificate to validate SAML responses from the IdP.
140+
141+
> [!NOTE]
142+
> {% data variables.product.github %} does not enforce the expiration of this SAML IdP certificate. This means that even if this certificate expires, your SAML authentication will continue to work. However, if your IdP administrator regenerates the SAML certificate, and you don't update it on the {% data variables.product.github %} side, users will encounter a `digest mismatch` error during SAML authentication attempts due to the certificate mismatch. See [Error: Digest mismatch](/admin/managing-iam/using-saml-for-enterprise-iam/troubleshooting-saml-authentication#error-digest-mismatch).
143+
137144
1. Under "User attributes", modify the SAML attribute names to match your IdP if needed, or accept the default names.
138145

139146
{% endif %}
140147

141148
## Further reading
142149

143150
{%- ifversion ghec %}
151+
144152
* [AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization)
145153
{%- endif %}
146154
{%- ifversion ghes %}

content/admin/managing-iam/using-saml-for-enterprise-iam/troubleshooting-saml-authentication.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,22 +31,24 @@ For more information about SAML response requirements, see [AUTOTITLE](/admin/id
3131
You can configure {% data variables.product.prodname_ghe_server %} to write verbose debug logs for every SAML authentication attempt. You may be able to troubleshoot failed authentication attempts with this extra output.
3232

3333
> [!WARNING]
34+
>
3435
> * Only enable SAML debugging temporarily, and disable debugging immediately after you finish troubleshooting. If you leave debugging enabled, the size of the logs increases much faster than usual, which can negatively impact the performance of {% data variables.product.prodname_ghe_server %}.
3536
> * Test new authentication settings for {% data variables.location.product_location %} in a staging environment before you apply the settings in your production environment. For more information, see [AUTOTITLE](/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance).
3637
3738
{% data reusables.enterprise-accounts.access-enterprise %}
3839
{% data reusables.enterprise-accounts.policies-tab %}
3940
{% data reusables.enterprise-accounts.options-tab %}
41+
4042
1. Under "SAML debugging", select the drop-down and click **Enabled**.
41-
1. Attempt to sign into {% data variables.location.product_location %} through your SAML IdP.
42-
1. Review the debug output in the systemd journal for `github-unicorn`on {% data variables.location.product_location %}. For more information, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/about-system-logs#system-logs-in-the-systemd-journal-for-github-enterprise-server).
43+
1. Attempt to sign in to {% data variables.location.product_location %} through your SAML IdP.
44+
1. Review the debug output in the `systemd` journal for `github-unicorn` on {% data variables.location.product_location %}. For more information, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/about-system-logs#system-logs-in-the-systemd-journal-for-github-enterprise-server).
4345
1. When you're done troubleshooting, select the drop-down and click **Disabled**.
4446

4547
## Decoding responses
4648

47-
Some output in the systemd journal for `github-unicorn` may be Base64-encoded. You can access the administrative shell and use the `base64` utility on {% data variables.location.product_location %} to decode these responses. For more information, see [AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh).
49+
Some output in the `systemd` journal for `github-unicorn` may be Base64-encoded. You can access the administrative shell and use the `base64` utility on {% data variables.location.product_location %} to decode these responses. For more information, see [AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh).
4850

49-
To decode the output, run the following command, replacing ENCODED_OUTPUT with the encoded output from the log.
51+
To decode the output, run the following command, replacing `ENCODED_OUTPUT` with the encoded output from the log.
5052

5153
```shell
5254
base64 --decode ENCODED_OUTPUT
@@ -110,3 +112,11 @@ This error can occur in version 3.17.0 or later of {% data variables.location.pr
110112
{% ifversion ghec %}
111113
{% data reusables.saml.authentication-loop %}
112114
{% endif %}
115+
116+
## Error: Digest mismatch
117+
118+
A "Digest mismatch" error indicates that your SAML IdP is using a different SAML signing certificate than the one you have uploaded to {% data variables.product.github %}{% ifversion ghes %} or that the **Signature Method** or **Digest Method** configured on {% data variables.product.github %} differs from what your IdP is using{% endif %}.
119+
120+
{% ifversion ghes %}Re-download this SAML certificate from your IdP and validate it using an online tool, such as the [Format a x509 cert](https://www.samltool.com/format_x509cert.php) tool from OneLogin. Then upload the SAML certificate again in the "Authentication" section in your {% data variables.product.prodname_ghe_server %} management console. See [AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-management-console#accessing-the-management-console-as-an-unauthenticated-user).{% endif %}
121+
122+
{% ifversion ghec %}Re-download this SAML certificate from your IdP and validate it using a tool such as the [Format a x509 cert](https://www.samltool.com/format_x509cert.php) tool from OneLogin. Then update the certificate saved in the {% data variables.product.github %} SAML settings.{% endif %}

content/authentication/troubleshooting-ssh/using-ssh-over-the-https-port.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ shortTitle: Use SSH over HTTPS port
1414
---
1515

1616
> [!WARNING]
17-
> **{% data variables.product.prodname_ghe_server %} users:** Accessing {% data variables.product.prodname_ghe_server %} via SSH over the HTTPS port is currently not supported.
17+
> **{% data variables.product.prodname_ghe_server %} users:** Accessing {% data variables.product.prodname_ghe_server %} via SSH over the HTTPS port is currently not supported.
18+
> **{% data variables.enterprise.data_residency %} users:** Accessing {% data variables.enterprise.data_residency %} via SSH over the HTTPS port is currently not supported.
1819
1920
To test if SSH over the HTTPS port is possible, run this SSH command:
2021

@@ -27,9 +28,6 @@ $ ssh -T -p 443 [email protected]
2728
If that worked, great! If not, you may need to [follow our troubleshooting guide](/authentication/troubleshooting-ssh/error-permission-denied-publickey).
2829

2930
> [!NOTE] The hostname for port 443 is `ssh.{% data variables.product.product_url %}`, not `{% data variables.product.product_url %}`.
30-
> {% ifversion ghec %}
31-
> {% data reusables.enterprise-data-residency.access-domain %}
32-
{% endif %}
3331
3432
Now, to clone the repository, you can run the following command:
3533

content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-automatic-dependency-submission-for-your-repository.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,10 +105,9 @@ The .NET autosubmission action uses the open source [component-detection](https:
105105

106106
Python uses the open source [component-detection](https://github.com/microsoft/component-detection/) project as its underlying graph generation engine. The autosubmission action for Python will only run if there is a `requirements.txt` file in the root directory of the repository. Python autosubmission does not currently support private packages; packages referenced in `requirements.txt` which are not publicly available will cause the autosubmission action to fail.
107107

108-
> [!NOTE]
108+
> [!NOTE]
109109
> This action uses [actions/setup-python](https://github.com/actions/setup-python) to install Python. You must include a .python-version file in your repository to specify the Python version to be installed.
110110
111-
112111
## Further reading
113112

114113
* [AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-supply-chain-security)

content/copilot/concepts/response-customization.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,11 @@ contentType: concepts
4040
> [!NOTE] This version of this article is about custom instructions in Xcode. Click the tabs above for other environments. <!-- markdownlint-disable-line MD027 -->
4141
{% endxcode %}
4242

43+
{% eclipse %}
44+
45+
> [!NOTE] This version of this article is about custom instructions in Eclipse. Click the tabs above for other environments. <!-- markdownlint-disable-line MD027 -->
46+
{% endeclipse %}
47+
4348
## About customizing {% data variables.copilot.copilot_chat %} responses
4449

4550
{% webui %}
@@ -95,6 +100,17 @@ While custom instructions help to add codebase-wide context to each AI workflow,
95100

96101
{% endxcode %}
97102

103+
{% eclipse %}
104+
105+
{% data variables.product.prodname_copilot %} can provide chat responses that are tailored to the way your team works, the tools you use, or the specifics of your project, if you provide it with enough context to do so. Instead of repeatedly adding this contextual detail to your chat questions, you can create a custom instructions file in your repository that automatically adds this information for you. The additional information is not displayed in the chat, but is available to {% data variables.product.prodname_copilot_short %} to allow it to generate higher quality responses.
106+
107+
There are two types of repository custom instructions you can use to provide context and instructions to {% data variables.copilot.copilot_chat_short %} in Eclipse:
108+
109+
* **Workspace custom instructions** which apply to all projects in a workspace, and allow you to specify workspace-wide instructions and preferences, in a single file.
110+
* **Project custom instructions** which apply to a specific project.
111+
112+
{% endeclipse %}
113+
98114
{% webui %}
99115

100116
## Using custom instructions
@@ -243,6 +259,26 @@ Common use cases include:
243259

244260
{% endxcode %}
245261

262+
{% eclipse %}
263+
264+
## About repository custom instructions
265+
266+
**Workspace custom instructions** apply to all projects in a workspace, and allow you to specify workspace-wide instructions and preferences. You can use workspace custom instructions to provide context and instructions to {% data variables.copilot.copilot_chat_short %} in Eclipse.
267+
268+
**Project custom instructions** consist of a single file, `.github/copilot-instructions.md`, that you create in a project. The instructions you add to the file should be short, self-contained statements that add context or relevant information to supplement chat questions.
269+
270+
Common use cases include:
271+
272+
* **Test generation.** Create instructions for test generation, such as specifying the use of a certain test framework.
273+
* **Code review.** Specify instructions for reviewing code, such as telling a reviewer to look for a specific error in the code.
274+
* **Commit message generation.** Write instructions for generating commit messages, such as format or the type of information to include.
275+
276+
### Example
277+
278+
{% data reusables.copilot.repository-custom-instructions-example %}
279+
280+
{% endeclipse %}
281+
246282
## Writing effective custom instructions
247283

248284
The instructions you add should ideally be short, self-contained statements provide {% data variables.product.prodname_copilot_short %} with relevant information to help it work.
@@ -292,3 +328,15 @@ Answer all questions in less than 1000 characters, and words of no more than 12
292328
* [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
293329

294330
{% endjetbrains %}
331+
332+
{% xcode %}
333+
334+
* [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
335+
336+
{% endxcode %}
337+
338+
{% eclipse %}
339+
340+
* [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
341+
342+
{% endeclipse %}

0 commit comments

Comments
 (0)