GitHub Enterprise Server 3.6 release candidate (#28905)
|
After Width: | Height: | Size: 18 KiB |
|
After Width: | Height: | Size: 277 KiB |
|
After Width: | Height: | Size: 247 KiB |
BIN
assets/images/help/commits/commit-form-with-signoff-enabled.png
Normal file
|
After Width: | Height: | Size: 8.6 KiB |
|
Before Width: | Height: | Size: 68 KiB After Width: | Height: | Size: 27 KiB |
|
Before Width: | Height: | Size: 68 KiB After Width: | Height: | Size: 27 KiB |
BIN
assets/images/help/organizations/require-signoffs.png
Normal file
|
After Width: | Height: | Size: 10 KiB |
BIN
assets/images/help/repository/require-signoffs.png
Normal file
|
After Width: | Height: | Size: 10 KiB |
|
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 94 KiB |
|
After Width: | Height: | Size: 24 KiB |
@@ -1,22 +1,50 @@
|
||||
---
|
||||
title: Managing accessibility settings
|
||||
intro: 'You can disable character key shortcuts on {% data variables.product.prodname_dotcom %} in your accessibility settings.'
|
||||
shortTitle: Manage accessibility settings
|
||||
intro: "{% data variables.product.product_name %}'s user interface can adapt to your vision, hearing, motor, cognitive, or learning needs."
|
||||
versions:
|
||||
feature: keyboard-shortcut-accessibility-setting
|
||||
redirect_from:
|
||||
- /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-accessibility-settings
|
||||
type: how_to
|
||||
miniTocMaxHeadingLevel: 3
|
||||
---
|
||||
|
||||
## About accessibility settings
|
||||
|
||||
{% data variables.product.product_name %} includes a variety of keyboard shortcuts so that you can perform actions across the site without using your mouse to navigate. While shortcuts are useful to save time, they can sometimes make {% data variables.product.prodname_dotcom %} harder to use and less accessible.
|
||||
To accommodate your vision, hearing, motor, cognitive, or learning needs, you can customize the user interface for {% data variables.product.product_location %}.
|
||||
|
||||
All keyboard shortcuts are enabled by default on {% data variables.product.product_name %}, but you can choose to disable character key shortcuts in your accessibility settings. This setting does not affect keyboard shortcuts provided by your web browser or {% data variables.product.prodname_dotcom %} shortcuts that use a modifier key such as <kbd>Control</kbd> or <kbd>Command</kbd>.
|
||||
## Managing accessibility settings
|
||||
|
||||
## Managing character key shortcuts
|
||||
You can decide whether you want to use some or all keyboard shortcuts on {% ifversion fpt or ghec %}{% data variables.product.product_location %}{% elsif ghes or ghae %}the website for {% data variables.product.product_location %}{% endif %}, and you can control the display of animated images.
|
||||
|
||||
### Managing keyboard shortcuts
|
||||
|
||||
You can perform actions across the {% data variables.product.product_name %} website without using your mouse by using your keyboard instead. Keyboard shortcuts can be useful to save time for some people, but may interfere with accessibility if you don't intend to use the shortcuts.
|
||||
|
||||
By default, all keyboard shortcuts are enabled on {% data variables.product.product_name %}. For more information, see "[Keyboard shortcuts](/get-started/using-github/keyboard-shortcuts)."
|
||||
|
||||
{% data reusables.user-settings.access_settings %}
|
||||
{% data reusables.user-settings.accessibility_settings %}
|
||||
1. Select or deselect the **Enable character key shortcuts** checkbox.
|
||||

|
||||
2. Click **Save**.
|
||||
1. Under "Keyboard shortcuts", manage settings for your keyboard shortcuts.
|
||||
|
||||
- Optionally, to disable or enable shortcut keys that don't use modifiers keys like <kbd>Control</kbd> or <kbd>Command</kbd>, under "General", deselect **Character keys**. If you disable character keys, you may still be able to trigger shortcuts for your web browser, and you can still trigger shortcuts for {% data variables.product.product_name %} that use a modifier key.
|
||||
{%- ifversion command-palette %}
|
||||
- Optionally, to customize the keyboard shortcuts for triggering the command palette, under "Command palette", use the drop-down menus to choose a keyboard shortcut. For more information, see "[{% data variables.product.company_short %} Command Palette](/get-started/using-github/github-command-palette)."
|
||||
{%- endif %}
|
||||
|
||||
{% ifversion motion-management %}
|
||||
|
||||
### Managing motion
|
||||
|
||||
You can control how {% data variables.product.product_name %} displays animated images.
|
||||
|
||||
By default, {% data variables.product.product_name %} syncs with your system-level preference for reduced motion. For more information, see the documentation or settings for your operating system.
|
||||
|
||||
{% data reusables.user-settings.access_settings %}
|
||||
{% data reusables.user-settings.accessibility_settings %}
|
||||
1. Under "Motion", manage settings for motion.
|
||||
|
||||
- Optionally, to control how {% data variables.product.product_name %} displays animaged images, under "Autoplay animated images", select **Sync with system**, **Enabled**, or **Disabled**.
|
||||
|
||||
{% endif %}
|
||||
@@ -185,7 +185,7 @@ on:
|
||||
deployment_status
|
||||
```
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
{% ifversion discussions %}
|
||||
### `discussion`
|
||||
|
||||
| Webhook event payload | Activity types | `GITHUB_SHA` | `GITHUB_REF` |
|
||||
|
||||
@@ -10,8 +10,6 @@ topics:
|
||||
shortTitle: Server Statistics
|
||||
---
|
||||
|
||||
{% data reusables.server-statistics.release-phase %}
|
||||
|
||||
## About {% data variables.product.prodname_server_statistics %}
|
||||
|
||||
{% data variables.product.prodname_server_statistics %} collects aggregate usage data from {% data variables.product.product_location %}, which you can use to better anticipate the needs of your organization, understand how your team works, and show the value you get from {% data variables.product.prodname_ghe_server %}.
|
||||
|
||||
@@ -737,6 +737,20 @@ This utility rewrites the imported repository. This gives you a chance to rename
|
||||
git-import-rewrite
|
||||
```
|
||||
|
||||
{% ifversion ghes > 3.3 %}
|
||||
|
||||
## Security
|
||||
|
||||
### ghe-find-insecure-git-operations
|
||||
|
||||
This utility searches your instance's logs and identifies Git operations over SSH that use insecure algorithms or hash functions, including DSA, RSA-SHA-1, HMAC-SHA-1, and CBC ciphers. You can use the output to support each client's transition to a more secure SSH connection. For more information, see [{% data variables.product.prodname_blog %}](https://github.blog/2022-06-28-improving-git-protocol-security-on-github-enterprise-server){% ifversion ghes < 3.6 %}.{% elsif ghes > 3.5 %} and "[Configuring SSH connections to your instance](/admin/configuration/configuring-your-enterprise/configuring-ssh-connections-to-your-instance)."{% endif %}
|
||||
|
||||
```shell
|
||||
ghe-find-insecure-git-operations
|
||||
```
|
||||
|
||||
{% endif %}
|
||||
|
||||
## Support
|
||||
|
||||
### ghe-diagnostics
|
||||
|
||||
@@ -85,6 +85,18 @@ settings to allow incoming emails](#configuring-dns-and-firewall-settings-to-all
|
||||

|
||||
{% data reusables.enterprise_site_admin_settings.wait-for-configuration-run %}
|
||||
|
||||
{% ifversion require-tls-for-smtp %}
|
||||
## Enforcing TLS for SMTP connections
|
||||
|
||||
You can enforce TLS encryption for all incoming SMTP connections, which can help satisfy an ISO-27017 certification requirement.
|
||||
|
||||
{% data reusables.enterprise_site_admin_settings.email-settings %}
|
||||
1. Under "Authentication," select **Enforce TLS auth (recommended)**.
|
||||
|
||||

|
||||
{% data reusables.enterprise_management_console.save-settings %}
|
||||
{% endif %}
|
||||
|
||||
## Configuring DNS and firewall settings to allow incoming emails
|
||||
|
||||
If you want to allow email replies to notifications, you must configure your DNS settings.
|
||||
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
title: Configuring host keys for your instance
|
||||
shortTitle: Configure host keys
|
||||
intro: 'You can increase the security of {% data variables.product.product_location %} by configuring the algorithms that your instance uses to generate and advertise host keys for incoming SSH connections.'
|
||||
permissions: "Site administrators can configure the host keys for a {% data variables.product.product_name %} instance."
|
||||
versions:
|
||||
ghes: '>= 3.6'
|
||||
type: how_to
|
||||
topics:
|
||||
- Authentication
|
||||
- Enterprise
|
||||
- Infrastructure
|
||||
- Networking
|
||||
- Security
|
||||
- SSH
|
||||
---
|
||||
|
||||
## About host keys for your instance
|
||||
|
||||
Servers that accept SSH connections advertise one or more cryptographic host keys to securely identify the server to SSH clients. To confirm the server's identity during the initialization of a connection, clients store and verify the host key. For more information, see [SSH Host Key - What, Why, How](https://ssh.com/academy/ssh/host-key) on the SSH Academy website.
|
||||
|
||||
{% data reusables.enterprise.about-ssh-ports %}
|
||||
|
||||
By default, {% data variables.product.product_location %} generates and advertises host keys with OpenSSH-style host key rotation. To increase the security of SSH in your environment, you can enable additional algorithms for the generation of host keys.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note**: If you enable additional host key algorithms, clients that do not use OpenSSH for SSH connections may experience warnings during connection, or fail to connect entirely. Some SSH implementations can ignore unsupported algorithms and fall back to a different algorithm. If the client does not support fallback, the connection will fail. For example, the SSH library for Go does not support fallback to a different algorithm.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
## Managing an Ed25519 host key
|
||||
|
||||
To improve security for clients that connect to {% data variables.product.product_location %}, you can enable the generation and advertisement of an Ed25519 host key. Ed25519 is immune to some attacks that target older signature algorithms, without sacrificing speed. Older SSH clients may not support Ed25519. By default, {% data variables.product.product_name %} instances do not generate or advertise an Ed25519 host key. For more information, see [the Ed25519 website](https://ed25519.cr.yp.to).
|
||||
|
||||
{% data reusables.enterprise_installation.ssh-into-instance %}
|
||||
1. To enable generation and advertisement of the Ed25519 host key, enter the following command.
|
||||
|
||||
```shell
|
||||
ghe-config app.babeld.host-key-ed25519 true
|
||||
```
|
||||
1. Optionally, enter the following command to disable generation and advertisement of the Ed25519 host key.
|
||||
|
||||
```shell
|
||||
ghe-config app.babeld.host-key-ed25519 false
|
||||
```
|
||||
{% data reusables.enterprise.apply-configuration %}
|
||||
@@ -0,0 +1,52 @@
|
||||
---
|
||||
title: Configuring SSH connections to your instance
|
||||
shortTitle: Configure SSH connections
|
||||
intro: 'You can increase the security of {% data variables.product.product_location %} by configuring the SSH algorithms that clients can use to establish a connection.'
|
||||
permissions: "Site administrators can configure SSH connections to a {% data variables.product.product_name %} instance."
|
||||
versions:
|
||||
ghes: '>= 3.6'
|
||||
type: how_to
|
||||
topics:
|
||||
- Authentication
|
||||
- Enterprise
|
||||
- Infrastructure
|
||||
- Networking
|
||||
- Security
|
||||
- SSH
|
||||
---
|
||||
|
||||
## About SSH connections to your instance
|
||||
|
||||
{% data reusables.enterprise.about-ssh-ports %}
|
||||
|
||||
To accommodate the SSH clients in your environment, you can configure the types of connections that {% data variables.product.product_location %} will accept.
|
||||
|
||||
## Configuring SSH connections with RSA keys
|
||||
|
||||
When users perform Git operations on {% data variables.product.product_location %} via SSH over port 22, the client can authenticate with an RSA key. The client may sign the attempt using the SHA-1 hash function. In this context, the SHA-1 hash function is no longer secure. For more information, see [SHA-1](https://en.wikipedia.org/wiki/SHA-1) on Wikipedia.
|
||||
|
||||
By default{% ifversion ghes < 3.7 %} on {% data variables.product.product_name %} 3.6 and later{% endif %}, SSH connections that satisfy **both** of the following conditions will fail.
|
||||
|
||||
{% data reusables.ssh.rsa-sha-1-connection-failure-criteria %}
|
||||
|
||||
You can adjust the cutoff date. If the user uploaded the RSA key before the cutoff date, the client can continue to connect successfuly using SHA-1 as long as the key remains valid. Alternatively, you can reject all SSH connections authenticated with an RSA key if the client signs the connection using the SHA-1 hash function.
|
||||
|
||||
Regardless of the setting you choose for your instance, clients can continue to connect using any RSA key signed with a SHA-2 hash function.
|
||||
|
||||
If you use an SSH certificate authority, connections will fail if the certificate's `valid_after` date is after the cutoff date. For more information, see "[About SSH certificate authorities](/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities)."
|
||||
|
||||
For more information, see [{% data variables.product.prodname_blog %}](https://github.blog/2022-06-28-improving-git-protocol-security-on-github-enterprise-server).
|
||||
|
||||
{% data reusables.enterprise_installation.ssh-into-instance %}
|
||||
1. Audit your instance's logs for connections that use unsecure algorithms or hash functions using the `ghe-find-insecure-git-operations` utility. For more information, see "[Command-line utilities](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-find-insecure-git-operations)."
|
||||
1. To configure a cutoff date after which {% data variables.product.product_location %} will deny connections from clients that use an RSA key uploaded after the date if the connection is signed by the SHA-1 hash function, enter the following command. Replace _**RFC-3399-UTC-TIMESTAMP**_ with a valid RFC 3399 UTC timestamp. For example, the default value, August 1, 2022, would be represented as `2022-08-01T00:00:00Z`. For more information, see [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) on the IETF website.
|
||||
|
||||
<pre>
|
||||
$ ghe-config app.gitauth.rsa-sha1 <em>RFC-3339-UTC-TIMESTAMP</em>
|
||||
</pre>
|
||||
1. Alternatively, to completely disable SSH connections using RSA keys that are signed with the SHA-1 hash function, enter the following command.
|
||||
|
||||
```shell
|
||||
ghe-config app.gitauth.rsa-sha1 false
|
||||
```
|
||||
{% data reusables.enterprise.apply-configuration %}
|
||||
@@ -25,6 +25,7 @@ children:
|
||||
- /site-admin-dashboard
|
||||
- /enabling-private-mode
|
||||
- /managing-github-mobile-for-your-enterprise
|
||||
- /configuring-ssh-connections-to-your-instance
|
||||
- /configuring-email-for-notifications
|
||||
- /verifying-or-approving-a-domain-for-your-enterprise
|
||||
- /configuring-rate-limits
|
||||
@@ -34,6 +35,7 @@ children:
|
||||
- /command-line-utilities
|
||||
- /restricting-network-traffic-to-your-enterprise
|
||||
- /configuring-github-pages-for-your-enterprise
|
||||
- /configuring-host-keys-for-your-instance
|
||||
- /configuring-the-referrer-policy-for-your-enterprise
|
||||
- /configuring-custom-footers
|
||||
- /configuring-web-commit-signing
|
||||
|
||||
@@ -40,7 +40,7 @@ Then,{% else %}First,{% endif %} decide whether you'll allow third-party actions
|
||||
Consider combining OpenID Connect (OIDC) with reusable workflows to enforce consistent deployments across your repository, organization, or enterprise. You can do this by defining trust conditions on cloud roles based on reusable workflows. For more information, see "[Using OpenID Connect with reusable workflows](/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows)."
|
||||
{% endif %}
|
||||
|
||||
You can access information about activity related to {% data variables.product.prodname_actions %} in the audit logs for your enterprise. If your business needs require retaining audit logs for longer than six months, plan how you'll export and store this data outside of {% data variables.product.prodname_dotcom %}. For more information, see {% ifversion ghec %}"[Streaming the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise)" and "[Exporting audit log activity for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/exporting-audit-log-activity-for-your-enterprise)."{% else %}"[Log forwarding](/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/log-forwarding)."{% endif %}
|
||||
You can access information about activity related to {% data variables.product.prodname_actions %} in the audit logs for your enterprise. If your business needs require retaining this information longer than audit log data is retained, plan how you'll export and store this data outside of {% data variables.product.prodname_dotcom %}. For more information, see {% ifversion ghec %}"[Exporting audit log activity for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/exporting-audit-log-activity-for-your-enterprise)" and "[Streaming the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise)."{% else %}{% ifversion audit-log-streaming %}"[Streaming the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise)" and {% endif %}"[Log forwarding](/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/log-forwarding)."{% endif %}
|
||||
|
||||

|
||||
|
||||
|
||||
@@ -52,6 +52,8 @@ includeGuides:
|
||||
- /admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise
|
||||
- /admin/configuration/configuring-your-enterprise/managing-github-mobile-for-your-enterprise
|
||||
- /admin/configuration/connecting-your-enterprise-account-to-github-enterprise-cloud
|
||||
- /admin/configuration/configuring-your-enterprise/configuring-ssh-connections-to-your-instance
|
||||
- /admin/configuration/configuring-your-enterprise/configuring-host-keys-for-your-instance
|
||||
- /admin/configuration/enabling-and-scheduling-maintenance-mode
|
||||
- /admin/configuration/configuring-github-connect/enabling-automatic-user-license-sync-for-your-enterprise
|
||||
- /admin/configuration/enabling-private-mode
|
||||
|
||||
@@ -10,8 +10,6 @@ topics:
|
||||
- Enterprise
|
||||
---
|
||||
|
||||
{% data reusables.server-statistics.release-phase %}
|
||||
|
||||
## About the benefits of {% data variables.product.prodname_server_statistics %}
|
||||
|
||||
{% data variables.product.prodname_server_statistics %} can help you anticipate the needs of your organization, understand how your team works, and show the value you get from {% data variables.product.prodname_ghe_server %}.
|
||||
|
||||
@@ -8,8 +8,6 @@ redirect_from:
|
||||
- /early-access/github/analyze-how-your-team-works-with-server-statistics/exploring-server-statistics
|
||||
---
|
||||
|
||||
{% data reusables.server-statistics.release-phase %}
|
||||
|
||||
You can download up to the last 365 days of {% data variables.product.prodname_server_statistics %} data in a CSV or JSON file. This data, which includes aggregate metrics on repositories, issues, and pull requests, can help you anticipate the needs of your organization, understand how your team works, and show the value you get from {% data variables.product.prodname_ghe_server %}.
|
||||
|
||||
Before you can download this data, you must enable {% data variables.product.prodname_server_statistics %}. For more information, see "[Enabling {% data variables.product.prodname_server_statistics %} for your enterprise](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)."
|
||||
|
||||
@@ -8,8 +8,6 @@ redirect_from:
|
||||
- /early-access/github/analyze-how-your-team-works-with-server-statistics/requesting-server-statistics-using-the-rest-api
|
||||
---
|
||||
|
||||
{% data reusables.server-statistics.release-phase %}
|
||||
|
||||
You can request up to 365 days of metrics in a single {% data variables.product.prodname_server_statistics %} REST API request. This data, which includes aggregate metrics on repositories, issues, and pull requests, can help you anticipate the needs of your organization, understand how your team works, and show the value you get from {% data variables.product.prodname_ghe_server %}. For a list of the metrics collected, see "[{% data variables.product.prodname_server_statistics %} data collected](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics#server-statistics-data-collected)."
|
||||
|
||||
Before you can use the {% data variables.product.prodname_server_statistics %} REST API, you must enable {% data variables.product.prodname_server_statistics %}. For more information, see "[Enabling {% data variables.product.prodname_server_statistics %} for your enterprise](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)."
|
||||
|
||||
@@ -39,9 +39,10 @@ As an enterprise owner{% ifversion ghes %} or site administrator{% endif %}, you
|
||||
{%- ifversion enterprise-audit-log-ip-addresses %}
|
||||
- You can display the IP address associated with events in the audit log. For more information, see "[Displaying IP addresses in the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/displaying-ip-addresses-in-the-audit-log-for-your-enterprise)."
|
||||
{%- endif %}
|
||||
{%- ifversion ghec %}
|
||||
{%- ifversion audit-log-streaming %}
|
||||
- You can stream audit and Git events data from {% data variables.product.prodname_dotcom %} to an external data management system. For more information, see "[Streaming the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise)."
|
||||
{%- else %}
|
||||
{%- endif %}
|
||||
{%- ifversion ghes %}
|
||||
- You can forward audit and system logs, from your enterprise to an third-party hosted monitoring system. For more information, see "[Log forwarding](/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/log-forwarding)."
|
||||
{%- endif %}
|
||||
{%- ifversion ghec or ghes > 3.2 or ghae-issue-6648 %}
|
||||
@@ -50,13 +51,6 @@ As an enterprise owner{% ifversion ghes %} or site administrator{% endif %}, you
|
||||
|
||||
For a full list of audit log actions that may appear in your enterprise audit log, see "[Audit log actions for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise)."
|
||||
|
||||
{% ifversion ghec %}
|
||||
## Git events
|
||||
|
||||
Git events data, such as cloning, fetching, and pushing is logged. For more information, see "[Streaming the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
## Further reading
|
||||
- "[Reviewing the audit log for your organization](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization)"
|
||||
{%- ifversion ghes %}
|
||||
|
||||
@@ -59,7 +59,7 @@ The scope of the events that appear in your enterprise's audit log depend on whe
|
||||
|--------|-------------
|
||||
| `artifact.destroy` | A workflow run artifact was manually deleted.
|
||||
|
||||
{%- ifversion ghec %}
|
||||
{%- ifversion audit-log-streaming %}
|
||||
## `audit_log_streaming` category actions
|
||||
|
||||
| Action | Description
|
||||
|
||||
@@ -3,7 +3,7 @@ title: Streaming the audit log for your enterprise
|
||||
intro: 'You can stream audit and Git events data from {% data variables.product.prodname_dotcom %} to an external data management system.'
|
||||
miniTocMaxHeadingLevel: 3
|
||||
versions:
|
||||
ghec: '*'
|
||||
feature: audit-log-streaming
|
||||
type: tutorial
|
||||
topics:
|
||||
- Auditing
|
||||
@@ -17,6 +17,14 @@ redirect_from:
|
||||
permissions: Enterprise owners can configure audit log streaming.
|
||||
---
|
||||
|
||||
{% ifversion ghes %}
|
||||
{% note %}
|
||||
|
||||
**Note:** Audit log streaming is currently in beta for {% data variables.product.product_name %} and is subject to change.
|
||||
|
||||
{% endnote %}
|
||||
{% endif %}
|
||||
|
||||
## About audit log streaming
|
||||
|
||||
To help protect your intellectual property and maintain compliance for your organization, you can use streaming to keep copies of your audit log data and monitor:
|
||||
@@ -24,11 +32,11 @@ To help protect your intellectual property and maintain compliance for your orga
|
||||
|
||||
The benefits of streaming audit data include:
|
||||
|
||||
* **Data exploration**. You can examine streamed events using your preferred tool for querying large quantities of data. The stream contains both audit events and Git events across the entire enterprise account.
|
||||
* **Data continuity**. You can pause the stream for up to seven days without losing any audit data.
|
||||
* **Data exploration**. You can examine streamed events using your preferred tool for querying large quantities of data. The stream contains both audit events and Git events across the entire enterprise account.{% ifversion pause-audit-log-stream %}
|
||||
* **Data continuity**. You can pause the stream for up to seven days without losing any audit data.{% endif %}
|
||||
* **Data retention**. You can keep your exported audit logs and Git events data as long as you need to.
|
||||
|
||||
Enterprise owners can set up, pause, or delete a stream at any time. The stream exports the audit data for all of the organizations in your enterprise.
|
||||
Enterprise owners can set up{% ifversion pause-audit-log-stream %}, pause,{% endif %} or delete a stream at any time. The stream exports the audit and Git events data for all of the organizations in your enterprise.
|
||||
|
||||
## Setting up audit log streaming
|
||||
|
||||
@@ -273,6 +281,7 @@ To stream audit logs to Splunk's HTTP Event Collector (HEC) endpoint you must ma
|
||||

|
||||
{% data reusables.enterprise.verify-audit-log-streaming-endpoint %}
|
||||
|
||||
{% ifversion pause-audit-log-stream %}
|
||||
## Pausing audit log streaming
|
||||
|
||||
Pausing the stream allows you to perform maintenance on the receiving application without losing audit data. Audit logs are stored for up to seven days on {% data variables.product.product_location %} and are then exported when you unpause the stream.
|
||||
@@ -285,6 +294,7 @@ Pausing the stream allows you to perform maintenance on the receiving applicatio
|
||||
1. A confirmation message is displayed. Click **Pause stream** to confirm.
|
||||
|
||||
When the application is ready to receive audit logs again, click **Resume stream** to restart streaming audit logs.
|
||||
{% endif %}
|
||||
|
||||
## Deleting the audit log stream
|
||||
|
||||
|
||||
@@ -14,6 +14,7 @@ children:
|
||||
- /enabling-github-packages-with-minio
|
||||
- /quickstart-for-configuring-your-minio-storage-bucket-for-github-packages
|
||||
- /configuring-package-ecosystem-support-for-your-enterprise
|
||||
- /migrating-your-enterprise-to-the-container-registry-from-the-docker-registry
|
||||
shortTitle: Manage GitHub Packages
|
||||
---
|
||||
{% data reusables.package_registry.packages-ghes-release-stage %}
|
||||
|
||||
@@ -0,0 +1,85 @@
|
||||
---
|
||||
title: Migrating your enterprise to the Container registry from the Docker registry
|
||||
intro: 'You can migrate Docker images previously stored in the Docker registry on {% data variables.product.product_location %} to the {% data variables.product.prodname_container_registry %}.'
|
||||
product: '{% data reusables.gated-features.packages %}'
|
||||
permissions: "Enterprise owners can migrate Docker images to the {% data variables.product.prodname_container_registry %}."
|
||||
versions:
|
||||
feature: 'docker-ghcr-enterprise-migration'
|
||||
shortTitle: Migrate to Container registry
|
||||
topics:
|
||||
- Containers
|
||||
- Docker
|
||||
- Migration
|
||||
---
|
||||
|
||||
{% data reusables.package_registry.container-registry-ghes-beta %}
|
||||
|
||||
## About the {% data variables.product.prodname_container_registry %}
|
||||
|
||||
{% data reusables.package_registry.container-registry-benefits %} For more information, see "[Working with the {% data variables.product.prodname_container_registry %}](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)."
|
||||
|
||||
For more information about configuring {% data variables.product.prodname_registry %} for {% data variables.product.product_location %}, see "[Getting started with {% data variables.product.prodname_registry %} for your enterprise](/admin/packages/getting-started-with-github-packages-for-your-enterprise)."
|
||||
|
||||
## About migration from the Docker registry
|
||||
|
||||
{% data reusables.package_registry.container-registry-replaces-docker-registry %} If the Docker registry on {% data variables.product.product_location %} contains images, you must manually migrate the images to the {% data variables.product.prodname_container_registry %}.
|
||||
|
||||
{% ifversion ghes %}
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note**: {% data reusables.package_registry.container-registry-ghes-migration-availability %}
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% data reusables.package_registry.container-registry-migration-namespaces %} For more information about the impact of migration to the {% data variables.product.prodname_container_registry %}, see "[Migrating to the {% data variables.product.prodname_container_registry %} from the Docker registry](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry#about-migration-from-the-docker-registry)."
|
||||
|
||||
## Migrating organizations to the {% data variables.product.prodname_container_registry %}
|
||||
|
||||
You can start a migration of all your organizations' Docker images to the {% data variables.product.prodname_container_registry %}. The duration of the migration operation depends on the total number of images to migrate, and the overall load on {% ifversion ghes %}your instance{% elsif ghae %}{% data variables.product.product_name %}{% endif %}. After a successful migration, {% data variables.product.product_name %} will display a summary, and all future uploads of Docker images will use the {% data variables.product.prodname_container_registry %}.
|
||||
|
||||
If {% ifversion ghes %}a site administrator{% elsif ghae %}an enterprise owner{% endif %} has configured email notifications for {% data variables.product.product_location %}, you will receive an email after the migration is complete. For more information, see "[Configuring email for notifications](/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications)."
|
||||
|
||||
{% note %}
|
||||
|
||||
**{% ifversion ghes %}Notes{% elsif ghae %}Note{% endif %}**:
|
||||
|
||||
{%- ifversion ghes %}
|
||||
- During the migration, the CPU and memory usage for your instance will increase. To ensure the performance of the instance for your users, {% data variables.product.company_short %} recommends that you begin a migration during a period of reduced activity.
|
||||
{%- endif %}
|
||||
{% ifversion ghes %}- {% endif %}During the migration, do not modify settings for your enterprise{% ifversion ghes %} or run `ghe-config-apply` from an administrative SSH session{% endif %}. {% ifversion ghes %}These actions will trigger a configuration run, which can restart services and {% elsif ghae %}Modifying these settings {% endif %} may interrupt the migration.
|
||||
{%- ifversion ghes %}
|
||||
- After the migration, storage pressure on your instance will increase due to the duplication of image files in the Docker registry and the {% data variables.product.prodname_container_registry %}. A future release of {% data variables.product.product_name %} will remove the duplicated files when all migrations are complete.
|
||||
|
||||
For more information about monitoring the performance and storage of {% data variables.product.product_location %}, see "[Accessing the monitor dashboard](/admin/enterprise-management/monitoring-your-appliance/accessing-the-monitor-dashboard)."
|
||||
{% endif %}
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.settings-tab %}
|
||||
1. In the left sidebar, click **Packages**.
|
||||
1. To the right of the number of packages to migrate, click **Start migration**. During the migration, {% data variables.product.product_name %} will display progress on this page.
|
||||
|
||||
After the migration completes, the page will display the results. If a migration fails, the page will show the organizations that own the package that caused the failure.
|
||||
|
||||
## Re-running a failed organization migration
|
||||
|
||||
Prior to migration, if a user has created a package in the {% data variables.product.prodname_container_registry %} that has an identical name to an existing package in the Docker registry, the migration will fail.
|
||||
|
||||
1. Delete the affected container in the {% data variables.product.prodname_container_registry %}. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package#deleting-a-version-of-an-organization-scoped-package-on-github)."
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.settings-tab %}
|
||||
{% data reusables.enterprise-accounts.packages-tab %}
|
||||
1. To the right of the number of packages to migrate, click **Re-run migration**. During the migration, {% data variables.product.product_name %} will display progress on this page.
|
||||
1. If the migration fails again, start from step 1 and re-run the migration.
|
||||
|
||||
{% ifversion ghes %}
|
||||
|
||||
## Monitoring traffic to the registries
|
||||
|
||||
You can use visualize traffic to the Docker registry and {% data variables.product.prodname_container_registry %} from {% data variables.product.product_location %}'s monitor dashboard. The "GitHub Container Package Registry" graph can help you confirm that you've successfully migrated all images to the {% data variables.product.prodname_container_registry %}. In the graph, "v1" represents traffic to the Docker registry, and "v2" represents traffic to the {% data variables.product.prodname_container_registry %}. For more information, see "[Accessing the monitor dashboard](/admin/enterprise-management/monitoring-your-appliance/accessing-the-monitor-dashboard)."
|
||||
|
||||
{% endif %}
|
||||
@@ -209,6 +209,30 @@ By default, when you enforce repository upload limits, people cannot add or upda
|
||||
5. Optionally, to enforce a maximum upload limit for all repositories in your enterprise, select **Enforce on all repositories**
|
||||

|
||||
|
||||
{% ifversion profile-name-enterprise-setting %}
|
||||
|
||||
## Enforcing a policy for the display of member names in your repositories
|
||||
|
||||
Across all organizations owned by your enterprise, you can allow members to see a comment author's profile name, in addition to their username, in issues and pull requests for public and internal repositories.
|
||||
|
||||

|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** When this policy is enforced for all repositories in the enterprise, it overrides the organization setting for private repositories. For more information, see "[Managing the display of member names in your organization](/organizations/managing-organization-settings/managing-the-display-of-member-names-in-your-organization)".
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.policies-tab %}
|
||||
{% data reusables.enterprise-accounts.options-tab %}
|
||||
4. Under "Allow members to see the comment author's profile name in public and internal repositories", select the dropdown menu and click a policy.
|
||||

|
||||
5. Optionally, to enforce the display of profile names for all repositories in your enterprise, select **Enforce for all repositories on the instance**.
|
||||

|
||||
|
||||
{% endif %}
|
||||
|
||||
## Configuring the merge conflict editor for pull requests between repositories
|
||||
|
||||
Requiring users to resolve merge conflicts locally on their computer can prevent people from inadvertently writing to an upstream repository from a fork.
|
||||
@@ -276,10 +300,22 @@ You can override the default inherited settings by configuring the settings for
|
||||
|
||||
{% data reusables.enterprise_user_management.disclaimer-for-git-read-access %}
|
||||
|
||||
{% ifversion ghes %}If you have [enabled private mode](/enterprise/admin/configuration/enabling-private-mode) on your enterprise, you {% else %}You {% endif %}can allow repository administrators to enable anonymous Git read access to public repositories.
|
||||
If you have [enabled private mode](/enterprise/admin/configuration/enabling-private-mode) for {% data variables.product.product_location %}, you can allow repository administrators to enable anonymous Git read access to public repositories.
|
||||
|
||||
Enabling anonymous Git read access allows users to bypass authentication for custom tools on your enterprise. When you or a repository administrator enable this access setting for a repository, unauthenticated Git operations (and anyone with network access to {% data variables.product.product_name %}) will have read access to the repository without authentication.
|
||||
|
||||
Anonymous Git read access is disabled by default.{% ifversion ghes = 3.4 or ghes = 3.5 or ghes = 3.6 or ghes = 3.7 %} When you upgrade to {% data variables.product.product_name %} 3.6 or later, anonymous Git read access is automatically disabled at the application level, and `git://` connections on port 9418 will return the following error.
|
||||
|
||||
```
|
||||
The unauthenticated git protocol on port 9418 is no longer supported.
|
||||
```
|
||||
|
||||
If you wish to support the unathenticated Git protocol in your environment, you must manually re-enable the feature. {% data variables.product.company_short %} recommends using SSH instead of the Git protocol. For more information, see [{% data variables.product.prodname_blog %}](https://github.blog/2022-06-28-improving-git-protocol-security-on-github-enterprise-server).
|
||||
|
||||
{% endif %}
|
||||
|
||||
|
||||
|
||||
If necessary, you can prevent repository administrators from changing anonymous Git access settings for repositories on your enterprise by locking the repository's access settings. After you lock a repository's Git read access setting, only a site administrator can change the setting.
|
||||
|
||||
{% data reusables.enterprise_site_admin_settings.list-of-repos-with-anonymous-git-read-access-enabled %}
|
||||
|
||||
@@ -25,6 +25,10 @@ You can see all current enterprise members and enterprise administrators{% ifver
|
||||
|
||||
You can view all the current enterprise owners{% ifversion ghec %} and billing managers{% endif %} for your enterprise.{% ifversion enterprise-membership-view-improvements %} You can see useful information about each administrator{% ifversion ghec %} and filter the list by role{% endif %}.{% endif %} You can find a specific person by searching for their username or display name.
|
||||
|
||||
{% ifversion ghes > 3.5 %}
|
||||
Enterprise owners whose accounts are suspended are included in the list of enterprise administrators, and are identified as suspended. You should consider demoting any suspended owners you see. For more information, see "[Promoting or demoting a site administrator](/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator#demoting-a-site-administrator-from-the-enterprise-settings)."
|
||||
{% endif %}
|
||||
|
||||
{% ifversion not ghae %}
|
||||
You can also remove an administrator. For more information. see "[Inviting people to manage your enterprise](/admin/user-management/managing-users-in-your-enterprise/inviting-people-to-manage-your-enterprise#removing-an-enterprise-administrator-from-your-enterprise-account)."
|
||||
{% endif %}
|
||||
|
||||
@@ -13,7 +13,12 @@ versions:
|
||||
topics:
|
||||
- SSH
|
||||
---
|
||||
When you set up SSH, you will need to generate a new SSH key and add it to the ssh-agent. You must add the SSH key to your account on {% data variables.product.product_name %} before you use the key to authenticate. For more information, see "[Generating a new SSH key and adding it to the ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)" and "[Adding a new SSH key to your {% data variables.product.prodname_dotcom %} account](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account)."
|
||||
|
||||
## About SSH
|
||||
|
||||
{% data reusables.ssh.about-ssh %} For more information about SSH, see [Secure Shell](https://en.wikipedia.org/wiki/Secure_Shell) on Wikipedia.
|
||||
|
||||
When you set up SSH, you will need to generate a new private SSH key and add it to the SSH agent. You must also add the public SSH key to your account on {% data variables.product.product_name %} before you use the key to authenticate. For more information, see "[Generating a new SSH key and adding it to the ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)" and "[Adding a new SSH key to your {% data variables.product.prodname_dotcom %} account](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account)."
|
||||
|
||||
You can further secure your SSH key by using a hardware security key, which requires the physical hardware security key to be attached to your computer when the key pair is used to authenticate with SSH. You can also secure your SSH key by adding your key to the ssh-agent and using a passphrase. For more information, see "[Working with SSH key passphrases](/github/authenticating-to-github/working-with-ssh-key-passphrases)."
|
||||
|
||||
|
||||
@@ -14,9 +14,21 @@ topics:
|
||||
- SSH
|
||||
shortTitle: Add a new SSH key
|
||||
---
|
||||
Before adding a new SSH key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, you should have:
|
||||
* [Checked for existing SSH keys](/articles/checking-for-existing-ssh-keys)
|
||||
* [Generating a new SSH key and adding it to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)
|
||||
|
||||
## About addition of SSH keys to your account
|
||||
|
||||
{% data reusables.ssh.about-ssh %} For more information, see "[About SSH](/authentication/connecting-to-github-with-ssh/about-ssh)."
|
||||
|
||||
After you generate an SSH key pair, you must add the public key to {% ifversion fpt or ghec or ghes %}{% data variables.product.product_location %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %} to enable SSH access for your account.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before adding a new SSH key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, complete the following steps.
|
||||
|
||||
1. Check for existing SSH keys. For more information, see "[Checking for existing SSH keys](/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)."
|
||||
1. Generate a new SSH key and add it to your machine's SSH agent. For more information, see "[Generating a new SSH key and adding it to the ssh-agent](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)."
|
||||
|
||||
## Adding a new SSH key to your account
|
||||
|
||||
After adding a new SSH key to your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, you can reconfigure any local repositories to use SSH. For more information, see "[Switching remote URLs from HTTPS to SSH](/github/getting-started-with-github/managing-remote-repositories/#switching-remote-urls-from-https-to-ssh)."
|
||||
|
||||
|
||||
@@ -15,6 +15,16 @@ topics:
|
||||
shortTitle: Check for existing SSH key
|
||||
---
|
||||
|
||||
## About SSH keys
|
||||
|
||||
You can use SSH to perform Git operations in repositories on {% ifversion fpt or ghec or ghes %}{% data variables.product.product_location %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %}. For more information, see "[About SSH](/authentication/connecting-to-github-with-ssh/about-ssh)."
|
||||
|
||||
If you have an existing SSH key, you can use the key to authenticate Git operations over SSH.
|
||||
|
||||
## Checking for existing SSH keys
|
||||
|
||||
Before you generate a new SSH key, you should check your local machine for existing keys.
|
||||
|
||||
{% data reusables.ssh.key-type-support %}
|
||||
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
|
||||
@@ -16,72 +16,79 @@ topics:
|
||||
- SSH
|
||||
shortTitle: Generate new SSH key
|
||||
---
|
||||
## About SSH key generation
|
||||
|
||||
## About SSH key passphrases
|
||||
|
||||
{% data reusables.ssh.about-ssh %} For more information, see "[About SSH](/authentication/connecting-to-github-with-ssh/about-ssh)."
|
||||
|
||||
When you generate an SSH key, you can add a passphrase to further secure the key. Whenever you use the key, you must enter the passphrase. If your key has a passphrase and you don't want to enter the passphrase every time you use the key, you can add your key to the SSH agent. The SSH agent manages your SSH keys and remembers your passphrase.
|
||||
|
||||
If you don't already have an SSH key, you must generate a new SSH key to use for authentication. If you're unsure whether you already have an SSH key, you can check for existing keys. For more information, see "[Checking for existing SSH keys](/github/authenticating-to-github/checking-for-existing-ssh-keys)."
|
||||
|
||||
If you want to use a hardware security key to authenticate to {% data variables.product.product_name %}, you must generate a new SSH key for your hardware security key. You must connect your hardware security key to your computer when you authenticate with the key pair. For more information, see the [OpenSSH 8.2 release notes](https://www.openssh.com/txt/release-8.2).
|
||||
|
||||
If you don't want to reenter your passphrase every time you use your SSH key, you can add your key to the SSH agent, which manages your SSH keys and remembers your passphrase.
|
||||
|
||||
## Generating a new SSH key
|
||||
|
||||
You can generate a new SSH key on your local machine. After you generate the key, you can add the key to your account on {% ifversion fpt or ghec or ghes %}{% data variables.product.product_location %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %} to enable authentication for Git operations over SSH.
|
||||
|
||||
{% data reusables.ssh.key-type-support %}
|
||||
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
2. Paste the text below, substituting in your {% data variables.product.product_name %} email address.
|
||||
{% ifversion ghae %}
|
||||
{%- ifversion ghae %}
|
||||
<!-- GitHub AE is FIPS 140-2 compliant. FIPS does not yet permit keys that use the ed25519 algorithm. -->
|
||||
```shell
|
||||
$ ssh-keygen -t rsa -b 4096 -C "<em>your_email@example.com</em>"
|
||||
```
|
||||
{% else %}
|
||||
```shell
|
||||
$ ssh-keygen -t ed25519 -C "<em>your_email@example.com</em>"
|
||||
```
|
||||
{% note %}
|
||||
```shell
|
||||
$ ssh-keygen -t rsa -b 4096 -C "<em>your_email@example.com</em>"
|
||||
```
|
||||
{%- else %}
|
||||
```shell
|
||||
$ ssh-keygen -t ed25519 -C "<em>your_email@example.com</em>"
|
||||
```
|
||||
{% note %}
|
||||
|
||||
**Note:** If you are using a legacy system that doesn't support the Ed25519 algorithm, use:
|
||||
```shell
|
||||
$ ssh-keygen -t rsa -b 4096 -C "<em>your_email@example.com</em>"
|
||||
```
|
||||
|
||||
**Note:** If you are using a legacy system that doesn't support the Ed25519 algorithm, use:
|
||||
```shell
|
||||
$ ssh-keygen -t rsa -b 4096 -C "<em>your_email@example.com</em>"
|
||||
```
|
||||
{% endnote %}
|
||||
{%- endif %}
|
||||
|
||||
{% endnote %}
|
||||
{% endif %}
|
||||
|
||||
This creates a new SSH key, using the provided email as a label.
|
||||
```shell
|
||||
> Generating public/private <em>algorithm</em> key pair.
|
||||
```
|
||||
This creates a new SSH key, using the provided email as a label.
|
||||
```shell
|
||||
> Generating public/private <em>algorithm</em> key pair.
|
||||
```
|
||||
3. When you're prompted to "Enter a file in which to save the key," press Enter. This accepts the default file location.
|
||||
|
||||
{% mac %}
|
||||
{% mac %}
|
||||
|
||||
```shell
|
||||
> Enter a file in which to save the key (/Users/<em>you</em>/.ssh/id_<em>algorithm</em>): <em>[Press enter]</em>
|
||||
```
|
||||
|
||||
{% endmac %}
|
||||
|
||||
{% windows %}
|
||||
|
||||
```shell
|
||||
> Enter a file in which to save the key (/c/Users/<em>you</em>/.ssh/id_<em>algorithm</em>):<em>[Press enter]</em>
|
||||
```
|
||||
|
||||
```shell
|
||||
> Enter a file in which to save the key (/Users/<em>you</em>/.ssh/id_<em>algorithm</em>): <em>[Press enter]</em>
|
||||
```
|
||||
|
||||
{% endmac %}
|
||||
|
||||
{% windows %}
|
||||
|
||||
```shell
|
||||
> Enter a file in which to save the key (/c/Users/<em>you</em>/.ssh/id_<em>algorithm</em>):<em>[Press enter]</em>
|
||||
```
|
||||
|
||||
{% endwindows %}
|
||||
|
||||
{% linux %}
|
||||
|
||||
```shell
|
||||
> Enter a file in which to save the key (/home/<em>you</em>/.ssh/<em>algorithm</em>): <em>[Press enter]</em>
|
||||
```
|
||||
|
||||
{% endlinux %}
|
||||
{% endwindows %}
|
||||
|
||||
{% linux %}
|
||||
|
||||
```shell
|
||||
> Enter a file in which to save the key (/home/<em>you</em>/.ssh/<em>algorithm</em>): <em>[Press enter]</em>
|
||||
```
|
||||
|
||||
{% endlinux %}
|
||||
|
||||
4. At the prompt, type a secure passphrase. For more information, see ["Working with SSH key passphrases](/articles/working-with-ssh-key-passphrases)."
|
||||
```shell
|
||||
> Enter passphrase (empty for no passphrase): <em>[Type a passphrase]</em>
|
||||
> Enter same passphrase again: <em>[Type passphrase again]</em>
|
||||
```
|
||||
```shell
|
||||
> Enter passphrase (empty for no passphrase): <em>[Type a passphrase]</em>
|
||||
> Enter same passphrase again: <em>[Type passphrase again]</em>
|
||||
```
|
||||
|
||||
## Adding your SSH key to the ssh-agent
|
||||
|
||||
@@ -93,66 +100,55 @@ Before adding a new SSH key to the ssh-agent to manage your keys, you should hav
|
||||
|
||||
2. If you're using macOS Sierra 10.12.2 or later, you will need to modify your `~/.ssh/config` file to automatically load keys into the ssh-agent and store passphrases in your keychain.
|
||||
|
||||
* First, check to see if your `~/.ssh/config` file exists in the default location.
|
||||
* First, check to see if your `~/.ssh/config` file exists in the default location.
|
||||
|
||||
```shell
|
||||
$ open ~/.ssh/config
|
||||
> The file /Users/<em>you</em>/.ssh/config does not exist.
|
||||
```
|
||||
```shell
|
||||
$ open ~/.ssh/config
|
||||
> The file /Users/<em>you</em>/.ssh/config does not exist.
|
||||
```
|
||||
|
||||
* If the file doesn't exist, create the file.
|
||||
* If the file doesn't exist, create the file.
|
||||
|
||||
```shell
|
||||
$ touch ~/.ssh/config
|
||||
```
|
||||
```shell
|
||||
$ touch ~/.ssh/config
|
||||
```
|
||||
|
||||
* Open your `~/.ssh/config` file, then modify the file to contain the following lines. If your SSH key file has a different name or path than the example code, modify the filename or path to match your current setup.
|
||||
* Open your `~/.ssh/config` file, then modify the file to contain the following lines. If your SSH key file has a different name or path than the example code, modify the filename or path to match your current setup.
|
||||
|
||||
```
|
||||
Host *
|
||||
AddKeysToAgent yes
|
||||
UseKeychain yes
|
||||
IdentityFile ~/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}
|
||||
```
|
||||
```
|
||||
Host *
|
||||
AddKeysToAgent yes
|
||||
UseKeychain yes
|
||||
IdentityFile ~/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}
|
||||
```
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** If you chose not to add a passphrase to your key, you should omit the `UseKeychain` line.
|
||||
|
||||
{% endnote %}
|
||||
**Notes:**
|
||||
|
||||
{% mac %}
|
||||
{% note %}
|
||||
|
||||
**Note:** If you see an error like this
|
||||
|
||||
```
|
||||
/Users/USER/.ssh/config: line 16: Bad configuration option: usekeychain
|
||||
```
|
||||
|
||||
add an additional config line to your `Host *` section:
|
||||
|
||||
```
|
||||
Host *
|
||||
IgnoreUnknown UseKeychain
|
||||
```
|
||||
|
||||
{% endnote %}
|
||||
{% endmac %}
|
||||
- If you chose not to add a passphrase to your key, you should omit the `UseKeychain` line.
|
||||
|
||||
- If you see a `Bad configuration option: usekeychain` error, add an additional line to the configuration's' `Host *` section.
|
||||
|
||||
```
|
||||
Host *
|
||||
IgnoreUnknown UseKeychain
|
||||
```
|
||||
{% endnote %}
|
||||
|
||||
3. Add your SSH private key to the ssh-agent and store your passphrase in the keychain. {% data reusables.ssh.add-ssh-key-to-ssh-agent %}
|
||||
```shell
|
||||
$ ssh-add -K ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}
|
||||
```
|
||||
{% note %}
|
||||
```
|
||||
{% note %}
|
||||
|
||||
**Note:** The `-K` option is Apple's standard version of `ssh-add`, which stores the passphrase in your keychain for you when you add an SSH key to the ssh-agent. If you chose not to add a passphrase to your key, run the command without the `-K` option.
|
||||
**Note:** The `-K` option is Apple's standard version of `ssh-add`, which stores the passphrase in your keychain for you when you add an SSH key to the ssh-agent. If you chose not to add a passphrase to your key, run the command without the `-K` option.
|
||||
|
||||
If you don't have Apple's standard version installed, you may receive an error. For more information on resolving this error, see "[Error: ssh-add: illegal option -- K](/articles/error-ssh-add-illegal-option-k)."
|
||||
If you don't have Apple's standard version installed, you may receive an error. For more information on resolving this error, see "[Error: ssh-add: illegal option -- K](/articles/error-ssh-add-illegal-option-k)."
|
||||
|
||||
In MacOS Monterey (12.0), the `-K` and `-A` flags are deprecated and have been replaced by the `--apple-use-keychain` and `--apple-load-keychain` flags, respectively.
|
||||
In MacOS Monterey (12.0), the `-K` and `-A` flags are deprecated and have been replaced by the `--apple-use-keychain` and `--apple-load-keychain` flags, respectively.
|
||||
|
||||
{% endnote %}
|
||||
{% endnote %}
|
||||
|
||||
4. Add the SSH key to your account on {% data variables.product.product_name %}. For more information, see "[Adding a new SSH key to your {% data variables.product.prodname_dotcom %} account](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account)."
|
||||
|
||||
@@ -163,11 +159,11 @@ Before adding a new SSH key to the ssh-agent to manage your keys, you should hav
|
||||
{% data reusables.desktop.windows_git_bash %}
|
||||
|
||||
1. Ensure the ssh-agent is running. You can use the "Auto-launching the ssh-agent" instructions in "[Working with SSH key passphrases](/articles/working-with-ssh-key-passphrases)", or start it manually:
|
||||
```shell
|
||||
# start the ssh-agent in the background
|
||||
$ eval "$(ssh-agent -s)"
|
||||
> Agent pid 59566
|
||||
```
|
||||
```shell
|
||||
# start the ssh-agent in the background
|
||||
$ eval "$(ssh-agent -s)"
|
||||
> Agent pid 59566
|
||||
```
|
||||
|
||||
2. Add your SSH private key to the ssh-agent. {% data reusables.ssh.add-ssh-key-to-ssh-agent %}
|
||||
{% data reusables.ssh.add-ssh-key-to-ssh-agent-commandline %}
|
||||
@@ -194,59 +190,50 @@ If you are using macOS or Linux, you may need to update your SSH client or insta
|
||||
1. Insert your hardware security key into your computer.
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
3. Paste the text below, substituting in the email address for your account on {% data variables.product.product_name %}.
|
||||
```shell
|
||||
$ ssh-keygen -t {% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}-sk -C "<em>your_email@example.com</em>"
|
||||
```
|
||||
```shell
|
||||
$ ssh-keygen -t {% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}-sk -C "<em>your_email@example.com</em>"
|
||||
```
|
||||
|
||||
{% ifversion not ghae %}
|
||||
{% note %}
|
||||
{%- ifversion not ghae %}
|
||||
{% note %}
|
||||
|
||||
**Note:** If the command fails and you receive the error `invalid format` or `feature not supported,` you may be using a hardware security key that does not support the Ed25519 algorithm. Enter the following command instead.
|
||||
```shell
|
||||
$ ssh-keygen -t ecdsa-sk -C "your_email@example.com"
|
||||
```
|
||||
|
||||
{% endnote %}
|
||||
{% endif %}
|
||||
**Note:** If the command fails and you receive the error `invalid format` or `feature not supported,` you may be using a hardware security key that does not support the Ed25519 algorithm. Enter the following command instead.
|
||||
```shell
|
||||
$ ssh-keygen -t ecdsa-sk -C "your_email@example.com"
|
||||
```
|
||||
|
||||
{% endnote %}
|
||||
{%- endif %}
|
||||
4. When you are prompted, touch the button on your hardware security key.
|
||||
5. When you are prompted to "Enter a file in which to save the key," press Enter to accept the default file location.
|
||||
|
||||
{% mac %}
|
||||
{% mac %}
|
||||
|
||||
```shell
|
||||
> Enter a file in which to save the key (/Users/<em>you</em>/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk): <em>[Press enter]</em>
|
||||
```
|
||||
|
||||
```shell
|
||||
> Enter a file in which to save the key (/Users/<em>you</em>/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk): <em>[Press enter]</em>
|
||||
```
|
||||
{% endmac %}
|
||||
|
||||
{% windows %}
|
||||
|
||||
```shell
|
||||
> Enter a file in which to save the key (/c/Users/<em>you</em>/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk):<em>[Press enter]</em>
|
||||
```
|
||||
|
||||
{% endmac %}
|
||||
|
||||
{% windows %}
|
||||
|
||||
```shell
|
||||
> Enter a file in which to save the key (/c/Users/<em>you</em>/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk):<em>[Press enter]</em>
|
||||
```
|
||||
|
||||
{% endwindows %}
|
||||
|
||||
{% linux %}
|
||||
|
||||
```shell
|
||||
> Enter a file in which to save the key (/home/<em>you</em>/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk): <em>[Press enter]</em>
|
||||
```
|
||||
|
||||
{% endlinux %}
|
||||
{% endwindows %}
|
||||
|
||||
{% linux %}
|
||||
|
||||
```shell
|
||||
> Enter a file in which to save the key (/home/<em>you</em>/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk): <em>[Press enter]</em>
|
||||
```
|
||||
|
||||
{% endlinux %}
|
||||
|
||||
6. When you are prompted to type a passphrase, press **Enter**.
|
||||
```shell
|
||||
> Enter passphrase (empty for no passphrase): <em>[Type a passphrase]</em>
|
||||
> Enter same passphrase again: <em>[Type passphrase again]</em>
|
||||
```
|
||||
```shell
|
||||
> Enter passphrase (empty for no passphrase): <em>[Type a passphrase]</em>
|
||||
> Enter same passphrase again: <em>[Type passphrase again]</em>
|
||||
```
|
||||
7. Add the SSH key to your account on {% data variables.product.prodname_dotcom %}. For more information, see "[Adding a new SSH key to your {% data variables.product.prodname_dotcom %} account](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account)."
|
||||
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[About SSH](/articles/about-ssh)"
|
||||
- "[Working with SSH key passphrases](/articles/working-with-ssh-key-passphrases)"
|
||||
{%- ifversion fpt or ghec %}
|
||||
- "[Authorizing an SSH key for use with SAML single sign-on](/articles/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)"{% ifversion fpt %} in the {% data variables.product.prodname_ghe_cloud %} documentation{% endif %}
|
||||
{%- endif %}
|
||||
|
||||
@@ -16,7 +16,10 @@ topics:
|
||||
- SSH
|
||||
shortTitle: SSH key passphrases
|
||||
---
|
||||
With SSH keys, if someone gains access to your computer, they also gain access to every system that uses that key. To add an extra layer of security, you can add a passphrase to your SSH key. You can use `ssh-agent` to securely save your passphrase so you don't have to reenter it.
|
||||
|
||||
## About passphrases for SSH keys
|
||||
|
||||
With SSH keys, if someone gains access to your computer, the attacker can gain access to every system that uses that key. To add an extra layer of security, you can add a passphrase to your SSH key. To avoid entering the passphrase every time you connect, you can securely save your passphrase in the SSH agent.
|
||||
|
||||
## Adding or changing a passphrase
|
||||
|
||||
@@ -102,7 +105,3 @@ The first time you use your key, you will be prompted to enter your passphrase.
|
||||
Otherwise, you can store your passphrase in the keychain when you add your key to the ssh-agent. For more information, see "[Adding your SSH key to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#adding-your-ssh-key-to-the-ssh-agent)."
|
||||
|
||||
{% endmac %}
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[About SSH](/articles/about-ssh)"
|
||||
|
||||
@@ -28,6 +28,8 @@ Commits and tags have the following verification statuses, depending on whether
|
||||
|
||||
{% data reusables.identity-and-permissions.vigilant-mode-beta-note %}
|
||||
|
||||
Signing commits differs from signing off on a commit. For more information about signing off on commits, see "[Managing the commit signoff policy for your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository)."
|
||||
|
||||
### Default statuses
|
||||
|
||||
| Status | Description |
|
||||
|
||||
@@ -11,6 +11,8 @@ redirect_from:
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Security advisories
|
||||
@@ -23,7 +25,7 @@ topics:
|
||||
|
||||
## About the {% data variables.product.prodname_advisory_database %}
|
||||
|
||||
The {% data variables.product.prodname_advisory_database %} contains a list of known security vulnerabilities and malware, grouped in two categories: {% data variables.product.company_short %}-reviewed advisories and unreviewed advisories.
|
||||
The {% data variables.product.prodname_advisory_database %} contains a list of known security vulnerabilities {% ifversion GH-advisory-db-supports-malware %}and malware, {% endif %}grouped in two categories: {% data variables.product.company_short %}-reviewed advisories and unreviewed advisories.
|
||||
|
||||
{% data reusables.repositories.tracks-vulnerabilities %}
|
||||
|
||||
@@ -31,20 +33,24 @@ The {% data variables.product.prodname_advisory_database %} contains a list of k
|
||||
|
||||
{% data reusables.advisory-database.beta-malware-advisories %}
|
||||
|
||||
Each advisory in the {% data variables.product.prodname_advisory_database %} is for a vulnerability in open source projects or for malicious open source software.
|
||||
Each advisory in the {% data variables.product.prodname_advisory_database %} is for a vulnerability in open source projects{% ifversion GH-advisory-db-supports-malware %} or for malicious open source software{% endif %}.
|
||||
|
||||
{% data reusables.repositories.a-vulnerability-is %} Vulnerabilities in code are usually introduced by accident and fixed soon after they are discovered. You should update your code to use the fixed version of the dependency as soon as it is available.
|
||||
|
||||
{% ifversion GH-advisory-db-supports-malware %}
|
||||
|
||||
In contrast, malicious software, or malware, is code that is intentionally designed to perform unwanted or harmful functions. The malware may target hardware, software, confidential data, or users of any application that uses the malware. You need to remove the malware from your project and find an alternative, more secure replacement for the dependency.
|
||||
|
||||
{% endif %}
|
||||
|
||||
### {% data variables.product.company_short %}-reviewed advisories
|
||||
|
||||
{% data variables.product.company_short %}-reviewed advisories are security vulnerabilities or malware that have been mapped to packages in ecosystems we support. We carefully review each advisory for validity and ensure that they have a full description, and contain both ecosystem and package information.
|
||||
{% data variables.product.company_short %}-reviewed advisories are security vulnerabilities{% ifversion GH-advisory-db-supports-malware %} or malware{% endif %} that have been mapped to packages in ecosystems we support. We carefully review each advisory for validity and ensure that they have a full description, and contain both ecosystem and package information.
|
||||
|
||||
Generally, we name our supported ecosystems after the software programming language's associated package registry. We review advisories if they are for a vulnerability in a package that comes from a supported registry.
|
||||
|
||||
- Composer (registry: https://packagist.org/)
|
||||
- Erlang (registry: https://hex.pm/)
|
||||
- Composer (registry: https://packagist.org/){% ifversion GH-advisory-db-erlang-support %}
|
||||
- Erlang (registry: https://hex.pm/){% endif %}
|
||||
- Go (registry: https://pkg.go.dev/)
|
||||
- Maven (registry: https://repo1.maven.org/maven2/org/)
|
||||
- npm (registry: https://www.npmjs.com/)
|
||||
@@ -55,7 +61,7 @@ Generally, we name our supported ecosystems after the software programming langu
|
||||
|
||||
If you have a suggestion for a new ecosystem we should support, please open an [issue](https://github.com/github/advisory-database/issues) for discussion.
|
||||
|
||||
If you enable {% data variables.product.prodname_dependabot_alerts %} for your repositories, you are automatically notified when a new {% data variables.product.company_short %}-reviewed advisory reports a vulnerability or malware for a package you depend on. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)."
|
||||
If you enable {% data variables.product.prodname_dependabot_alerts %} for your repositories, you are automatically notified when a new {% data variables.product.company_short %}-reviewed advisory reports a vulnerability {% ifversion GH-advisory-db-supports-malware %}or malware{% endif %} for a package you depend on. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)."
|
||||
|
||||
### Unreviewed advisories
|
||||
|
||||
@@ -65,7 +71,7 @@ Unreviewed advisories are security vulnerabilites that we publish automatically
|
||||
|
||||
## About information in security advisories
|
||||
|
||||
Each security advisory contains information about the vulnerability or malware, which may include the description, severity, affected package, package ecosystem, affected versions and patched versions, impact, and optional information such as references, workarounds, and credits. In addition, advisories from the National Vulnerability Database list contain a link to the CVE record, where you can read more details about the vulnerability, its CVSS scores, and its qualitative severity level. For more information, see the "[National Vulnerability Database](https://nvd.nist.gov/)" from the National Institute of Standards and Technology.
|
||||
Each security advisory contains information about the vulnerability{% ifversion GH-advisory-db-supports-malware %} or malware,{% endif %} which may include the description, severity, affected package, package ecosystem, affected versions and patched versions, impact, and optional information such as references, workarounds, and credits. In addition, advisories from the National Vulnerability Database list contain a link to the CVE record, where you can read more details about the vulnerability, its CVSS scores, and its qualitative severity level. For more information, see the "[National Vulnerability Database](https://nvd.nist.gov/)" from the National Institute of Standards and Technology.
|
||||
|
||||
The severity level is one of four possible levels defined in the "[Common Vulnerability Scoring System (CVSS), Section 5](https://www.first.org/cvss/specification-document)."
|
||||
- Low
|
||||
@@ -87,12 +93,12 @@ The {% data variables.product.prodname_advisory_database %} uses the CVSS levels
|
||||
**Tip:** You can use the sidebar on the left to explore {% data variables.product.company_short %}-reviewed and unreviewed advisories separately.
|
||||
|
||||
{% endtip %}
|
||||
3. Click on any advisory to view details. By default, you will see {% data variables.product.company_short %}-reviewed advisories for security vulnerabilities. To show malware advisories, use `type:malware` in the search bar.
|
||||
3. Click an advisory to view details. By default, you will see {% data variables.product.company_short %}-reviewed advisories for security vulnerabilities. {% ifversion GH-advisory-db-supports-malware %}To show malware advisories, use `type:malware` in the search bar.{% endif %}
|
||||
|
||||
|
||||
{% note %}
|
||||
|
||||
The database is also accessible using the GraphQL API. By default, queries will return {% data variables.product.company_short %}-reviewed advisories for security vulnerabilities unless you specify `type:malware`. For more information, see the "[`security_advisory` webhook event](/webhooks/event-payloads/#security_advisory)."
|
||||
The database is also accessible using the GraphQL API. {% ifversion GH-advisory-db-supports-malware %}By default, queries will return {% data variables.product.company_short %}-reviewed advisories for security vulnerabilities unless you specify `type:malware`.{% endif %} For more information, see the "[`security_advisory` webhook event](/webhooks/event-payloads/#security_advisory)."
|
||||
|
||||
{% endnote %}
|
||||
|
||||
@@ -110,8 +116,8 @@ You can search the database, and use qualifiers to narrow your search. For examp
|
||||
| Qualifier | Example |
|
||||
| ------------- | ------------- |
|
||||
| `type:reviewed`| [**type:reviewed**](https://github.com/advisories?query=type%3Areviewed) will show {% data variables.product.company_short %}-reviewed advisories for security vulnerabilities. |
|
||||
| `type:malware` | [**type:malware**](https://github.com/advisories?query=type%3Amalware) will show {% data variables.product.company_short %}-reviewed advisories for malware. |
|
||||
| `type:unreviewed`| [**type:unreviewed**](https://github.com/advisories?query=type%3Aunreviewed) will show unreviewed advisories. |
|
||||
{% ifversion GH-advisory-db-supports-malware %}| `type:malware` | [**type:malware**](https://github.com/advisories?query=type%3Amalware) will show {% data variables.product.company_short %}-reviewed advisories for malware. |
|
||||
{% endif %}| `type:unreviewed`| [**type:unreviewed**](https://github.com/advisories?query=type%3Aunreviewed) will show unreviewed advisories. |
|
||||
| `GHSA-ID`| [**GHSA-49wp-qq6x-g2rf**](https://github.com/advisories?query=GHSA-49wp-qq6x-g2rf) will show the advisory with this {% data variables.product.prodname_advisory_database %} ID. |
|
||||
| `CVE-ID`| [**CVE-2020-28482**](https://github.com/advisories?query=CVE-2020-28482) will show the advisory with this CVE ID number. |
|
||||
| `ecosystem:ECOSYSTEM`| [**ecosystem:npm**](https://github.com/advisories?utf8=%E2%9C%93&query=ecosystem%3Anpm) will show only advisories affecting NPM packages. |
|
||||
@@ -129,7 +135,7 @@ You can search the database, and use qualifiers to narrow your search. For examp
|
||||
|
||||
## Viewing your vulnerable repositories
|
||||
|
||||
For any {% data variables.product.company_short %}-reviewed advisory in the {% data variables.product.prodname_advisory_database %}, you can see which of your repositories are affected by that security vulnerability or malware. To see a vulnerable repository, you must have access to {% data variables.product.prodname_dependabot_alerts %} for that repository. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#access-to-dependabot-alerts)."
|
||||
For any {% data variables.product.company_short %}-reviewed advisory in the {% data variables.product.prodname_advisory_database %}, you can see which of your repositories are affected by that security vulnerability{% ifversion GH-advisory-db-supports-malware %} or malware{% endif %}. To see a vulnerable repository, you must have access to {% data variables.product.prodname_dependabot_alerts %} for that repository. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#access-to-dependabot-alerts)."
|
||||
|
||||
1. Navigate to https://github.com/advisories.
|
||||
2. Click an advisory.
|
||||
@@ -139,6 +145,41 @@ For any {% data variables.product.company_short %}-reviewed advisory in the {% d
|
||||

|
||||
5. For more details about the advisory, and for advice on how to fix the vulnerable repository, click the repository name.
|
||||
|
||||
{% ifversion security-advisories-ghes-ghae %}
|
||||
## Accessing the local advisory database on {% data variables.product.product_location %}
|
||||
|
||||
If your site administrator has enabled {% data variables.product.prodname_github_connect %} for {% data variables.product.product_location %}, you can also browse reviewed advisories locally. For more information, see "[About {% data variables.product.prodname_github_connect %}](/admin/configuration/configuring-github-connect/about-github-connect)".
|
||||
|
||||
You can use your local advisory database to check whether a specific security vulnerability is included, and therefore whether you'd get alerts for vulnerable dependencies. You can also view any vulnerable repositories.
|
||||
|
||||
1. Navigate to `https://HOSTNAME/advisories`.
|
||||
2. Optionally, to filter the list, use any of the drop-down menus.
|
||||

|
||||
{% note %}
|
||||
|
||||
**Note:** Only reviewed advisories will be listed. Unreviewed advisories can be viewed in the {% data variables.product.prodname_advisory_database %} on {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Accessing an advisory in the GitHub Advisory Database](#accessing-an-advisory-in-the-github-advisory-database)".
|
||||
|
||||
{% endnote %}
|
||||
3. Click an advisory to view details.{% ifversion GH-advisory-db-supports-malware %} By default, you will see {% data variables.product.company_short %}-reviewed advisories for security vulnerabilities. To show malware advisories, use `type:malware` in the search bar.{% endif %}
|
||||
|
||||
You can also suggest improvements to any advisory directly from your local advisory database. For more information, see "[Editing advisories from {% data variables.product.product_location %}](/code-security/dependabot/dependabot-alerts/editing-security-advisories-in-the-github-advisory-database#editing-advisories-from-your-github-enterprise-server-instance)".
|
||||
|
||||
### Viewing vulnerable repositories for {% data variables.product.product_location %}
|
||||
|
||||
{% data reusables.repositories.enable-security-alerts %}
|
||||
|
||||
In the local advisory database, you can see which repositories are affected by each security vulnerability{% ifversion GH-advisory-db-supports-malware %} or malware{% endif %}. To see a vulnerable repository, you must have access to {% data variables.product.prodname_dependabot_alerts %} for that repository. For more information, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#access-to-dependabot-alerts)."
|
||||
|
||||
1. Navigate to `https://HOSTNAME/advisories`.
|
||||
2. Click an advisory.
|
||||
3. At the top of the advisory page, click **Dependabot alerts**.
|
||||

|
||||
4. Optionally, to filter the list, use the search bar or the drop-down menus. The "Organization" drop-down menu allows you to filter the {% data variables.product.prodname_dependabot_alerts %} per owner (organization or user).
|
||||

|
||||
5. For more details about the advisory, and for advice on how to fix the vulnerable repository, click the repository name.
|
||||
|
||||
{% endif %}
|
||||
|
||||
## Further reading
|
||||
|
||||
- MITRE's [definition of "vulnerability"](https://www.cve.org/ResourcesSupport/Glossary#vulnerability)
|
||||
|
||||
@@ -7,6 +7,8 @@ redirect_from:
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Security advisories
|
||||
@@ -19,8 +21,9 @@ shortTitle: Edit Advisory Database
|
||||
|
||||
## About editing advisories in the {% data variables.product.prodname_advisory_database %}
|
||||
Security advisories in the {% data variables.product.prodname_advisory_database %} at [github.com/advisories](https://github.com/advisories) are considered global advisories. Anyone can suggest improvements on any global security advisory in the {% data variables.product.prodname_advisory_database %}. You can edit or add any detail, including additionally affected ecosystems, severity level or description of who is impacted. The {% data variables.product.prodname_security %} curation team will review the submitted improvements and publish them onto the {% data variables.product.prodname_advisory_database %} if accepted.
|
||||
{% ifversion fpt or ghec %}
|
||||
Only repository owners and administrators can edit repository-level security advisories. For more information, see "[Editing a repository security advisory](/code-security/security-advisories/editing-a-security-advisory)."{% endif %}
|
||||
|
||||
Only repository owners and administrators can edit repository-level security advisories. For more information, see "[Editing a repository security advisory](/code-security/security-advisories/editing-a-security-advisory)."
|
||||
## Editing advisories in the GitHub Advisory Database
|
||||
|
||||
1. Navigate to https://github.com/advisories.
|
||||
@@ -32,3 +35,15 @@ Only repository owners and administrators can edit repository-level security adv
|
||||
6. Once you submit your improvements, a pull request containing your changes will be created for review in [github/advisory-database](https://github.com/github/advisory-database) by the {% data variables.product.prodname_security %} curation team. If the advisory originated from a {% data variables.product.prodname_dotcom %} repository, we will also tag the original publisher for optional commentary. You can view the pull request and get notifications when it is updated or closed.
|
||||
|
||||
You can also open a pull request directly on an advisory file in the [github/advisory-database](https://github.com/github/advisory-database) repository. For more information, see the [contribution guidelines](https://github.com/github/advisory-database/blob/main/CONTRIBUTING.md).
|
||||
|
||||
{% ifversion security-advisories-ghes-ghae %}
|
||||
## Editing advisories from {% data variables.product.product_location %}
|
||||
|
||||
If you have {% data variables.product.prodname_github_connect %} enabled for {% data variables.product.product_location %}, you will be able to see advisories by adding `/advisories` to the instance url.
|
||||
|
||||
1. Navigate to `https://HOSTNAME/advisories`.
|
||||
2. Select the security advisory you would like to contribute to.
|
||||
3. On the right-hand side of the page, click the **Suggest improvements for this vulnerability on Github.com.** link. A new tab opens with the same security advisory on {% data variables.product.prodname_dotcom_the_website %}.
|
||||

|
||||
4. Edit the advisory, following steps four through six in "[Editing advisories in the GitHub Advisory Database](#editing-advisories-in-the-github-advisory-database)" above.
|
||||
{% endif %}
|
||||
|
||||
@@ -2,8 +2,7 @@
|
||||
title: About discussions
|
||||
intro: 'Use discussions to ask and answer questions, share information, make announcements, and conduct or participate in a conversation about a project on {% data variables.product.product_name %}.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
feature: discussions
|
||||
---
|
||||
|
||||
|
||||
@@ -22,7 +21,7 @@ You might use repository discussions to discuss topics that are specific to the
|
||||
|
||||
You don't need to close a discussion like you close an issue or a pull request.
|
||||
|
||||
If a repository administrator or project maintainer enables {% data variables.product.prodname_discussions %} for a repository, anyone who visits the repository can create and participate in discussions for the repository. If an organization owner enables {% data variables.product.prodname_discussions %} for an organization, anyone who can view the source repository can create an organization discussion.
|
||||
If a repository administrator or project maintainer enables {% data variables.product.prodname_discussions %} for a repository, anyone who has access to the repository can create and participate in discussions for the repository. If an organization owner enables {% data variables.product.prodname_discussions %} for an organization, anyone who can view the source repository can create an organization discussion.
|
||||
|
||||
Repository administrators and project maintainers can manage discussions and discussion categories in a repository, and pin discussions to increase the visibility of the discussion. Moderators and collaborators can mark comments as answers, lock discussions, and convert issues to discussions. Similarly, for organization discussions, the role of a user in the source repository determines how a user can interact with organization discussions. For more information, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)."
|
||||
|
||||
@@ -30,7 +29,7 @@ For more information about management of discussions, see "[Managing discussions
|
||||
|
||||
## About polls
|
||||
|
||||
You can create polls in the polls category to gauge interest in new ideas and project direction. Anyone with read access to your repository can create polls, vote in polls, and view their results. Logged out users can view the results of polls in public repositories.
|
||||
You can create polls in the polls category to gauge interest in new ideas and project direction. Anyone with read access to your repository can create polls, vote in polls, and view their results.{% ifversion fpt or ghec %} Signed out users can view the results of polls in public repositories.{% endif %}
|
||||
|
||||
Polls require a question and at least two options. You can add a maximum of eight options and the options can contain a maximum of 128 characters.
|
||||
|
||||
@@ -71,5 +70,5 @@ You can share your feedback about {% data variables.product.prodname_discussions
|
||||
- "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/github/writing-on-github/about-writing-and-formatting-on-github)"
|
||||
- "[Searching discussions](/search-github/searching-on-github/searching-discussions)"
|
||||
- "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications)"
|
||||
- "[Moderating comments and conversations](/communities/moderating-comments-and-conversations)"
|
||||
- "[Maintaining your safety on {% data variables.product.prodname_dotcom %}](/communities/maintaining-your-safety-on-github)"
|
||||
- "[Moderating comments and conversations](/communities/moderating-comments-and-conversations)"{% ifversion fpt or ghec %}
|
||||
- "[Maintaining your safety on {% data variables.product.prodname_dotcom %}](/communities/maintaining-your-safety-on-github)"{% endif %}
|
||||
|
||||
@@ -4,8 +4,7 @@ shortTitle: Collaborating with maintainers
|
||||
intro: 'You can contribute to the goals, plans, health, and community for a project on {% data variables.product.product_name %} by communicating with the maintainers of the project in a discussion.'
|
||||
permissions: 'People with read access to a repository can start and participate in discussions and polls in the repository. People with read access to the source repository for organization discussions can start and participate in discussions and polls in the organization. {% data reusables.enterprise-accounts.emu-permission-interact %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
feature: discussions
|
||||
---
|
||||
|
||||
|
||||
@@ -55,4 +54,6 @@ You can search for discussions and filter the list of discussions in a repositor
|
||||
## Further reading
|
||||
|
||||
- "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/github/writing-on-github/about-writing-and-formatting-on-github)"
|
||||
{%- ifversion fpt or ghec %}
|
||||
- "[Maintaining your safety on {% data variables.product.prodname_dotcom %}](/communities/maintaining-your-safety-on-github)"
|
||||
{%- endif %}
|
||||
|
||||
@@ -3,8 +3,7 @@ title: Collaborating with your community using discussions
|
||||
shortTitle: Collaborating using discussions
|
||||
intro: Gather and discuss your project with community members and other maintainers.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
feature: discussions
|
||||
children:
|
||||
- /about-discussions
|
||||
- /participating-in-a-discussion
|
||||
|
||||
@@ -3,8 +3,7 @@ title: Participating in a discussion
|
||||
intro: 'You can converse with the community and maintainers in a forum within the repository for a project on {% data variables.product.product_name %}.'
|
||||
permissions: 'People with read access to a repository can participate in discussions and polls in the repository. People with read access to the source repository for organization discussions can participate in discussions and polls in that organization. {% data reusables.enterprise-accounts.emu-permission-interact %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
feature: discussions
|
||||
shortTitle: Participate in discussion
|
||||
---
|
||||
|
||||
@@ -15,7 +14,7 @@ shortTitle: Participate in discussion
|
||||
|
||||
In addition to starting or viewing discussions and polls, you can comment in response to the original comment from the author of the discussion. You can also create a comment thread by replying to an individual comment that another community member made within the discussion, and react to comments with emoji.
|
||||
|
||||
You can block users and report disruptive content to maintain a safe and pleasant environment for yourself on {% data variables.product.product_name %}. For more information, see "[Maintaining your safety on {% data variables.product.prodname_dotcom %}](/communities/maintaining-your-safety-on-github)."
|
||||
{% ifversion fpt or ghec %}You can block users and report disruptive content to maintain a safe and pleasant environment for yourself on {% data variables.product.product_name %}. For more information, see "[Maintaining your safety on {% data variables.product.prodname_dotcom %}](/communities/maintaining-your-safety-on-github)."{% endif %}
|
||||
|
||||
## Prerequisites
|
||||
|
||||
|
||||
@@ -3,8 +3,7 @@ title: Best practices for community conversations on GitHub
|
||||
shortTitle: Best practices for community conversations
|
||||
intro: 'You can use discussions to brainstorm with your team, and eventually move the conversation to an issue when you are ready to scope out the work.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
feature: discussions
|
||||
---
|
||||
|
||||
|
||||
@@ -22,7 +21,7 @@ For more information about opening an issue and cross-referencing a discussion,
|
||||
|
||||
You can create and participate in discussions, issues, and pull requests, depending on the type of conversation you'd like to have.
|
||||
|
||||
You can use {% data variables.product.prodname_discussions %} to discuss big picture ideas, brainstorm, and develop a project's specific details before committing it to an issue, which can then be scoped. {% data variables.product.prodname_discussions %} is useful for teams if:
|
||||
You can use {% data variables.product.prodname_discussions %} to discuss big picture ideas, brainstorm, and develop a project's specific details before committing it to an issue, which can then be scoped. {% data variables.product.prodname_discussions %} is useful for teams in a number of scenarios.
|
||||
- You are in the discovery phase of a project and are still learning which direction your team wants to go in
|
||||
- You want to collect feedback from a wider community about a project
|
||||
- You want to keep bug fixes, feature requests, and general conversations separate
|
||||
@@ -34,7 +33,7 @@ Issues are useful for discussing specific details of a project such as bug repor
|
||||
|
||||
## Following contributing guidelines
|
||||
|
||||
Before you open a discussion in an open source repository, check to see if the repository has contributing guidelines. The CONTRIBUTING file includes information about how the repository maintainer would like you to contribute ideas to the project.
|
||||
Before you open a discussion in a repository, check to see if the repository has contributing guidelines. The CONTRIBUTING file includes information about how the repository maintainer would like you to contribute ideas to the project.
|
||||
|
||||
For more information, see "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)."
|
||||
|
||||
|
||||
@@ -2,8 +2,7 @@
|
||||
title: Finding your discussions
|
||||
intro: You can easily access every discussion you've created or participated in.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
feature: discussions
|
||||
shortTitle: Find discussions
|
||||
redirect_from:
|
||||
- /discussions/guides/finding-discussions-across-multiple-repositories
|
||||
@@ -12,8 +11,7 @@ redirect_from:
|
||||
|
||||
## Finding discussions
|
||||
|
||||
1. Navigate to {% data variables.product.prodname_dotcom_the_website %}.
|
||||
1. In the top-right corner of {% data variables.product.prodname_dotcom_the_website %}, click your profile photo, then click **Your discussions**.
|
||||
1. In the top-right corner of {% data variables.product.product_location %}, click your profile photo, then click **Your discussions**.
|
||||

|
||||
1. Toggle between **Created** and **Commented** to see the discussions you've created or participated in.
|
||||
|
||||
|
||||
@@ -2,8 +2,7 @@
|
||||
title: Granting higher permissions to top contributors
|
||||
intro: Repository administrators can promote any community member to a moderator and maintainer.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
feature: discussions
|
||||
shortTitle: Grant higher permissions
|
||||
---
|
||||
|
||||
@@ -17,10 +16,11 @@ The most helpful contributors for the past 30 days are highlighted on the {% dat
|
||||
{% data reusables.discussions.navigate-to-repo-or-org %}
|
||||
{% data reusables.discussions.discussions-tab %}
|
||||
1. Compare the list of contributors with their access permissions to the repository or, for organization discussions, to the source repository to see who qualifies to moderate the discussion.
|
||||

|
||||
|
||||
## Step 2: Review permission levels for {% data variables.product.prodname_discussions %}
|
||||
|
||||
People with triage permissions for a repository can help moderate a repository's discussions by marking comments as answers, locking discussions that are not longer useful or are damaging to the community, and converting issues to discussions when an idea is still in the early stages of development. Similarly, people with triage permissions for the source repository for organization discussions can moderate the organization's discussions. For more information, see "[Moderating discussions](/discussions/managing-discussions-for-your-community/moderating-discussions)."
|
||||
People with triage permissions for a repository can help moderate that repository's discussions by marking comments as answers, locking discussions that are no longer useful or are damaging to the community, and converting issues to discussions when an idea is still in the early stages of development. Similarly, people with triage permissions for the source repository for organization discussions can moderate the organization's discussions. For more information, see "[Moderating discussions](/discussions/managing-discussions-for-your-community/moderating-discussions)."
|
||||
|
||||
For more information about repository permission levels and {% data variables.product.prodname_discussions %}, see "[Repository permissions levels for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization)."
|
||||
|
||||
|
||||
@@ -3,8 +3,7 @@ title: Discussions guides
|
||||
shortTitle: Guides
|
||||
intro: Discover pathways to get started or learn best practices for participating or monitoring your community's discussions.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
feature: discussions
|
||||
children:
|
||||
- /best-practices-for-community-conversations-on-github
|
||||
- /finding-your-discussions
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: GitHub Discussions Documentation
|
||||
shortTitle: GitHub Discussions
|
||||
intro: '{% data variables.product.prodname_discussions %} is a collaborative communication forum for the community around an open source project. Community members can ask and answer questions, share updates, have open-ended conversations, and follow along on decisions affecting the community''s way of working.'
|
||||
intro: '{% data variables.product.prodname_discussions %} is a collaborative communication forum for the community around an{% ifversion fpt or ghec %} open source or{% endif %} internal project. Community members can ask and answer questions, share updates, have open-ended conversations, and follow along on decisions affecting the community''s way of working.'
|
||||
introLinks:
|
||||
quickstart: /discussions/quickstart
|
||||
featuredLinks:
|
||||
@@ -27,8 +27,7 @@ examples_source: data/product-examples/discussions/community-examples.yml
|
||||
product_video: 'https://www.youtube-nocookie.com/embed/IpBw2SJkFyk'
|
||||
layout: product-landing
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
feature: discussions
|
||||
communityRedirect:
|
||||
name: Provide GitHub Feedback
|
||||
href: 'https://github.com/github/feedback/discussions/categories/discussions-feedback'
|
||||
|
||||
@@ -3,8 +3,7 @@ title: Managing discussions for your community
|
||||
shortTitle: Managing discussions
|
||||
intro: 'You can enable and configure {% data variables.product.prodname_discussions %} for your repository, and you can use tools on {% data variables.product.product_name %} to moderate conversations among community members.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
feature: discussions
|
||||
children:
|
||||
- /managing-discussions
|
||||
- /managing-categories-for-discussions
|
||||
|
||||
@@ -3,8 +3,7 @@ title: Managing categories for discussions
|
||||
intro: 'You can categorize discussions to organize conversations for your community members, and you can choose a format for each category.'
|
||||
permissions: Repository administrators and people with write or greater access to a repository can manage categories for discussions in the repository. Repository administrators and people with write or greater access to the source repository for organization discussions can manage categories for discussions in the organization.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
feature: discussions
|
||||
shortTitle: Manage categories
|
||||
redirect_from:
|
||||
- /discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository
|
||||
@@ -46,7 +45,7 @@ Each category must have a unique name and emoji pairing, and can be accompanied
|
||||
|
||||
You can edit a category to change the category's emoji, title, description, and discussion format.
|
||||
|
||||
1. On {% data variables.product.product_location %}, navigate to the main page of the repository or organization where you want to create a category.
|
||||
1. On {% data variables.product.product_location %}, navigate to the main page of the repository or organization where you want to edit a category.
|
||||
{% data reusables.discussions.discussions-tab %}
|
||||
1. To the right of a category in the list, click {% octicon "pencil" aria-label="The pencil icon" %}.
|
||||

|
||||
@@ -59,7 +58,7 @@ You can edit a category to change the category's emoji, title, description, and
|
||||
|
||||
When you delete a category, {% data variables.product.product_name %} will move all discussions in the deleted category to an existing category that you choose.
|
||||
|
||||
1. On {% data variables.product.product_location %}, navigate to the main page of the repository or organization where you want to create a category.
|
||||
1. On {% data variables.product.product_location %}, navigate to the main page of the repository or organization where you want to delete a category.
|
||||
{% data reusables.discussions.discussions-tab %}
|
||||
1. To the right of a category in the list, click {% octicon "trash" aria-label="The trash icon" %}.
|
||||

|
||||
|
||||
@@ -3,8 +3,7 @@ title: Managing discussions
|
||||
intro: 'You can categorize, spotlight, transfer, or delete the discussions.'
|
||||
permissions: Repository administrators and people with write or greater access to a repository can manage discussions in the repository. Repository administrators and people with write or greater access to the source repository for organization discussions can manage discussions in the organization.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
feature: discussions
|
||||
shortTitle: Manage discussions
|
||||
redirect_from:
|
||||
- /discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository
|
||||
@@ -17,7 +16,7 @@ redirect_from:
|
||||
|
||||
Organization owners can choose the permissions required to create a discussion in repositories owned by the organization. Similarly, to choose the permissions required to create an organization discussion, organization owners can change the permissions required in the source repository. For more information, see "[Managing discussion creation for repositories in your organization](/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization)."
|
||||
|
||||
As a discussions maintainer, you can create community resources to encourage discussions that are aligned with the overall project goal and maintain a friendly open forum for collaborators. Creating a code of conduct or contribution guidelines for collaborators to follow will help facilitate a collaborative and productive forum. For more information on creating community resources, see "[Adding a code of conduct to your project](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)," and "[Setting guidelines for repository contributors](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)."
|
||||
As a discussions maintainer, you can create community resources to encourage discussions that are aligned with the overall project goal and maintain a friendly open forum for collaborators. Creating{% ifversion fpt or ghec %} a code of conduct or{% endif %} contribution guidelines for collaborators to follow will help facilitate a collaborative and productive forum. For more information on creating community resources, see{% ifversion fpt or ghec %} "[Adding a code of conduct to your project](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)," and{% endif %} "[Setting guidelines for repository contributors](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)."
|
||||
|
||||
When a discussion yields an idea or bug that is ready to be worked on, you can create a new issue from a discussion. For more information, see "[Creating an issue](/issues/tracking-your-work-with-issues/creating-an-issue#creating-an-issue-from-a-discussion)."
|
||||
|
||||
@@ -85,7 +84,7 @@ Editing a pinned discussion will not change the discussion's category. For more
|
||||
|
||||
## Transferring a discussion
|
||||
|
||||
To transfer a discussion, you must have permissions to create discussions in the repository where you want to transfer the discussion. If you want to transfer a discussion to an organization, you must have permissions to create discussions in the source repository for the organization's discussions. You can only transfer discussions between repositories owned by the same user or organization account. You can't transfer a discussion from a private repository to a public repository.
|
||||
To transfer a discussion, you must have permissions to create discussions in the repository where you want to transfer the discussion. If you want to transfer a discussion to an organization, you must have permissions to create discussions in the source repository for the organization's discussions. You can only transfer discussions between repositories owned by the same user or organization account. You can't transfer a discussion from a private{% ifversion ghec or ghes %} or internal{% endif %} repository to a public repository.
|
||||
|
||||
{% data reusables.discussions.navigate-to-repo-or-org %}
|
||||
{% data reusables.discussions.discussions-tab %}
|
||||
|
||||
@@ -1,16 +1,15 @@
|
||||
---
|
||||
title: Moderating discussions
|
||||
intro: 'You can promote healthy collaboration by marking comments as answers, locking or unlocking discussions, converting issues to discussions, and editing or deleting comments, discussions, and categories that don''t align with your community''s code of conduct.'
|
||||
intro: 'You can promote healthy collaboration by marking comments as answers, locking or unlocking discussions, converting issues to discussions, and editing or deleting comments, discussions, and categories that don''t align with your{% ifversion fpt or ghec %} community''s code of conduct{% elsif ghes > 3.5 %} organization''s contribution guidelines{% endif %}.'
|
||||
permissions: People with triage access to a repository can moderate discussions in the repository. People with triage access to the source repository for organization discussions can moderate discussions in the organization.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
feature: discussions
|
||||
---
|
||||
|
||||
|
||||
## About moderating discussions
|
||||
|
||||
{% data reusables.discussions.about-discussions %} If you have triage permissions for a repository, you can help moderate a repository's discussions by marking comments as answers, locking discussions that are not longer useful or are damaging to the community, and converting issues to discussions when an idea is still in the early stages of development. Similarly, if you have triage permission for the source repository for organization discussions, you can moderate discussions for that organization.
|
||||
{% data reusables.discussions.about-discussions %} If you have triage permissions for a repository, you can help moderate that repository's discussions by marking comments as answers, locking discussions that are no longer useful or are damaging to the community, and converting issues to discussions when an idea is still in the early stages of development. Similarly, if you have triage permission for the source repository for organization discussions, you can moderate discussions for that organization.
|
||||
|
||||
## Marking a comment as an answer
|
||||
|
||||
|
||||
@@ -3,8 +3,7 @@ title: Viewing insights for your discussions
|
||||
intro: 'Discussions insights provide data about your discussions'' activity, views, and contributors.'
|
||||
permissions: Repository administrators and people with maintain access to a repository can view the insights dashboard for discussions in that repository. Repository administrators and people with maintain access to the source repository for organization discussions can view the insights dashboard for discussions in that organization.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
feature: discussions
|
||||
topics:
|
||||
- Discussions
|
||||
shortTitle: View discussions insights
|
||||
|
||||
@@ -3,21 +3,20 @@ title: Quickstart for GitHub Discussions
|
||||
intro: 'Enable {% data variables.product.prodname_discussions %} on an existing repository or organization and start conversations with your community.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
feature: discussions
|
||||
shortTitle: Quickstart
|
||||
---
|
||||
|
||||
|
||||
## Introduction
|
||||
|
||||
{% data variables.product.prodname_discussions %} is a collaborative communication forum for the community around an open source project. Discussions are for conversations that need to be transparent and accessible but do not need to be tracked on a project board and are not related to code, unlike {% data variables.product.prodname_github_issues %}. Discussions enable fluid, open conversation in a public forum.
|
||||
{% data variables.product.prodname_discussions %} is a collaborative communication forum for the community around an open source or internal project. Discussions are for conversations that need to be transparent and accessible but do not need to be tracked on a project board and are not related to code, unlike {% data variables.product.prodname_github_issues %}. Discussions enable fluid, open conversation in a public forum.
|
||||
|
||||
Discussions give a space for more collaborative conversations by connecting and giving a more centralized area to connect and find information.
|
||||
|
||||
## Enabling {% data variables.product.prodname_discussions %} on your repository
|
||||
|
||||
Repository owners and people with write access can enable {% data variables.product.prodname_discussions %} for a community on their public and private repositories.
|
||||
Repository owners and people with write access can enable {% data variables.product.prodname_discussions %} for a community on their public{% ifversion ghes > 3.5 %}, internal{% endif %} and private repositories. The visibility of a discussion is inherited from the repository the discussion is created in.
|
||||
|
||||
When you first enable {% data variables.product.prodname_discussions %}, you will be invited to configure a welcome post.
|
||||
|
||||
@@ -46,7 +45,7 @@ You can welcome your community and introduce a new way to communicate in a repos
|
||||
|
||||
## Setting up community guidelines for contributors
|
||||
|
||||
For repository discussions, you can set contributing guidelines to encourage collaborators to have meaningful, useful conversations that are relevant to the repository. You can also update the repository's README to communicate expectations on when collaborators should open an issue or discussion. For more information about providing guidelines for your project, see "[Adding a code of conduct to your project](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)" and "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)."
|
||||
For repository discussions, you can set contributing guidelines to encourage collaborators to have meaningful, useful conversations that are relevant to the repository. You can also update the repository's README to communicate expectations on when collaborators should open an issue or discussion. For more information about providing guidelines for your project, see{% ifversion fpt or ghec %} "[Adding a code of conduct to your project](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)" and{% endif %} "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)."
|
||||
|
||||
For organization discussions, you share information about how to engage with your organization by creating an organization profile README. For more information, see "[Customizing your organization's profile](/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile)."
|
||||
|
||||
@@ -66,7 +65,7 @@ Any authenticated user who can view a repository can create a poll. Similarly, s
|
||||
|
||||
Repository owners and people with write access to the repository can create new categories to keep discussions organized. Similarly, since organization discussions are based on a source repository, repository owners and people with write access to the source repository can create new categories for organization discussions.
|
||||
|
||||
Collaborators participating and creating new discussions can group discussions into the most relevant existing categories. Discussions can also be recategorized after they are created. For more information, see "[Managing categories for discussions](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions)."
|
||||
Collaborators participating in and creating new discussions can group discussions into the most relevant existing categories. Discussions can also be recategorized after they are created. For more information, see "[Managing categories for discussions](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions)."
|
||||
|
||||
{% data reusables.discussions.you-can-label-discussions %}
|
||||
|
||||
|
||||
@@ -136,7 +136,7 @@ Notifications provide updates about the activity on {% data variables.product.pr
|
||||
### 8. Working with {% data variables.product.prodname_pages %}
|
||||
You can use {% data variables.product.prodname_pages %} to create and host a website directly from a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. For more information, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)."
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
{% ifversion discussions %}
|
||||
### 9. Using {% data variables.product.prodname_discussions %}
|
||||
You can enable {% data variables.product.prodname_discussions %} for your repository to help build a community around your project. Maintainers, contributors and visitors can use discussions to share announcements, ask and answer questions, and participate in conversations around goals. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)."
|
||||
{% endif %}
|
||||
|
||||
@@ -23,10 +23,9 @@ topics:
|
||||
|
||||
{% data variables.product.product_name %} provides built-in collaborative communication tools allowing you to interact closely with your community. This quickstart guide will show you how to pick the right tool for your needs.
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
{% ifversion discussions %}
|
||||
You can create and participate in issues, pull requests, {% data variables.product.prodname_discussions %}, and team discussions, depending on the type of conversation you'd like to have.
|
||||
{% endif %}
|
||||
{% ifversion ghes or ghae %}
|
||||
{% else %}
|
||||
You can create and participate in issues, pull requests and team discussions, depending on the type of conversation you'd like to have.
|
||||
{% endif %}
|
||||
|
||||
@@ -99,7 +98,7 @@ The **Files changed** tab of the pull request shows the implemented fix.
|
||||
- The user creates a pull request with the fix.
|
||||
- A repository maintainer reviews the pull request, comments on it, and merges it.
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
{% ifversion discussions %}
|
||||
### Scenarios for {% data variables.product.prodname_discussions %}
|
||||
|
||||
- I have a question that's not necessarily related to specific files in the repository.
|
||||
@@ -146,8 +145,8 @@ For issues, for example, you can tag issues with labels for quicker searching an
|
||||
|
||||
For pull requests, you can create draft pull requests if your proposed changes are still a work in progress. Draft pull requests cannot be merged until they're marked as ready for review. For more information, see "[About pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests)."
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
For {% data variables.product.prodname_discussions %}, you can set up a code of conduct and pin discussions that contain important information for your community. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)."
|
||||
{% ifversion discussions %}
|
||||
For {% data variables.product.prodname_discussions %}, you can{% ifversion fpt or ghec %} set up a code of conduct and{% endif %} pin discussions that contain important information for your community. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)."
|
||||
{% endif %}
|
||||
|
||||
For team discussions, you can edit or delete discussions on a team's page, and you can configure notifications for team discussions. For more information, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)."
|
||||
|
||||
@@ -43,7 +43,7 @@ The {% data variables.product.prodname_command_palette %} also gives you quick a
|
||||
|<kbd>G</kbd> <kbd>P</kbd> | Go to the **Pull requests** tab. For more information, see "[About pull requests](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)."{% ifversion fpt or ghes or ghec %}
|
||||
|<kbd>G</kbd> <kbd>A</kbd> | Go to the **Actions** tab. For more information, see "[About Actions](/actions/getting-started-with-github-actions/about-github-actions)."{% endif %}
|
||||
|<kbd>G</kbd> <kbd>B</kbd> | Go to the **Projects** tab. For more information, see "[About project boards](/articles/about-project-boards)."
|
||||
|<kbd>G</kbd> <kbd>W</kbd> | Go to the **Wiki** tab. For more information, see "[About wikis](/communities/documenting-your-project-with-wikis/about-wikis)."{% ifversion fpt or ghec %}
|
||||
|<kbd>G</kbd> <kbd>W</kbd> | Go to the **Wiki** tab. For more information, see "[About wikis](/communities/documenting-your-project-with-wikis/about-wikis)."{% ifversion discussions %}
|
||||
|<kbd>G</kbd> <kbd>G</kbd> | Go to the **Discussions** tab. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)."{% endif %}
|
||||
|
||||
## Source code editing
|
||||
|
||||
@@ -2,8 +2,7 @@
|
||||
title: Using the GraphQL API for Discussions
|
||||
intro: 'Learn how to use the {% data variables.product.prodname_discussions %} GraphQL API.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
feature: discussions
|
||||
shortTitle: Use GraphQL for Discussions
|
||||
---
|
||||
|
||||
|
||||
@@ -47,7 +47,8 @@ To help contributors open meaningful issues that provide the information that yo
|
||||
|
||||
You can @mention collaborators who have access to your repository in an issue to draw their attention to a comment. To link related issues in the same repository, you can type `#` followed by part of the issue title and then clicking the issue that you want to link. To communicate responsibility, you can assign issues. If you find yourself frequently typing the same comment, you can use saved replies.
|
||||
{% ifversion fpt or ghec %} For more information, see "[Basic writing and formatting syntax](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)" and "[Assigning issues and pull requests to other GitHub users](/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users)."
|
||||
|
||||
{% endif %}
|
||||
{% ifversion discussions %}
|
||||
## Comparing issues and discussions
|
||||
|
||||
Some conversations are more suitable for {% data variables.product.prodname_discussions %}. {% data reusables.discussions.you-can-use-discussions %} For guidance on when to use an issue or a discussion, see "[Communicating on GitHub](/github/getting-started-with-github/quickstart/communicating-on-github)."
|
||||
|
||||
@@ -99,7 +99,7 @@ You can open a new issue from a specific line or lines of code in a file or pull
|
||||
{% data reusables.repositories.assign-an-issue-as-project-maintainer %}
|
||||
{% data reusables.repositories.submit-new-issue %}
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
{% ifversion discussions %}
|
||||
|
||||
## Creating an issue from discussion
|
||||
|
||||
|
||||
@@ -816,4 +816,6 @@ For more information, see "[Managing the publication of {% data variables.produc
|
||||
## Further reading
|
||||
|
||||
- "[Keeping your organization secure](/articles/keeping-your-organization-secure)"{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5146 %}
|
||||
{%- ifversion fpt or ghec %}
|
||||
- "[Exporting member information for your organization](/organizations/managing-membership-in-your-organization/exporting-member-information-for-your-organization)"{% endif %}
|
||||
{%- endif %}
|
||||
@@ -134,7 +134,7 @@ Some of the features listed below are limited to organizations using {% data var
|
||||
| [Delete or transfer repositories out of the organization](/articles/setting-permissions-for-deleting-or-transferring-repositories) | | | | | **X** |
|
||||
| [Archive repositories](/articles/about-archiving-repositories) | | | | | **X** |{% ifversion fpt or ghec %}
|
||||
| Display a sponsor button (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)") | | | | | **X** |{% endif %}
|
||||
| Create autolink references to external resources, like Jira or Zendesk (see "[Configuring autolinks to reference external resources](/articles/configuring-autolinks-to-reference-external-resources)") | | | | | **X** |{% ifversion fpt or ghec %}
|
||||
| Create autolink references to external resources, like Jira or Zendesk (see "[Configuring autolinks to reference external resources](/articles/configuring-autolinks-to-reference-external-resources)") | | | | | **X** |{% ifversion discussions %}
|
||||
| [Enable {% data variables.product.prodname_discussions %}](/github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository) in a repository | | | | **X** | **X** |
|
||||
| [Create and edit categories](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions) for {% data variables.product.prodname_discussions %} | | | | **X** | **X** |
|
||||
| [Move a discussion to a different category](/discussions/managing-discussions-for-your-community/managing-discussions) | | | **X** | **X** | **X** |
|
||||
|
||||
@@ -3,8 +3,7 @@ title: Enabling or disabling GitHub Discussions for an organization
|
||||
intro: 'You can use {% data variables.product.prodname_discussions %} in a organization as a place for your organization to have conversations that aren''t specific to a single repository within your organization.'
|
||||
permissions: 'Organization owners can enable {% data variables.product.prodname_discussions %} for their organization.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
feature: discussions
|
||||
topics:
|
||||
- Organizations
|
||||
shortTitle: Organization discussions
|
||||
|
||||
@@ -27,6 +27,7 @@ children:
|
||||
- /allowing-people-to-delete-issues-in-your-organization
|
||||
- /enabling-or-disabling-github-discussions-for-an-organization
|
||||
- /managing-discussion-creation-for-repositories-in-your-organization
|
||||
- /managing-the-commit-signoff-policy-for-your-organization
|
||||
- /setting-team-creation-permissions-in-your-organization
|
||||
- /managing-scheduled-reminders-for-your-organization
|
||||
- /managing-the-default-branch-name-for-repositories-in-your-organization
|
||||
|
||||
@@ -5,8 +5,7 @@ redirect_from:
|
||||
- /github/setting-up-and-managing-organizations-and-teams/managing-discussion-creation-for-repositories-in-your-organization
|
||||
permissions: Organization owners can manage discussion creation for repositories owned by the organization.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
feature: discussions
|
||||
topics:
|
||||
- Organizations
|
||||
- Teams
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
---
|
||||
title: Managing the commit signoff policy for your organization
|
||||
intro: You can require users to automatically sign off all commits they make in {% data variables.product.product_name %}'s web interface to repositories owned by your organization.
|
||||
versions:
|
||||
feature: commit-signoffs
|
||||
permissions: Organization owners can require all commits to repositories owned by the organization be signed off by the commit author.
|
||||
topics:
|
||||
- Organizations
|
||||
shortTitle: Manage the commit signoff policy
|
||||
---
|
||||
|
||||
## About commit signoffs
|
||||
|
||||
To affirm that a commit complies with the rules and licensing governing a repository, many organizations require developers to sign off on every commit. If your organization requires commit signoffs, you can make signing off a seamless part of the commit process by enabling compulsory commit signoffs for users committing through {% data variables.product.product_name %}'s web interface. After you enable compulsory commit signoffs for an organization, every commit made to repositories in that organization through {% data variables.product.product_name %}'s web interface will automatically be signed off on by the commit author.
|
||||
|
||||
People with admin access to a repository can also enable compulsory commit signoffs at the repository level. For more information, see "[Managing the commit signoff policy for your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository)."
|
||||
|
||||
{% data reusables.repositories.commit-signoffs %}
|
||||
|
||||
## Managing compulsory commit signoffs for your organization
|
||||
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.profile.org_settings %}
|
||||
{% data reusables.organizations.repository-defaults %}
|
||||
1. Select or deselect **Require contributors to sign off on web-based commits**.
|
||||

|
||||
@@ -22,6 +22,9 @@ Organization owners can manage the display of member names in an organization.
|
||||
|
||||
Each organization member chooses their own profile name in their settings. For more information, see "[Personalizing your profile](/github/setting-up-and-managing-your-github-profile/personalizing-your-profile#changing-your-profile-name)."
|
||||
|
||||
{% ifversion profile-name-enterprise-setting %}
|
||||
You may not be able to configure this setting for your organization, if an enterprise owner has set a policy at the enterprise level. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)."{% endif %}
|
||||
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.profile.org_settings %}
|
||||
{% data reusables.organizations.member-privileges %}
|
||||
|
||||
@@ -49,7 +49,7 @@ After choosing an inherited role, you can select additional permissions for your
|
||||
|
||||
You can only choose an additional permission if it's not already included in the inherited role. For example, if the inherited role offers **Write** access to a repository, then the "Close a pull request" permission will already be included in the inherited role.
|
||||
|
||||
{% ifversion ghec %}
|
||||
{% ifversion discussions %}
|
||||
### Discussions
|
||||
|
||||
- **Create a discussion category**: Ability to create a new discussion category. For more information, see "[Creating a new discussion category](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions#creating-a-category)".
|
||||
|
||||
@@ -12,10 +12,11 @@ featuredLinks:
|
||||
- /packages/learn-github-packages/installing-a-package
|
||||
popular:
|
||||
- /packages/working-with-a-github-packages-registry/working-with-the-npm-registry
|
||||
- '{% ifversion fpt or ghec or ghes > 3.4 %}/packages/working-with-a-github-packages-registry/working-with-the-container-registry{% else %}/packages/working-with-a-github-packages-registry/working-with-the-docker-registry{% endif %}'
|
||||
- '{% ifversion docker-ghcr-enterprise-migration %}/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry{% endif %}'
|
||||
- /packages/learn-github-packages
|
||||
- /packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry
|
||||
guideCards:
|
||||
- '{% ifversion docker-ghcr-enterprise-migration %}/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry{% endif %}'
|
||||
- '{% ifversion fpt or ghec or ghes > 3.4 %}/packages/working-with-a-github-packages-registry/working-with-the-container-registry{% else %}/packages/working-with-a-github-packages-registry/working-with-the-docker-registry{% endif %}'
|
||||
- /packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry
|
||||
changelog:
|
||||
|
||||
@@ -15,7 +15,7 @@ shortTitle: Access control & visibility
|
||||
|
||||
Packages with granular permissions are scoped to a personal user or organization account. You can change the access control and visibility of a package separately from the repository that it is connected (or linked) to.
|
||||
|
||||
Currently, you can only use granular permissions with the {% data variables.product.prodname_container_registry %}. Granular permissions are not supported in our other package registries, such as the npm registry.
|
||||
Currently, you can only use granular permissions with the {% data variables.product.prodname_container_registry %}. Granular permissions are not supported in our other package registries, such as the npm registry.{% ifversion docker-ghcr-enterprise-migration %} For more information about migration to the {% data variables.product.prodname_container_registry %}, see "[Migrating to the {% data variables.product.prodname_container_registry %} from the Docker registry](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)."{% endif %}
|
||||
|
||||
For more information about permissions for repository-scoped packages, packages-related scopes for PATs, or managing permissions for your actions workflows, see "[About permissions for GitHub Packages](/packages/learn-github-packages/about-permissions-for-github-packages)."
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Migrating to the Container registry from the Docker registry
|
||||
intro: 'Docker images previously stored in the Docker registry are being automatically migrated to the {% data variables.product.prodname_container_registry %}.'
|
||||
intro: '{% ifversion docker-ghcr-enterprise-migration %}An enterprise owner can{% else %}{% data variables.product.company_short %} will{% endif %} migrate Docker images previously stored in the Docker registry on {% data variables.product.product_location %} to the {% data variables.product.prodname_container_registry %}.'
|
||||
product: '{% data reusables.gated-features.packages %}'
|
||||
redirect_from:
|
||||
- /packages/getting-started-with-github-container-registry/migrating-to-github-container-registry-for-docker-images
|
||||
@@ -9,35 +9,61 @@ redirect_from:
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
shortTitle: Migrate to Container registry
|
||||
feature: 'docker-ghcr-enterprise-migration'
|
||||
shortTitle: Migration to Container registry
|
||||
topics:
|
||||
- Containers
|
||||
- Docker
|
||||
- Migration
|
||||
---
|
||||
|
||||
{% data variables.product.prodname_dotcom %}'s Docker registry has been replaced by the {% data variables.product.prodname_container_registry %}. If you've stored Docker images in the Docker registry, they will be automatically moved to the {% data variables.product.prodname_container_registry %}. You don't need to do anything. Any scripts or {% data variables.product.prodname_actions %} workflows that use the namespace for the Docker registry (`docker.pkg.github.com`) will continue to work after the migration to the {% data variables.product.prodname_container_registry %} (`ghcr.io`).
|
||||
{% data reusables.package_registry.container-registry-ghes-beta %}
|
||||
|
||||
Migration is being done gradually, rather than all at once. If your images haven't yet been moved over, hold tight, we'll get to them sometime soon.
|
||||
## About the {% data variables.product.prodname_container_registry %}
|
||||
|
||||
## How can you tell if your images have been migrated?
|
||||
{% data reusables.package_registry.container-registry-benefits %} For more information, see "[Working with the {% data variables.product.prodname_container_registry %}](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)."
|
||||
|
||||
After your Docker images have been migrated to the {% data variables.product.prodname_container_registry %} you will see the following changes on the details page for a package:
|
||||
## About migration from the Docker registry
|
||||
|
||||
* The icon is now the {% data variables.product.prodname_container_registry %} logo, previously it was a Docker logo.
|
||||
* The domain in the pull URL is now `ghcr.io`, previously it was `docker.pkg.github.com`.
|
||||
{% data reusables.package_registry.container-registry-replaces-docker-registry %} If you've stored Docker images in the Docker registry, {% ifversion docker-ghcr-enterprise-migration %}an enterprise owner{% else %}{% data variables.product.company_short %}{% endif %} will gradually migrate the images to the {% data variables.product.prodname_container_registry %}. No action is required on your part.
|
||||
|
||||

|
||||
{% ifversion docker-ghcr-enterprise-migration %}
|
||||
|
||||
## Key differences between the {% data variables.product.prodname_container_registry %} and the Docker registry
|
||||
{% note %}
|
||||
|
||||
The {% data variables.product.prodname_container_registry %} is optimized to support some of the unique needs of containers.
|
||||
**Note**: {% data reusables.package_registry.container-registry-ghes-migration-availability %} For more information about finding the version of {% data variables.product.product_name %} that you use, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs#github-enterprise-server)."
|
||||
|
||||
With the {% data variables.product.prodname_container_registry %} you can:
|
||||
- Store container images within your organization and personal account, or connect them to a repository.
|
||||
- Choose whether to inherit permissions from a repository, or set granular permissions independently of a repository.
|
||||
- Access public container images anonymously.
|
||||
{% endnote %}
|
||||
|
||||
### API queries for details of Docker images
|
||||
{% endif %}
|
||||
|
||||
After migration you'll no longer be able to use the GraphQL API to query for packages of `PackageType` "DOCKER". Instead, you can use the REST API to query for packages with the `package_type` "container". For more information, see the REST API article "[Packages](/rest/reference/packages)."
|
||||
After a Docker image has been migrated to the {% data variables.product.prodname_container_registry %}, you'll see the following changes to the details for the package.
|
||||
|
||||
## Billing
|
||||
- The icon will be the {% data variables.product.prodname_container_registry %} logo instead of the Docker logo.
|
||||
- The domain in the pull URL will be {% data variables.product.prodname_container_registry_namespace %} instead of {% data variables.product.prodname_docker_registry_namespace %}.
|
||||
|
||||
For more information about billing for the {% data variables.product.prodname_container_registry %}, see "[About billing for {% data variables.product.prodname_registry %}](/billing/managing-billing-for-github-packages/about-billing-for-github-packages)."
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||

|
||||
|
||||
{% endif %}
|
||||
|
||||
{% data reusables.package_registry.container-registry-migration-namespaces %}
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
After migration, you'll no longer be able to use the GraphQL API to query for packages with a `PackageType` of "DOCKER". Instead, you can use the REST API to query for packages with a `package_type` of "container". For more information, see "[Packages](/rest/reference/packages)" in the REST API documentation.
|
||||
|
||||
## About billing for {% data variables.product.prodname_container_registry %}
|
||||
|
||||
For more information about billing for the {% data variables.product.prodname_container_registry %}, see "[About billing for {% data variables.product.prodname_registry %}](/billing/managing-billing-for-github-packages/about-billing-for-github-packages)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% ifversion docker-ghcr-enterprise-migration %}
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[Migrating your enterprise to the {% data variables.product.prodname_container_registry %} from the Docker registry](/admin/packages/migrating-your-enterprise-to-the-container-registry-from-the-docker-registry)"
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -18,19 +18,19 @@ versions:
|
||||
ghes: '>= 3.5'
|
||||
shortTitle: Container registry
|
||||
---
|
||||
{% ifversion ghes > 3.4 %}
|
||||
{% note %}
|
||||
|
||||
**Note**: {% data variables.product.prodname_container_registry %} is currently in beta for {% data variables.product.product_name %} and subject to change.
|
||||
{% data reusables.package_registry.container-registry-ghes-beta %}
|
||||
|
||||
{% endnote %}
|
||||
{% endif %}
|
||||
## About the {% data variables.product.prodname_container_registry %}
|
||||
|
||||
{% data reusables.package_registry.container-registry-benefits %}
|
||||
|
||||
{% ifversion ghes > 3.4 %}
|
||||
## Prerequisites
|
||||
|
||||
To configure and use the {% data variables.product.prodname_container_registry %} on {% data variables.product.prodname_ghe_server %}, your site administrator must first enable {% data variables.product.prodname_registry %} **and** subdomain isolation. For more information, see "[Getting started with GitHub Packages for your enterprise](/admin/packages/getting-started-with-github-packages-for-your-enterprise)" and "[Enabling subdomain isolation](/admin/configuration/configuring-network-settings/enabling-subdomain-isolation)."
|
||||
To use the {% data variables.product.prodname_container_registry %} on {% data variables.product.product_name %}, your site administrator must first configure {% data variables.product.prodname_registry %} for your instance **and** enable subdomain isolation. For more information, see "[Getting started with GitHub Packages for your enterprise](/admin/packages/getting-started-with-github-packages-for-your-enterprise)" and "[Enabling subdomain isolation](/admin/configuration/configuring-network-settings/enabling-subdomain-isolation)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
## About {% data variables.product.prodname_container_registry %} support
|
||||
|
||||
The {% data variables.product.prodname_container_registry %} currently supports the following container image formats:
|
||||
|
||||
@@ -17,6 +17,9 @@ versions:
|
||||
|
||||
{% data reusables.commits.about-commits %}
|
||||
|
||||
{% ifversion commit-signoffs %}
|
||||
If the repository you are committing to has compulsory commit signoffs enabled, and you are committing via the web interface, you will automatically sign off on the commit as part of the commit process. For more information, see "[Managing the commit signoff policy for your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository)." {% endif %}
|
||||
|
||||
You can add a co-author on any commits you collaborate on. For more information, see "[Creating a commit with multiple authors](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors)."
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
@@ -1,11 +1,9 @@
|
||||
---
|
||||
title: Enabling or disabling GitHub Discussions for a repository
|
||||
intro: 'You can use {% data variables.product.prodname_discussions %} in a repository as a place for your community to have conversations, ask questions, and post answers without scoping work in an issue.'
|
||||
product: '{% data reusables.gated-features.discussions %}'
|
||||
permissions: 'People with admin permissions to a repository can enable {% data variables.product.prodname_discussions %} for the repository.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
feature: discussions
|
||||
topics:
|
||||
- Repositories
|
||||
redirect_from:
|
||||
|
||||
@@ -13,6 +13,7 @@ children:
|
||||
- /managing-teams-and-people-with-access-to-your-repository
|
||||
- /managing-the-forking-policy-for-your-repository
|
||||
- /managing-pull-request-reviews-in-your-repository
|
||||
- /managing-the-commit-signoff-policy-for-your-repository
|
||||
- /managing-git-lfs-objects-in-archives-of-your-repository
|
||||
- /enabling-anonymous-git-read-access-for-a-repository
|
||||
- /about-email-notifications-for-pushes-to-your-repository
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
---
|
||||
title: Managing the commit signoff policy for your repository
|
||||
intro: You can require users to automatically sign off on the commits they make to your repository using {% data variables.product.product_name %}'s web interface.
|
||||
versions:
|
||||
feature: commit-signoffs
|
||||
permissions: Organization owners and repository administrators can require all commits to a repository to be signed off by the commit author.
|
||||
topics:
|
||||
- Repositories
|
||||
shortTitle: Manage the commit signoff policy
|
||||
---
|
||||
|
||||
## About commit signoffs
|
||||
|
||||
Commit signoffs enable users to affirm that a commit complies with the rules and licensing governing a repository. You can enable compulsory commit signoffs on individual repositories for users committing through {% data variables.product.product_location %}'s web interface, making signing off on a commit a seemless part of the commit process. Once compulsory commit signoffs are enabled for a repository, every commit made to that repository through {% data variables.product.product_location %}'s web interface will automatically be signed off on by the commit author.
|
||||
|
||||
Organization owners can also enable compulsory commit signoffs at the organization level. For more information, see "[Managing the commit signoff policy for your organization](/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization)."
|
||||
|
||||
{% data reusables.repositories.commit-signoffs %}
|
||||
|
||||
## Enabling or disabling compulsory commit signoffs for your repository
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
1. Select **Require contributors to sign off on web-based commits**.
|
||||

|
||||
@@ -64,7 +64,7 @@ You can choose whether {% data variables.large_files.product_name_long %} ({% da
|
||||

|
||||
2. To notify users that the release is not ready for production and may be unstable, select **This is a pre-release**.
|
||||

|
||||
{%- ifversion fpt or ghec %}
|
||||
{%- ifversion discussions %}
|
||||
1. Optionally, if {% data variables.product.prodname_discussions %} are enabled in the repository, select **Create a discussion for this release**, then select the **Category** drop-down menu and click a category for the release discussion.
|
||||

|
||||
{%- endif %}
|
||||
|
||||
@@ -2,8 +2,7 @@
|
||||
title: Searching discussions
|
||||
intro: 'You can search for discussions on {% data variables.product.product_name %} and narrow the results using search qualifiers.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
feature: discussions
|
||||
topics:
|
||||
- GitHub search
|
||||
redirect_from:
|
||||
|
||||
7
data/features/GH-advisory-db-erlang-support.yml
Normal file
@@ -0,0 +1,7 @@
|
||||
# Reference: Issue #6207.
|
||||
# We have added support for Elixir advisories to the Advisory Database.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '>=3.7'
|
||||
ghae: 'issue-6207'
|
||||
5
data/features/audit-log-streaming.yml
Normal file
@@ -0,0 +1,5 @@
|
||||
# Reference: #7055
|
||||
# Documentation for audit log streaming
|
||||
versions:
|
||||
ghec: '*'
|
||||
ghes: '>= 3.6'
|
||||
5
data/features/commit-signoffs.yml
Normal file
@@ -0,0 +1,5 @@
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '>=3.6'
|
||||
ghae: 'issue-6049'
|
||||
4
data/features/discussions.yml
Normal file
@@ -0,0 +1,4 @@
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '>=3.6'
|
||||
4
data/features/docker-ghcr-enterprise-migration.yml
Normal file
@@ -0,0 +1,4 @@
|
||||
# Reference: #7360
|
||||
# Documentation for migration from Docker registry to Container registry for enterprise products
|
||||
versions:
|
||||
ghes: '>= 3.6'
|
||||
@@ -1,5 +1,5 @@
|
||||
# docs-content 7314. GHAS enablement webhook
|
||||
versions:
|
||||
ghec: '*'
|
||||
ghes: '>3.6'
|
||||
ghes: '>= 3.6'
|
||||
ghae: 'issue-7314'
|
||||
|
||||
7
data/features/motion-management.yml
Normal file
@@ -0,0 +1,7 @@
|
||||
# Issue 6523
|
||||
# Support for customizing the automatic playback of animated images in the web interface
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghes: '>=3.6'
|
||||
ghae: 'issue-6523'
|
||||
4
data/features/pause-audit-log-stream.yml
Normal file
@@ -0,0 +1,4 @@
|
||||
# Reference #4640
|
||||
# Documentation for pausing an audit log stream
|
||||
versions:
|
||||
ghec: '*'
|
||||
4
data/features/profile-name-enterprise-setting.yaml
Normal file
@@ -0,0 +1,4 @@
|
||||
# Reference: Issue #6996 ability to show users' first/last name instead of username in issue/PR comment titles for public and internal repos
|
||||
versions:
|
||||
ghes: '>=3.6'
|
||||
ghae: 'issue-6996'
|
||||
4
data/features/require-tls-for-smtp.yml
Normal file
@@ -0,0 +1,4 @@
|
||||
# Reference 7394
|
||||
# Documentation for the option to enforce TLS encryption for incoming SMTP connections
|
||||
versions:
|
||||
ghes: '>=3.6'
|
||||
4
data/features/security-advisories-ghes-ghae.yml
Normal file
@@ -0,0 +1,4 @@
|
||||
# Reference: Issue #6982 Community Contributions to Security Advisories - Enterprise 3.6
|
||||
versions:
|
||||
ghes: '>=3.6'
|
||||
ghae: 'issue-6982'
|
||||
122
data/graphql/ghes-3.6/graphql_previews.enterprise.yml
Normal file
@@ -0,0 +1,122 @@
|
||||
- title: Access to package version deletion
|
||||
description: >-
|
||||
This preview adds support for the DeletePackageVersion mutation which
|
||||
enables deletion of private package versions.
|
||||
toggled_by: ':package-deletes-preview'
|
||||
announcement: null
|
||||
updates: null
|
||||
toggled_on:
|
||||
- Mutation.deletePackageVersion
|
||||
owning_teams:
|
||||
- '@github/pe-package-registry'
|
||||
- title: Deployments
|
||||
description: >-
|
||||
This preview adds support for deployments mutations and new deployments
|
||||
features.
|
||||
toggled_by: ':flash-preview'
|
||||
announcement: null
|
||||
updates: null
|
||||
toggled_on:
|
||||
- DeploymentStatus.environment
|
||||
- Mutation.createDeploymentStatus
|
||||
- CreateDeploymentStatusInput
|
||||
- CreateDeploymentStatusPayload
|
||||
- Mutation.createDeployment
|
||||
- CreateDeploymentInput
|
||||
- CreateDeploymentPayload
|
||||
owning_teams:
|
||||
- '@github/c2c-actions-service'
|
||||
- title: >-
|
||||
MergeInfoPreview - More detailed information about a pull request's merge
|
||||
state.
|
||||
description: >-
|
||||
This preview adds support for accessing fields that provide more detailed
|
||||
information about a pull request's merge state.
|
||||
toggled_by: ':merge-info-preview'
|
||||
announcement: null
|
||||
updates: null
|
||||
toggled_on:
|
||||
- PullRequest.canBeRebased
|
||||
- PullRequest.mergeStateStatus
|
||||
owning_teams:
|
||||
- '@github/pe-pull-requests'
|
||||
- title: UpdateRefsPreview - Update multiple refs in a single operation.
|
||||
description: This preview adds support for updating multiple refs in a single operation.
|
||||
toggled_by: ':update-refs-preview'
|
||||
announcement: null
|
||||
updates: null
|
||||
toggled_on:
|
||||
- Mutation.updateRefs
|
||||
- GitRefname
|
||||
- RefUpdate
|
||||
- UpdateRefsInput
|
||||
- UpdateRefsPayload
|
||||
owning_teams:
|
||||
- '@github/reponauts'
|
||||
- title: Project Event Details
|
||||
description: >-
|
||||
This preview adds project, project card, and project column details to
|
||||
project-related issue events.
|
||||
toggled_by: ':starfox-preview'
|
||||
announcement: null
|
||||
updates: null
|
||||
toggled_on:
|
||||
- AddedToProjectEvent.project
|
||||
- AddedToProjectEvent.projectCard
|
||||
- AddedToProjectEvent.projectColumnName
|
||||
- ConvertedNoteToIssueEvent.project
|
||||
- ConvertedNoteToIssueEvent.projectCard
|
||||
- ConvertedNoteToIssueEvent.projectColumnName
|
||||
- MovedColumnsInProjectEvent.project
|
||||
- MovedColumnsInProjectEvent.projectCard
|
||||
- MovedColumnsInProjectEvent.projectColumnName
|
||||
- MovedColumnsInProjectEvent.previousProjectColumnName
|
||||
- RemovedFromProjectEvent.project
|
||||
- RemovedFromProjectEvent.projectColumnName
|
||||
owning_teams:
|
||||
- '@github/github-projects'
|
||||
- title: Labels Preview
|
||||
description: >-
|
||||
This preview adds support for adding, updating, creating and deleting
|
||||
labels.
|
||||
toggled_by: ':bane-preview'
|
||||
announcement: null
|
||||
updates: null
|
||||
toggled_on:
|
||||
- Mutation.createLabel
|
||||
- CreateLabelPayload
|
||||
- CreateLabelInput
|
||||
- Mutation.deleteLabel
|
||||
- DeleteLabelPayload
|
||||
- DeleteLabelInput
|
||||
- Mutation.updateLabel
|
||||
- UpdateLabelPayload
|
||||
- UpdateLabelInput
|
||||
owning_teams:
|
||||
- '@github/pe-pull-requests'
|
||||
- title: Import Project
|
||||
description: This preview adds support for importing projects.
|
||||
toggled_by: ':slothette-preview'
|
||||
announcement: null
|
||||
updates: null
|
||||
toggled_on:
|
||||
- Mutation.importProject
|
||||
owning_teams:
|
||||
- '@github/pe-issues-projects'
|
||||
- title: Team Review Assignments Preview
|
||||
description: >-
|
||||
This preview adds support for updating the settings for team review
|
||||
assignment.
|
||||
toggled_by: ':stone-crop-preview'
|
||||
announcement: null
|
||||
updates: null
|
||||
toggled_on:
|
||||
- Mutation.updateTeamReviewAssignment
|
||||
- UpdateTeamReviewAssignmentInput
|
||||
- TeamReviewAssignmentAlgorithm
|
||||
- Team.reviewRequestDelegationEnabled
|
||||
- Team.reviewRequestDelegationAlgorithm
|
||||
- Team.reviewRequestDelegationMemberCount
|
||||
- Team.reviewRequestDelegationNotifyTeam
|
||||
owning_teams:
|
||||
- '@github/pe-pull-requests'
|
||||
@@ -0,0 +1,86 @@
|
||||
---
|
||||
upcoming_changes:
|
||||
- location: LegacyMigration.uploadUrlTemplate
|
||||
description: '`uploadUrlTemplate` will be removed. Use `uploadUrl` instead.'
|
||||
reason:
|
||||
'`uploadUrlTemplate` is being removed because it is not a standard URL and
|
||||
adds an extra user step.'
|
||||
date: '2019-04-01T00:00:00+00:00'
|
||||
criticality: breaking
|
||||
owner: tambling
|
||||
- location: AssignedEvent.user
|
||||
description: '`user` will be removed. Use the `assignee` field instead.'
|
||||
reason: Assignees can now be mannequins.
|
||||
date: '2020-01-01T00:00:00+00:00'
|
||||
criticality: breaking
|
||||
owner: tambling
|
||||
- location: UnassignedEvent.user
|
||||
description: '`user` will be removed. Use the `assignee` field instead.'
|
||||
reason: Assignees can now be mannequins.
|
||||
date: '2020-01-01T00:00:00+00:00'
|
||||
criticality: breaking
|
||||
owner: tambling
|
||||
- location: Issue.timeline
|
||||
description: '`timeline` will be removed. Use Issue.timelineItems instead.'
|
||||
reason: '`timeline` will be removed'
|
||||
date: '2020-10-01T00:00:00+00:00'
|
||||
criticality: breaking
|
||||
owner: mikesea
|
||||
- location: PullRequest.timeline
|
||||
description: '`timeline` will be removed. Use PullRequest.timelineItems instead.'
|
||||
reason: '`timeline` will be removed'
|
||||
date: '2020-10-01T00:00:00+00:00'
|
||||
criticality: breaking
|
||||
owner: mikesea
|
||||
- location: MergeStateStatus.DRAFT
|
||||
description: '`DRAFT` will be removed. Use PullRequest.isDraft instead.'
|
||||
reason:
|
||||
DRAFT state will be removed from this enum and `isDraft` should be used
|
||||
instead
|
||||
date: '2021-01-01T00:00:00+00:00'
|
||||
criticality: breaking
|
||||
owner: nplasterer
|
||||
- location: PackageType.DOCKER
|
||||
description: '`DOCKER` will be removed.'
|
||||
reason:
|
||||
DOCKER will be removed from this enum as this type will be migrated to only
|
||||
be used by the Packages REST API.
|
||||
date: '2021-06-21'
|
||||
criticality: breaking
|
||||
owner: reybard
|
||||
- location: ReactionGroup.users
|
||||
description: '`users` will be removed. Use the `reactors` field instead.'
|
||||
reason: Reactors can now be mannequins, bots, and organizations.
|
||||
date: '2021-10-01T00:00:00+00:00'
|
||||
criticality: breaking
|
||||
owner: synthead
|
||||
- location: Repository.defaultMergeQueue
|
||||
description: '`defaultMergeQueue` will be removed. Use `Repository.mergeQueue` instead.'
|
||||
reason: '`defaultMergeQueue` will be removed.'
|
||||
date: '2022-04-01'
|
||||
criticality: breaking
|
||||
owner: colinshum
|
||||
- location: AddPullRequestToMergeQueueInput.branch
|
||||
description: '`branch` will be removed.'
|
||||
reason:
|
||||
PRs are added to the merge queue for the base branch, the `branch` argument
|
||||
is now a no-op
|
||||
date: '2022-07-01T00:00:00+00:00'
|
||||
criticality: breaking
|
||||
owner: jhunschejones
|
||||
- location: Enterprise.userAccounts
|
||||
description:
|
||||
'`userAccounts` will be removed. Use the `Enterprise.members` field
|
||||
instead.'
|
||||
reason: The `Enterprise.userAccounts` field is being removed.
|
||||
date: '2022-07-01T00:00:00+00:00'
|
||||
criticality: breaking
|
||||
owner: jdennes
|
||||
- location: RemovePullRequestFromMergeQueueInput.branch
|
||||
description: '`branch` will be removed.'
|
||||
reason:
|
||||
PRs are removed from the merge queue for the base branch, the `branch` argument
|
||||
is now a no-op
|
||||
date: '2022-10-01T00:00:00+00:00'
|
||||
criticality: breaking
|
||||
owner: jhunschejones
|
||||
44270
data/graphql/ghes-3.6/schema.docs-enterprise.graphql
Normal file
301
data/release-notes/enterprise-server/3-6/0-rc1.yml
Normal file
@@ -0,0 +1,301 @@
|
||||
date: '2022-07-26'
|
||||
release_candidate: true
|
||||
deprecated: false
|
||||
intro: |
|
||||
{% note %}
|
||||
|
||||
**Note:** If {% data variables.product.product_location %} is running a release candidate build, you can't upgrade with a hotpatch. We recommend that you only run release candidates in a test environment.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
For upgrade instructions, see "[Upgrading {% data variables.product.prodname_ghe_server %}](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server)."
|
||||
sections:
|
||||
features:
|
||||
- heading: Infrastructure
|
||||
notes:
|
||||
# https://github.com/github/releases/issues/2002
|
||||
- |
|
||||
Repository caching is generally available. Repository caching increases Git read performance for distributed developers, providing the data locality and convenience of geo-replication without impact on push workflows. With the general availability release, GitHub Enterprise Server caches both Git and Git LFS data. For more information, see "[About repository caching](/admin/enterprise-management/caching-repositories/about-repository-caching)."
|
||||
|
||||
- heading: Instance security
|
||||
notes:
|
||||
# https://github.com/github/releases/issues/1569
|
||||
- |
|
||||
GitHub has changed the supported algorithms and hash functions for all SSH connections to GitHub Enterprise Server, disabled the unencrypted and unauthenticated Git protocol, and optionally allowed the advertisement of an Ed25519 host key. For more information, see the [GitHub Blog](https://github.blog/2022-06-28-improving-git-protocol-security-on-github-enterprise-server/) and the following articles.
|
||||
|
||||
- "[Configuring SSH connections to your instance](/admin/configuration/configuring-your-enterprise/configuring-ssh-connections-to-your-instance)"
|
||||
- "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)"
|
||||
- "[Configuring host keys for your instance](/admin/configuration/configuring-your-enterprise/configuring-host-keys-for-your-instance)"
|
||||
|
||||
# https://github.com/github/releases/issues/2341
|
||||
- |
|
||||
You can require TLS encryption for incoming SMTP connections to your instance. For more information, see "[Configuring email for notifications](/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications)."
|
||||
|
||||
- heading: Audit logs
|
||||
notes:
|
||||
# https://github.com/github/releases/issues/1438
|
||||
- |
|
||||
You can stream audit log and Git events for your instance to Amazon S3, Azure Blob Storage, Azure Event Hubs, Google Cloud Storage, or Splunk. Audit log streaming is in public beta and subject to change. For more information, see "[Streaming the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise)."
|
||||
|
||||
- heading: GitHub Connect
|
||||
notes:
|
||||
# https://github.com/github/releases/issues/2306
|
||||
- |
|
||||
Server Statistics is now generally available. Server Statistics collects aggregate usage data from your GitHub Enterprise Server instance, which you can use to better anticipate the needs of your organization, understand how your team works, and show the value you get from GitHub Enterprise Server. For more information, see "[About Server Statistics](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics)."
|
||||
|
||||
- heading: Administrator experience
|
||||
notes:
|
||||
# https://github.com/github/releases/issues/2351
|
||||
- |
|
||||
Enterprise owners can join organizations on the instance as a member or owner from the enterprise account's **Organizations** page. For more information, see "[Managing your role in an organization owned by your enterprise](/admin/user-management/managing-organizations-in-your-enterprise/managing-your-role-in-an-organization-owned-by-your-enterprise)."
|
||||
|
||||
# https://github.com/github/releases/issues/2221
|
||||
- |
|
||||
Enterprise owners can allow users to dismiss the configured global announcement banner. For more information, see "[Customizing user messages for your enterprise](/admin/user-management/managing-users-in-your-enterprise/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner)."
|
||||
|
||||
- heading: GitHub Advanced Security
|
||||
notes:
|
||||
# https://github.com/github/releases/issues/2321
|
||||
- |
|
||||
Users on an instance with a GitHub Advanced Security license can opt to receive a webhook event that triggers when an organization owner or repository administrator enables or disables a code security or analysis feature. For more information, see the following documentation.
|
||||
|
||||
- "[Webhook events and payloads](/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security_and_analysis)" in the webhook documentation
|
||||
- "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization)"
|
||||
- "[Managing security and analysis features for your repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)"
|
||||
|
||||
# https://github.com/github/releases/issues/2191
|
||||
- |
|
||||
Users on an instance with a GitHub Advanced Security license can optionally add a comment when dismissing a code scanning alert in the web UI or via the REST API. Dismissal comments appear in the event timeline. Users can also add or retrieve a dismissal comment via the REST API. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests#dismissing-an-alert-on-your-pull-request)" and "[Code Scanning](/rest/code-scanning#update-a-code-scanning-alert)" in the REST API documentation.
|
||||
|
||||
# https://github.com/github/releases/issues/2228
|
||||
- |
|
||||
On instances with a GitHub Advanced Security license, secret scanning prevents the leak of secrets in the web editor. For more information, see "[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#using-secret-scanning-as-a-push-protection-from-the-web-ui)."
|
||||
|
||||
# https://github.com/github/releases/issues/2318
|
||||
# https://github.com/github/releases/issues/2277
|
||||
- |
|
||||
Enterprise owners and users on an instance with a GitHub Advanced Security license can view secret scanning alerts and bypasses of secret scanning's push protection in the enterprise and organization audit logs, and via the REST API. For more information, see the following documentation.
|
||||
|
||||
- "[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)"
|
||||
- "[Audit log events for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise#secret_scanning_push_protection-category-actions)"
|
||||
- "[Reviewing the audit log for your organization](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#secret_scanning_push_protection-category-actions)"
|
||||
- "[Secret Scanning](/rest/secret-scanning#list-secret-scanning-alerts-for-an-enterprise)" in the REST API documentation
|
||||
|
||||
# https://github.com/github/releases/issues/2230
|
||||
# https://github.com/github/releases/issues/2317
|
||||
- |
|
||||
Enterprise owners on an instance with a GitHub Advanced Security license can perform dry runs of custom secret scanning patterns for the enterprise, and all users can perform dry runs when editing a pattern. Dry runs allow you to understand a pattern's impact across the entire instance and hone the pattern before publication and generation of alerts. For more information, see "[Defining custom patterns for secret scanning](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning)."
|
||||
|
||||
# https://github.com/github/releases/issues/2236
|
||||
- |
|
||||
Users on an instance with a GitHub Advanced Security license can use `sort` and `direction` parameters in the REST API when retrieving secret scanning alerts, and sort based on the alert’s `created` or `updated` fields. The new parameters are available for the entire instance, or for individual organizations or repositories. For more information, see the following documentation.
|
||||
|
||||
- "[List secret scanning alerts for an enterprise](/rest/secret-scanning#list-secret-scanning-alerts-for-an-enterprise)"
|
||||
- "[List secret scanning alerts for an organization](/rest/secret-scanning#list-secret-scanning-alerts-for-an-organization)"
|
||||
- "[List secret scanning alerts for a repository](/rest/secret-scanning#list-secret-scanning-alerts-for-a-repository)"
|
||||
- "[Secret Scanning](/rest/secret-scanning)" in the REST API documentation
|
||||
|
||||
# https://github.com/github/releases/issues/2263
|
||||
- |
|
||||
The contents of the `github/codeql-go` repository have moved to the `github/codeql` repository, to live alongside similar libraries for all other programming languages supported by CodeQL. The open-source CodeQL queries, libraries, and extractor for analyzing codebases written in the Go programming language with GitHub's CodeQL code analysis tools can now be found in the new location. For more information, including guidance on migrating your existing workflows, see [github/codeql-go#741](https://github.com/github/codeql-go/issues/741).
|
||||
|
||||
- heading: Dependabot
|
||||
notes:
|
||||
# https://github.com/github/releases/issues/2256
|
||||
- |
|
||||
Enterprise owners on instances with a GitHub Advanced Security license can see an overview of Dependabot alerts for the entire instance, including a repository-centric view of application security risks, and an alert-centric view of all secret scanning and Dependabot alerts. The views are in beta and subject to change, and alert-centric views for code scanning are planned for a future release of GitHub Enterprise Server. For more information, see "[Viewing the security overview](/code-security/security-overview/viewing-the-security-overview#viewing-the-security-overview-for-an-enterprise)."
|
||||
|
||||
# https://github.com/github/releases/issues/1993
|
||||
- |
|
||||
Dependabot alerts show users if repository code calls vulnerable functions. Individual alerts display a "vulnerable call" label and code snippet, and users can filter search by `has:vulnerable-calls`. Vulnerable functions are curated during publication to the [GitHub Advisory Database](https://github.com/advisories). New incoming Python advisories will be supported, and GitHub is backfilling known vulnerable functions for historical Python advisories. After beta testing with Python, GitHub will add support for other ecosystems. For more information, see "[Viewing and updating Dependabot alerts](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts)."
|
||||
|
||||
# https://github.com/github/releases/issues/2160
|
||||
- |
|
||||
Users can select multiple Dependabot alerts, then dismiss or reopen or dismiss the alerts. For example, from the **Closed alerts** tab, you can select multiple alerts that have been previously dismissed, and then reopen them all at once. For more information, see "[About Dependabot alerts](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies)."
|
||||
|
||||
# https://github.com/github/releases/issues/2232
|
||||
- |
|
||||
Dependabot updates `@types` dependencies alongside corresponding packages in TypeScript projects. Before this change, users would see separate pull requests for a package and the corresponding `@types` package. This feature is automatically enabled for repositories containing `@types` packages in the project's `devDependencies` within the _package.json_ file. You can disable this behavior by setting the [`ignore`](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#ignore) field in your `dependabot.yml` file to `@types/*`. For more information, see "[About Dependabot version updates](/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates)" and "[Configuration options for the _dependabot.yml_ file](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file)."
|
||||
|
||||
- heading: Code security
|
||||
notes:
|
||||
# https://github.com/github/releases/issues/2098
|
||||
# https://github.com/github/releases/issues/2282
|
||||
- |
|
||||
GitHub Actions can enforce dependency reviews on users' pull requests by scanning for dependencies, and will warn users about associated security vulnerabilities. The `dependency-review-action` action is supported by a new API endpoint that diffs the dependencies between any two revisions. For more information, see "[About dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement)."
|
||||
|
||||
# https://github.com/github/releases/issues/2243
|
||||
- |
|
||||
The dependency graph detects _Cargo.toml_ and _Cargo.lock_ files for Rust. These files will be displayed in the **Dependency graph** section of the **Insights** tab. Users will receive Dependabot alerts and updates for vulnerabilities associated with their Rust dependencies. Package metadata, including mapping packages to repositories, will be added at a later date. For more information, see "[About the dependency graph](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph)."
|
||||
|
||||
# https://github.com/github/releases/issues/1766
|
||||
- |
|
||||
If GitHub Connect is enabled for your instance, users can contribute an improvement to a security advisory in the [GitHub Advisory Database](https://github.com/advisories). To contribute, click **Suggest improvements for this vulnerability** while viewing an advisory's details. For more information, see the following articles.
|
||||
|
||||
- "[Managing GitHub Connect](/admin/configuration/configuring-github-connect/managing-github-connect)"
|
||||
- "[Browsing security vulnerabilities in the GitHub Advisory Database](/enterprise-cloud@latest/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database)" in the GitHub Enterprise Cloud documentation
|
||||
- "[About GitHub Security Advisories for repositories](/enterprise-cloud@latest/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)" in the GitHub Enterprise Cloud documentation
|
||||
- "[Editing security advisories in the GitHub Advisory Database](/enterprise-cloud@latest/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/editing-security-advisories-in-the-github-advisory-database)" in the GitHub Enterprise Cloud documentation
|
||||
|
||||
- heading: GitHub Actions
|
||||
notes:
|
||||
# https://github.com/github/releases/issues/2159
|
||||
- |
|
||||
Within a workflow that calls a reusable workflow, users can pass the secrets to the reusable workflow with `secrets: inherit`. For more information, see "[Reusing workflows](/actions/using-workflows/reusing-workflows#using-inputs-and-secrets-in-a-reusable-workflow)."
|
||||
|
||||
# https://github.com/github/releases/issues/2102
|
||||
- |
|
||||
When using GitHub Actions, to reduce the risk of merging a change that was not reviewed by another person into a protected branch, enterprise owners and repository administrators can prevent Actions from creating pull requests. Organization owners could previously enable this restriction. For more information, see the following articles.
|
||||
|
||||
- "[Enforcing policies for GitHub Actions in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#preventing-github-actions-from-creating-or-approving-pull-requests)"
|
||||
- "[Disabling or limiting GitHub Actions for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#preventing-github-actions-from-creating-or-approving-pull-requests)"
|
||||
- "[Managing GitHub Actions settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#preventing-github-actions-from-creating-or-approving-pull-requests)"
|
||||
|
||||
# https://github.com/github/releases/issues/2155
|
||||
- |
|
||||
Users can write a single workflow triggered by `workflow_dispatch` and `workflow_call`, and use the `inputs` context to access input values. Previously, `workflow_dispatch` inputs were in the event payload, which increased difficulty for workflow authors who wanted to write one workflow that was both reusable and manually triggered. For workflows triggered by `workflow_dispatch`, inputs are still available in the `github.event.inputs` context to maintain compatibility. For more information, see "[Contexts](/actions/learn-github-actions/contexts#inputs-context)."
|
||||
|
||||
# https://github.com/github/releases/issues/2103
|
||||
- |
|
||||
To summarize the result of a job, users can generate Markdown and publish the contents as a job summary. For example, after running tests with GitHub Actions, a summary can provide an overview of passed, failed, or skipped tests, potentially reducing the need to review the full log output. For more information, see "[Workflow commands for GitHub Actions](/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary)."
|
||||
|
||||
# https://github.com/github/releases/issues/2161
|
||||
- |
|
||||
To more easily diagnose job execution failures during a workflow re-run, users can enable debug logging, which outputs information about a job's execution and environment. For more information, see "[Re-running workflows and jobs](/actions/managing-workflow-runs/re-running-workflows-and-jobs)" and "[Using workflow run logs](/actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs#viewing-logs-to-diagnose-failures)."
|
||||
|
||||
# https://github.com/github/releases/issues/2140
|
||||
- |
|
||||
If you manage self-hosted runners for GitHub Actions, you can ensure a consistent state on the runner itself before and after a workflow run by defining scripts to execute. By using scripts, you no longer need to require that users manually incorporate these steps into workflows. Pre- and post-job scripts are in beta and subject to change. For more information, see "[Running scripts before or after a job](/actions/hosting-your-own-runners/running-scripts-before-or-after-a-job)."
|
||||
|
||||
- heading: GitHub Packages
|
||||
notes:
|
||||
# https://github.com/github/releases/issues/2334
|
||||
- |
|
||||
Enterprise owners can migrate container images from the GitHub Docker registry to the GitHub Container registry. The Container registry provides the following benefits.
|
||||
|
||||
- Improves the sharing of containers within an organization
|
||||
- Allows the application of granular access permissions
|
||||
- Permits the anonymous sharing of public container images
|
||||
- Implements OCI standards for hosting Docker images
|
||||
|
||||
The Container registry is in beta and subject to change. For more information, see "[Migrating your enterprise to the Container registry from the Docker registry](/admin/packages/migrating-your-enterprise-to-the-container-registry-from-the-docker-registry)."
|
||||
|
||||
- heading: Community experience
|
||||
notes:
|
||||
# https://github.com/github/releases/issues/2113
|
||||
- |
|
||||
GitHub Discussions is available for GitHub Enterprise Server. GitHub Discussions provides a central gathering space to ask questions, share ideas, and build connections. For more information, see "[GitHub Discussions](/discussions)."
|
||||
|
||||
# https://github.com/github/releases/issues/2259
|
||||
- |
|
||||
Enterprise owners can configure a policy to control whether people's usernames or full names are displayed within internal or public repositories. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-the-display-of-member-names-in-your-repositories)."
|
||||
|
||||
- heading: Organizations
|
||||
notes:
|
||||
# https://github.com/github/releases/issues/2019
|
||||
- |
|
||||
Users can create member-only READMEs for an organization. For more information, see "[Customizing your organization's profile](/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile)."
|
||||
|
||||
# https://github.com/github/releases/issues/2234
|
||||
- |
|
||||
Organization owners can pin a repository to an organization's profile directly from the repository via the new **Pin repository** dropdown. Pinned public repositories appear to all users of your instance, while public, private, and internal repositories are only visible to organization members.
|
||||
|
||||
- heading: Repositories
|
||||
notes:
|
||||
# https://github.com/github/releases/issues/2214
|
||||
- |
|
||||
While creating a fork, users can customize the fork's name. For more information, see "[Fork a repo](/get-started/quickstart/fork-a-repo)."
|
||||
|
||||
# https://github.com/github/releases/issues/1973
|
||||
- |
|
||||
Users can block creation of branches that match a configured name pattern with the **Restrict pushes that create matching branches** branch protection rule. For example, if a repository's default branch changes from `master` to `main`, a repository administrator can prevent any subsequent creation or push of the `master` branch. For more information, see
|
||||
"[About protected branches](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#restrict-who-can-push-to-matching-branches)" and "[Managing a branch protection rule](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule#creating-a-branch-protection-rule)."
|
||||
|
||||
# https://github.com/github/releases/issues/2179
|
||||
- |
|
||||
Users can create a branch directly from a repository's **Branches** page by clicking the **New branch**. For more information, see "[Creating and deleting branches within your repository](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)."
|
||||
|
||||
# https://github.com/github/releases/issues/2220
|
||||
- |
|
||||
Users can delete a branch that's associated with an open pull request. For more information, see "[Creating and deleting branches within your repository](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)."
|
||||
|
||||
# https://github.com/github/releases/issues/2118
|
||||
- |
|
||||
Repositories with multiple licenses display all of the licenses in the "About" sidebar on the {% octicon "code" aria-label="The code icon" %} **Code** tab. For more information, see "[Licensing a repository](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)."
|
||||
|
||||
# https://github.com/github/releases/issues/2233
|
||||
- When a user renames or moves a file to a new directory, if at least half of the file's contents are identical, the commit history indicates that the file was renamed, similar to `git log --follow`. For more information, see the [GitHub Blog](https://github.blog/changelog/2022-06-06-view-commit-history-across-file-renames-and-moves/).
|
||||
|
||||
# https://github.com/github/releases/issues/2093
|
||||
- |
|
||||
Users can require a successful deployment of a branch before anyone can merge the pull request associated with the branch. For more information, see "[About protected branches](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-deployments-to-succeed-before-merging)" and "[Managing a branch protection rule](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule)."
|
||||
|
||||
# https://github.com/github/releases/issues/2073
|
||||
- |
|
||||
Enterprise owners can prevent organization owners from inviting collaborators to repositories on the instance. For more information, see "[Enforcing a policy for inviting collaborators to repositories](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-collaborators-to-repositories)."
|
||||
|
||||
# https://github.com/github/releases/issues/2173
|
||||
- |
|
||||
Users can grant exceptions to GitHub Apps for any branch protection rule that supports exceptions. For more information, see "[About apps](/developers/apps/getting-started-with-apps/about-apps)" and "[Managing a branch protection rule](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule)."
|
||||
|
||||
- heading: Commits
|
||||
notes:
|
||||
# https://github.com/github/releases/issues/2306
|
||||
- |
|
||||
For public GPG signing keys that are expired or revoked, GitHub Enterprise Server verifies Git commit signatures and show commits as verified if the user made the commit while the key was still valid. Users can also upload expired or revoked GPG keys. For more information, see "[About commit signature verification](/authentication/managing-commit-signature-verification/about-commit-signature-verification)."
|
||||
|
||||
# https://github.com/github/releases/issues/1977
|
||||
- |
|
||||
To affirm that a commit complies with the rules and licensing governing a repository, organization owners and repository administrators can now require developers to sign off on commits made through the web interface. For more information, see "[Managing the commit signoff policy for your organization](/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization)" and "[Managing the commit signoff policy for your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository)."
|
||||
|
||||
- heading: Pull requests
|
||||
notes:
|
||||
# https://github.com/github/releases/issues/2261
|
||||
- |
|
||||
Using the file tree located in the **Files changed** tab of a pull request, users can navigate modified files, understand the size and scope of changes, and focus reviews. The file tree appears if a pull request modifies at least two files, and the browser window is sufficiently wide. For more information, see "[Reviewing proposed changes in a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)" and "[Filtering files in a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/filtering-files-in-a-pull-request)."
|
||||
|
||||
# https://github.com/github/releases/issues/2167
|
||||
- |
|
||||
Users can default to using pull requests titles as the commit message for all squash merges. For more information, see "[Configuring commit squashing for pull requests](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests)."
|
||||
|
||||
- heading: Releases
|
||||
notes:
|
||||
# https://github.com/github/releases/issues/2281
|
||||
- |
|
||||
When viewing the details for a particular release, users can see the creation date for each release asset. For more information, see "[Viewing your repository's releases and tags](/repositories/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags)."
|
||||
|
||||
# https://github.com/github/releases/issues/2279
|
||||
- While creating a release with automatically generated release notes, users can see the tag identified as the previous release, then choose to select a different tag to specify as the previous release. For more information, see "[Automatically generated release notes](/repositories/releasing-projects-on-github/automatically-generated-release-notes)."
|
||||
|
||||
- heading: Markdown
|
||||
notes:
|
||||
# https://github.com/github/releases/issues/2260
|
||||
- |
|
||||
Editing Markdown in the web interface has been improved.
|
||||
|
||||
- After a user selects text and pastes a URL, the selected text will become a Markdown link to the pasted URL.
|
||||
- When a user pastes spreadsheet cells or HTML tables, the resulting text will render as a table.
|
||||
- When a user copies text containing links, the pasted text will include the link as a Markdown link.
|
||||
|
||||
For more information, see "[Basic writing and formatting syntax](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#links)."
|
||||
|
||||
# https://github.com/github/releases/issues/2258
|
||||
- |
|
||||
When editing a Markdown file in the web interface, clicking the **Preview** tab will automatically scroll to the place in the preview that you were editing. The scroll location is based on the position of your cursor before you clicked the **Preview** tab.
|
||||
|
||||
changes:
|
||||
- Interactive elements in the web interface such as links and buttons show a visible outline when focused with a keyboard, to help users find the current position on a page. In addition, when focused, form fields have a higher contrast outline.
|
||||
- If a user refreshes the page while creating a new issue or pull request, the assignees, reviewers, labels and projects will all be preserved.
|
||||
|
||||
known_issues:
|
||||
- On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user.
|
||||
- Custom firewall rules are removed during the upgrade process.
|
||||
- Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository.
|
||||
- Issues cannot be closed if they contain a permalink to a blob in the same repository, where the blob's file path is longer than 255 characters.
|
||||
- When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results.
|
||||
- The {% data variables.product.prodname_registry %} npm registry no longer returns a time value in metadata responses. This was done to allow for substantial performance improvements. We continue to have all the data necessary to return a time value as part of the metadata response and will resume returning this value in the future once we have solved the existing performance issues.
|
||||
- Resource limits that are specific to processing pre-receive hooks may cause some pre-receive hooks to fail.
|
||||
- Actions services need to be restarted after restoring an instance from a backup taken on a different host.
|
||||
- In a repository's settings, enabling the option to allow users with read access to create discussions does not enable this functionality.
|
||||
- In some cases, users cannot convert existing issues to discussions.
|
||||
- Custom patterns for secret scanning have `.*` as an end delimiter, specifically in the "After secret" field. This delimiter causes inconsistencies in scans for secrets across repositories, and you may notice gaps in a repository's history where no scans completed. Incremental scans may also be impacted. To prevent issues with scans, modify the end of the pattern to remove the `.*` delimiter.
|
||||
@@ -1,5 +1,5 @@
|
||||
{% note %}
|
||||
{% ifversion GH-advisory-db-supports-malware %}{% note %}
|
||||
|
||||
**Note:** Advisories for malware are currently in beta and subject to change.
|
||||
|
||||
{% endnote %}
|
||||
{% endnote %}{% endif %}
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
| `advisory_credit` | Contains activities related to crediting a contributor for a security advisory in the {% data variables.product.prodname_advisory_database %}. For more information, see "[About {% data variables.product.prodname_dotcom %} Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)."
|
||||
{%- endif %}
|
||||
| `artifact` | Contains activities related to {% data variables.product.prodname_actions %} workflow run artifacts.
|
||||
{%- ifversion ghec %}
|
||||
{%- ifversion audit-log-streaming %}
|
||||
| `audit_log_streaming` | Contains activities related to streaming audit logs for organizations in an enterprise account.
|
||||
{%- endif %}
|
||||
{%- ifversion fpt or ghec %}
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
When you enable organization discussions, you will choose a repository in the organization to be the source repository for your organization discussions. You can use an existing repository or create a repository specifically to hold your organization discussions. Discussions will appear both on the discussions page for the organization and on the discussion page for the source repository.
|
||||
|
||||
Permission to participate in or manage discussion in your organization is based on permission in the source repository. For example, a user needs write permission to the source repository in order to delete an organization discussion. This is identical to how a user needs write permission in a repository in order to delete a repository discussion.
|
||||
Permission to participate in or manage discussions in your organization is based on permission in the source repository. For example, a user needs write permission to the source repository in order to delete an organization discussion. This is identical to how a user needs write permission in a repository in order to delete a repository discussion.
|
||||
|
||||
You can change the source repository at any time. If you change the source repository, discussions are not transferred to the new source repository.
|
||||
|
||||
1
data/reusables/enterprise-accounts/packages-tab.md
Normal file
@@ -0,0 +1 @@
|
||||
1. In the left sidebar, click **Packages**.
|
||||
5
data/reusables/enterprise/about-ssh-ports.md
Normal file
@@ -0,0 +1,5 @@
|
||||
Each {% data variables.product.product_name %} instance accepts SSH connections over two ports. Site administrators can access the administrative shell via SSH, then run command-line utilities, troubleshoot, and perform maintenance. Users can connect via SSH to access and write Git data in the instance's repositories. Users do not have shell access to your instance. For more information, see the following articles.
|
||||
|
||||
- "[Network ports](/admin/configuration/configuring-network-settings/network-ports)"
|
||||
- "[Accessing the administrative shell (SSH)](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh)"
|
||||
- "[About SSH](/authentication/connecting-to-github-with-ssh/about-ssh)"
|
||||
12
data/reusables/enterprise/apply-configuration.md
Normal file
@@ -0,0 +1,12 @@
|
||||
1. To apply the configuration, enter the following command.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note**: During a configuration run, services on {% data variables.product.product_location %} may restart, which can cause brief downtime for users.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
```shell
|
||||
ghe-config-apply
|
||||
```
|
||||
1. Wait for the configuration run to complete.
|
||||
@@ -1,5 +1,7 @@
|
||||
{% ifversion ghes < 3.6 %}
|
||||
{% note %}
|
||||
|
||||
**Note:** Repository caching is currently in beta and subject to change.
|
||||
|
||||
{% endnote %}
|
||||
{% endif %}
|
||||