Deprecate 3.12 (#55505)
Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> Co-authored-by: Felicity Chapman <felicitymay@github.com> Co-authored-by: Sarah Schneider <sarahs@github.com>
This commit is contained in:
@@ -30,7 +30,7 @@ We recommend auditing and unsubscribing from your subscriptions as a part of a h
|
|||||||
|
|
||||||
## Diagnosing why you receive too many notifications
|
## Diagnosing why you receive too many notifications
|
||||||
|
|
||||||
When your inbox has too many notifications to manage, consider whether you have oversubscribed or how you can change your notification settings to reduce the subscriptions you have and the types of notifications you're receiving. For example, you may consider disabling the settings to automatically watch all repositories {% ifversion team-discussions %}and all team discussions{% endif %} whenever you've joined a team or repository. For more information, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#automatic-watching).
|
When your inbox has too many notifications to manage, consider whether you have oversubscribed or how you can change your notification settings to reduce the subscriptions you have and the types of notifications you're receiving. For example, you may consider disabling the settings to automatically watch all repositories whenever you've joined a team or repository. For more information, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#automatic-watching).
|
||||||
|
|
||||||
To see an overview of your repository subscriptions, see [Reviewing repositories that you're watching](#reviewing-repositories-that-youre-watching).
|
To see an overview of your repository subscriptions, see [Reviewing repositories that you're watching](#reviewing-repositories-that-youre-watching).
|
||||||
|
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ You can choose to receive ongoing updates about specific activity on {% data var
|
|||||||
|
|
||||||
You can choose to subscribe to notifications for:
|
You can choose to subscribe to notifications for:
|
||||||
* A conversation in a specific issue, pull request, or gist
|
* A conversation in a specific issue, pull request, or gist
|
||||||
* All activity in a repository{% ifversion team-discussions %} or team discussion{% endif %}
|
* All activity in a repository
|
||||||
* CI activity, such as the status of workflows in repositories set up with {% data variables.product.prodname_actions %}
|
* CI activity, such as the status of workflows in repositories set up with {% data variables.product.prodname_actions %}
|
||||||
* Repository {% data reusables.notifications-v2.custom-notification-types %} (if enabled)
|
* Repository {% data reusables.notifications-v2.custom-notification-types %} (if enabled)
|
||||||
|
|
||||||
@@ -36,7 +36,7 @@ If you're no longer interested in a conversation, you can unsubscribe, unwatch,
|
|||||||
In general, you are automatically subscribed to conversations by default when you have:
|
In general, you are automatically subscribed to conversations by default when you have:
|
||||||
* Not disabled automatic watching for repositories or teams you've joined in your notification settings. This setting is enabled by default.
|
* Not disabled automatic watching for repositories or teams you've joined in your notification settings. This setting is enabled by default.
|
||||||
* Been assigned to an issue or pull request.
|
* Been assigned to an issue or pull request.
|
||||||
* Opened a pull request{% ifversion team-discussions %}, issue, or created a team discussion post{% else %} or issue{% endif %}.
|
* Opened a pull request or issue.
|
||||||
* Commented on a thread.
|
* Commented on a thread.
|
||||||
* Subscribed to a thread manually by clicking **Watch** or **Subscribe**.
|
* Subscribed to a thread manually by clicking **Watch** or **Subscribe**.
|
||||||
* Had your username @mentioned.
|
* Had your username @mentioned.
|
||||||
|
|||||||
@@ -42,7 +42,7 @@ The notifications inbox includes triaging options designed specifically for your
|
|||||||
* Mark completed notifications as **Done** and remove them from your inbox. To view all of your notifications marked as **Done**, use the `is:done` query.
|
* Mark completed notifications as **Done** and remove them from your inbox. To view all of your notifications marked as **Done**, use the `is:done` query.
|
||||||
* Save a notification to review later. Saved notifications are flagged in your inbox and kept indefinitely. To view all of your saved notifications, use the `is:saved` query.
|
* Save a notification to review later. Saved notifications are flagged in your inbox and kept indefinitely. To view all of your saved notifications, use the `is:saved` query.
|
||||||
* Unsubscribe and remove a notification from your inbox.
|
* Unsubscribe and remove a notification from your inbox.
|
||||||
* Preview the issue{% ifversion team-discussions %}, pull request, or team discussion{% else %} or pull request{% endif %} where the notification originates on {% data variables.product.prodname_dotcom %} from within the notifications inbox.
|
* Preview the issue or pull request where the notification originates on {% data variables.product.prodname_dotcom %} from within the notifications inbox.
|
||||||
* See one of the latest reasons you're receiving a notification from your inbox with a `reasons` label.
|
* See one of the latest reasons you're receiving a notification from your inbox with a `reasons` label.
|
||||||
* Create custom filters to focus on different notifications when you want.
|
* Create custom filters to focus on different notifications when you want.
|
||||||
* Group notifications in your inbox by repository or date to get a quick overview with less context switching.
|
* Group notifications in your inbox by repository or date to get a quick overview with less context switching.
|
||||||
@@ -59,7 +59,7 @@ Email notifications also allow flexibility with the types of notifications you r
|
|||||||
|
|
||||||
## About participating and watching notifications
|
## About participating and watching notifications
|
||||||
|
|
||||||
When you watch a repository, you're subscribing to updates for activity in that repository. {% ifversion team-discussions %}Similarly, when you watch a specific team's discussions, you're subscribing to all conversation updates on that team's page. For more information, see [AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions).{% endif %}
|
When you watch a repository, you're subscribing to updates for activity in that repository.
|
||||||
|
|
||||||
To see repositories that you're watching, go to your [watching page](https://github.com/watching). For more information, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github).
|
To see repositories that you're watching, go to your [watching page](https://github.com/watching). For more information, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github).
|
||||||
|
|
||||||
@@ -152,7 +152,7 @@ The `reply-to` address on each email notification identifies the thread and the
|
|||||||
{% data reusables.notifications.access_notifications %}
|
{% data reusables.notifications.access_notifications %}
|
||||||
{% data reusables.notifications-v2.manage-notifications %}
|
{% data reusables.notifications-v2.manage-notifications %}
|
||||||
1. On the notifications settings page, choose how you receive notifications when:
|
1. On the notifications settings page, choose how you receive notifications when:
|
||||||
* There are updates in repositories {% ifversion team-discussions %}or team discussions{% endif %} you're watching or in a conversation you're participating in. For more information, see [About participating and watching notifications](#about-participating-and-watching-notifications).
|
* There are updates in repositories you're watching or in a conversation you're participating in. For more information, see [About participating and watching notifications](#about-participating-and-watching-notifications).
|
||||||
* You gain access to a new repository or you've joined a new team. For more information, see [Automatic watching](#automatic-watching).
|
* You gain access to a new repository or you've joined a new team. For more information, see [Automatic watching](#automatic-watching).
|
||||||
* There are new {% data variables.product.prodname_dependabot_alerts %} in your repository. For more information, see [{% data variables.product.prodname_dependabot_alerts %} notification options](#dependabot-alerts-notification-options). {% ifversion fpt or ghec %}
|
* There are new {% data variables.product.prodname_dependabot_alerts %} in your repository. For more information, see [{% data variables.product.prodname_dependabot_alerts %} notification options](#dependabot-alerts-notification-options). {% ifversion fpt or ghec %}
|
||||||
* There are workflow runs updates on repositories set up with {% data variables.product.prodname_actions %}. For more information, see [{% data variables.product.prodname_actions %} notification options](#github-actions-notification-options).{% endif %}
|
* There are workflow runs updates on repositories set up with {% data variables.product.prodname_actions %}. For more information, see [{% data variables.product.prodname_actions %} notification options](#github-actions-notification-options).{% endif %}
|
||||||
|
|||||||
@@ -101,8 +101,7 @@ To filter notifications for specific activity on {% data variables.product.prodn
|
|||||||
* `is:release`
|
* `is:release`
|
||||||
* `is:repository-invitation`
|
* `is:repository-invitation`
|
||||||
* `is:repository-vulnerability-alert`{% ifversion fpt or ghec %}
|
* `is:repository-vulnerability-alert`{% ifversion fpt or ghec %}
|
||||||
* `is:repository-advisory`{% endif %}{% ifversion team-discussions %}
|
* `is:repository-advisory`{% endif %}{% ifversion fpt or ghec %}
|
||||||
* `is:team-discussion`{% endif %}{% ifversion fpt or ghec %}
|
|
||||||
* `is:discussion`{% endif %}
|
* `is:discussion`{% endif %}
|
||||||
|
|
||||||
For information about reducing noise from notifications for {% data variables.product.prodname_dependabot_alerts %}, see [AUTOTITLE](/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts).
|
For information about reducing noise from notifications for {% data variables.product.prodname_dependabot_alerts %}, see [AUTOTITLE](/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts).
|
||||||
@@ -122,8 +121,8 @@ To filter notifications by why you've received an update, you can use the `reaso
|
|||||||
|-----------------|-------------|
|
|-----------------|-------------|
|
||||||
| `reason:assign` | When there's an update on an issue or pull request you've been assigned to.
|
| `reason:assign` | When there's an update on an issue or pull request you've been assigned to.
|
||||||
| `reason:author` | When you opened a pull request or issue and there has been an update or new comment.
|
| `reason:author` | When you opened a pull request or issue and there has been an update or new comment.
|
||||||
| `reason:comment`| When you commented on an issue{% ifversion team-discussions %}, pull request, or team discussion{% else %} or pull request{% endif %}.
|
| `reason:comment`| When you commented on an issue or pull request.
|
||||||
| `reason:participating` | When you have commented on an issue{% ifversion team-discussions %}, pull request, or team discussion{% else %} or pull request{% endif %} or you have been @mentioned.
|
| `reason:participating` | When you have commented on an issue or pull request or you have been @mentioned.
|
||||||
| `reason:invitation` | When you're invited to a team, organization, or repository.
|
| `reason:invitation` | When you're invited to a team, organization, or repository.
|
||||||
| `reason:manual` | When you click **Subscribe** on an issue or pull request you weren't already subscribed to.
|
| `reason:manual` | When you click **Subscribe** on an issue or pull request you weren't already subscribed to.
|
||||||
| `reason:mention` | You were directly @mentioned.
|
| `reason:mention` | You were directly @mentioned.
|
||||||
|
|||||||
@@ -33,7 +33,7 @@ topics:
|
|||||||
|
|
||||||
{% elsif ghes %}
|
{% elsif ghes %}
|
||||||
|
|
||||||
You must host your own Linux, Windows, or macOS virtual machines to run workflows for {% data variables.location.product_location %}. {% data reusables.actions.self-hosted-runner-locations %}
|
You must host your own Linux, Windows, or macOS virtual machines to run workflows for {% data variables.location.product_location %}.
|
||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ versions:
|
|||||||
type: overview
|
type: overview
|
||||||
---
|
---
|
||||||
|
|
||||||
{% ifversion fpt or ghec or ghes > 3.12 %}- **Job execution time** - Each job in a workflow can run for up to 5 days of execution time. If a job reaches this limit, the job is terminated and fails to complete.{% endif %}
|
* **Job execution time** - Each job in a workflow can run for up to 5 days of execution time. If a job reaches this limit, the job is terminated and fails to complete.
|
||||||
{% data reusables.actions.usage-workflow-run-time %}
|
{% data reusables.actions.usage-workflow-run-time %}
|
||||||
* **Job queue time** - Each job for self-hosted runners that has been queued for at least 24 hours will be canceled. The actual time in queue can reach up to 48 hours before cancellation occurs. If a self-hosted runner does not start executing the job within this limit, the job is terminated and fails to complete.
|
* **Job queue time** - Each job for self-hosted runners that has been queued for at least 24 hours will be canceled. The actual time in queue can reach up to 48 hours before cancellation occurs. If a self-hosted runner does not start executing the job within this limit, the job is terminated and fails to complete.
|
||||||
{% data reusables.actions.usage-api-requests %}
|
{% data reusables.actions.usage-api-requests %}
|
||||||
|
|||||||
@@ -1031,7 +1031,7 @@ jobs:
|
|||||||
> * {% data reusables.actions.schedule-delay %}
|
> * {% data reusables.actions.schedule-delay %}
|
||||||
> * This event will only trigger a workflow run if the workflow file is on the default branch.
|
> * This event will only trigger a workflow run if the workflow file is on the default branch.
|
||||||
> * Scheduled workflows will only run on the default branch.
|
> * Scheduled workflows will only run on the default branch.
|
||||||
> * In a public repository, scheduled workflows are automatically disabled when no repository activity has occurred in 60 days. For information on re-enabling a disabled workflow, see [AUTOTITLE](/enterprise-server@3.12/actions/using-workflows/disabling-and-enabling-a-workflow#enabling-a-workflow).
|
> * In a public repository, scheduled workflows are automatically disabled when no repository activity has occurred in 60 days. For information on re-enabling a disabled workflow, see [AUTOTITLE](/enterprise-server/actions/using-workflows/disabling-and-enabling-a-workflow#enabling-a-workflow).
|
||||||
> * For an enterprise with {% data variables.product.prodname_emus %}, scheduled workflows will not run if the last `actor` associated with the scheduled workflow has been deprovisioned (and therefore become suspended) by the {% data variables.product.prodname_emu %} identity provider (IdP). However, if the last `actor` {% data variables.product.prodname_emu %} has not been deprovisioned by the IdP, and has only been removed as a member from a given organization in the enterprise, scheduled workflows will still run with that user set as the `actor`. Similarly, for an enterprise without {% data variables.product.prodname_emus %}, removing a user from an organization will not prevent scheduled workflows which had that user as their `actor` from running. Essentially, triggering a scheduled workflow requires that the status of the `actor` user account associated with the workflow is currently active (i.e. not suspended or deleted). Thus, the _user account's_ status, in both {% data variables.product.prodname_emu %} and non-{% data variables.product.prodname_emu %} scenarios, is what's important, _not_ the user's _membership status_ in the organization where the scheduled workflow is located.
|
> * For an enterprise with {% data variables.product.prodname_emus %}, scheduled workflows will not run if the last `actor` associated with the scheduled workflow has been deprovisioned (and therefore become suspended) by the {% data variables.product.prodname_emu %} identity provider (IdP). However, if the last `actor` {% data variables.product.prodname_emu %} has not been deprovisioned by the IdP, and has only been removed as a member from a given organization in the enterprise, scheduled workflows will still run with that user set as the `actor`. Similarly, for an enterprise without {% data variables.product.prodname_emus %}, removing a user from an organization will not prevent scheduled workflows which had that user as their `actor` from running. Essentially, triggering a scheduled workflow requires that the status of the `actor` user account associated with the workflow is currently active (i.e. not suspended or deleted). Thus, the _user account's_ status, in both {% data variables.product.prodname_emu %} and non-{% data variables.product.prodname_emu %} scenarios, is what's important, _not_ the user's _membership status_ in the organization where the scheduled workflow is located.
|
||||||
> * Certain repository events change the `actor` associated with the workflow. For example, a user who changes the default branch of the repository, which changes the branch on which scheduled workflows run, becomes `actor` for those scheduled workflows.
|
> * Certain repository events change the `actor` associated with the workflow. For example, a user who changes the default branch of the repository, which changes the branch on which scheduled workflows run, becomes `actor` for those scheduled workflows.
|
||||||
> * For a deactivated scheduled workflow, if a user with `write` permissions to the repository makes a commit that changes the `cron` schedule on the workflow, the workflow will be reactivated, and that user will become the `actor` associated with any workflow runs. Note that, in this situation, the workflow is not reactivated by any change to the workflow file; you must alter the `cron` value in the workflow and commit this change.
|
> * For a deactivated scheduled workflow, if a user with `write` permissions to the repository makes a commit that changes the `cron` schedule on the workflow, the workflow will be reactivated, and that user will become the `actor` associated with any workflow runs. Note that, in this situation, the workflow is not reactivated by any change to the workflow file; you must alter the `cron` value in the workflow and commit this change.
|
||||||
|
|||||||
@@ -724,56 +724,12 @@ ssh -p 122 admin@HOSTNAME -- 'ghe-cluster-support-bundle -t TICKET_ID'
|
|||||||
|
|
||||||
### ghe-cluster-failover
|
### ghe-cluster-failover
|
||||||
|
|
||||||
{% ifversion ghes < 3.13 %}
|
|
||||||
|
|
||||||
{% data reusables.enterprise_clustering.cluster-ip-note %}
|
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
With the `ghe-cluster-failover` utility, you can fail over to your replica cluster. For more information, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/configuring-clustering/initiating-a-failover-to-your-replica-cluster).
|
With the `ghe-cluster-failover` utility, you can fail over to your replica cluster. For more information, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/configuring-clustering/initiating-a-failover-to-your-replica-cluster).
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
ghe-cluster-failover
|
ghe-cluster-failover
|
||||||
```
|
```
|
||||||
|
|
||||||
{% ifversion ghes < 3.13 %}
|
|
||||||
|
|
||||||
### ghe-cluster-block-ips
|
|
||||||
|
|
||||||
This utility allows you to block all the IPs in the `/data/user/common/cluster-ip-blocklist` file. The command reads the list of IPs and blocks each IP by calling `ghe-cluster-block-ip` on each node in the current cluster.
|
|
||||||
|
|
||||||
The `/data/user/common/cluster-ip-blocklist` file only supports IPv4 addresses.
|
|
||||||
|
|
||||||
```shell
|
|
||||||
ghe-cluster-block-ips
|
|
||||||
```
|
|
||||||
|
|
||||||
### ghe-cluster-block-ip
|
|
||||||
|
|
||||||
This utility allows you to block a specific IP address on a specific node. You can't block the IP of the current host, or any of the IPs for the hosts in the current `cluster.conf`.
|
|
||||||
|
|
||||||
```shell
|
|
||||||
ghe-cluster-block-ip IPV4 ADDRESS
|
|
||||||
```
|
|
||||||
|
|
||||||
### ghe-cluster-unblock-ips
|
|
||||||
|
|
||||||
This utility allows you to unblock all the IPs currently blocked on each node in the cluster.
|
|
||||||
|
|
||||||
```shell
|
|
||||||
ghe-cluster-unblock-ips
|
|
||||||
```
|
|
||||||
|
|
||||||
### ghe-cluster-unblock-ip
|
|
||||||
|
|
||||||
This utility allows you to unblock a specific IP address on a specific node.
|
|
||||||
|
|
||||||
```shell
|
|
||||||
ghe-cluster-unblock-ip IPV4 ADDRESS
|
|
||||||
```
|
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
### ghe-dpages
|
### ghe-dpages
|
||||||
|
|
||||||
This utility allows you to manage the distributed {% data variables.product.prodname_pages %} server.
|
This utility allows you to manage the distributed {% data variables.product.prodname_pages %} server.
|
||||||
@@ -1175,8 +1131,6 @@ This utility rewrites the imported repository. This gives you a chance to rename
|
|||||||
git-import-rewrite
|
git-import-rewrite
|
||||||
```
|
```
|
||||||
|
|
||||||
{% ifversion ghes > 3.12 %}
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
### ghe-license
|
### ghe-license
|
||||||
@@ -1234,8 +1188,6 @@ GHE_LICENSE_FILE=/path/license ghe-license import
|
|||||||
# License synchronized.
|
# License synchronized.
|
||||||
```
|
```
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## Security
|
## Security
|
||||||
|
|
||||||
### ghe-find-insecure-git-operations
|
### ghe-find-insecure-git-operations
|
||||||
@@ -1402,14 +1354,14 @@ ghe-upgrade-scheduler -r UPGRADE PACKAGE FILENAME
|
|||||||
|
|
||||||
## User management
|
## User management
|
||||||
|
|
||||||
### {% ifversion ghes > 3.12 %}ghe-license usage{% else %}ghe-license-usage{% endif %}
|
### ghe-license usage
|
||||||
|
|
||||||
This utility exports a list of the installation's users in JSON format. If your instance is connected to {% data variables.product.prodname_ghe_cloud %}, {% data variables.product.prodname_ghe_server %} uses this information for reporting licensing information to {% data variables.product.prodname_ghe_cloud %}. For more information, see [AUTOTITLE](/admin/configuration/configuring-github-connect/managing-github-connect).
|
This utility exports a list of the installation's users in JSON format. If your instance is connected to {% data variables.product.prodname_ghe_cloud %}, {% data variables.product.prodname_ghe_server %} uses this information for reporting licensing information to {% data variables.product.prodname_ghe_cloud %}. For more information, see [AUTOTITLE](/admin/configuration/configuring-github-connect/managing-github-connect).
|
||||||
|
|
||||||
By default, the list of users in the resulting JSON file is encrypted. {% ifversion ghes > 3.12 %}Review optional flags via `ghe-license --help`{% else %}Use the `-h` flag for more options{% endif %}.
|
By default, the list of users in the resulting JSON file is encrypted. Review optional flags via `ghe-license --help`.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
{% ifversion ghes > 3.12 %}ghe-license usage{% else %}ghe-license-usage{% endif %}
|
ghe-license usage
|
||||||
```
|
```
|
||||||
|
|
||||||
### ghe-org-membership-update
|
### ghe-org-membership-update
|
||||||
|
|||||||
@@ -32,8 +32,7 @@ In the {% data variables.enterprise.management_console %}, you can perform admin
|
|||||||
|
|
||||||
* **Initial setup:** Walk through the initial setup process when first launching {% data variables.location.product_location %} by visiting {% data variables.location.product_location %}'s IP address in your browser.
|
* **Initial setup:** Walk through the initial setup process when first launching {% data variables.location.product_location %} by visiting {% data variables.location.product_location %}'s IP address in your browser.
|
||||||
|
|
||||||
* **Identity and access management:** Improve the security of {% data variables.location.product_location %} by creating dedicated user accounts for the {% data variables.enterprise.management_console %}. {% ifversion management-console-editor %}The root site administrator account can control these user accounts' access by assigning either the editor or operator role. {% endif %}For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/managing-access-to-the-management-console).{% ifversion management-console-editor %}
|
* **Identity and access management:** Improve the security of {% data variables.location.product_location %} by creating dedicated user accounts for the {% data variables.enterprise.management_console %}. For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/managing-access-to-the-management-console).
|
||||||
{% data reusables.enterprise.editor-role-note %}{% endif %}
|
|
||||||
|
|
||||||
* **Configuring authentication policies for the {% data variables.enterprise.management_console %}:** Set rate limits for login attempts, and the lockout duration if someone exceeds the rate limit. For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/managing-access-to-the-management-console#configuring-rate-limits-for-authentication-to-the-management-console).
|
* **Configuring authentication policies for the {% data variables.enterprise.management_console %}:** Set rate limits for login attempts, and the lockout duration if someone exceeds the rate limit. For more information, see [AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/managing-access-to-the-management-console#configuring-rate-limits-for-authentication-to-the-management-console).
|
||||||
* **Configuring basic settings for your instance:** Configure DNS, hostname, SSL, user authentication, email, monitoring services, and log forwarding on the Settings page.
|
* **Configuring basic settings for your instance:** Configure DNS, hostname, SSL, user authentication, email, monitoring services, and log forwarding on the Settings page.
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ You can also use the `gh es` {% data variables.product.prodname_cli %} extension
|
|||||||
|
|
||||||
There are two types of user accounts for the {% data variables.enterprise.management_console %} on a {% data variables.product.prodname_ghe_server %} instance. The root site administrator account authenticates with a password established during the initial setup of {% data variables.location.product_location %}.
|
There are two types of user accounts for the {% data variables.enterprise.management_console %} on a {% data variables.product.prodname_ghe_server %} instance. The root site administrator account authenticates with a password established during the initial setup of {% data variables.location.product_location %}.
|
||||||
|
|
||||||
The root site administrator can create additional accounts{% ifversion management-console-editor %}, and assign one of two roles to each{% endif %}.
|
The root site administrator can create additional accounts.
|
||||||
|
|
||||||
### Root site administrator
|
### Root site administrator
|
||||||
|
|
||||||
@@ -34,19 +34,7 @@ Only the root site administrator can create and delete {% data variables.enterpr
|
|||||||
|
|
||||||
{% data variables.enterprise.management_console %} users can perform most administrative tasks for {% data variables.location.product_location %}. For heightened security, {% data variables.enterprise.management_console %} users cannot create or delete {% data variables.enterprise.management_console %} user accounts.
|
{% data variables.enterprise.management_console %} users can perform most administrative tasks for {% data variables.location.product_location %}. For heightened security, {% data variables.enterprise.management_console %} users cannot create or delete {% data variables.enterprise.management_console %} user accounts.
|
||||||
|
|
||||||
{% ifversion management-console-editor %}
|
{% data variables.enterprise.management_console %} users, sometimes called operators, can perform basic administrative tasks for {% data variables.location.product_location %} in the {% data variables.enterprise.management_console %} and can add SSH keys to the {% data variables.enterprise.management_console %} to grant administrative access to the instance via SSH.
|
||||||
|
|
||||||
Only {% data variables.enterprise.management_console %} users with the operator role can manage SSH keys.
|
|
||||||
|
|
||||||
{% data reusables.enterprise.editor-role-note %}
|
|
||||||
|
|
||||||
The root site administrator can provision one of two roles for {% data variables.enterprise.management_console %} users:
|
|
||||||
|
|
||||||
* **Editor:** A {% data variables.enterprise.management_console %} user with the editor role can perform basic administrative tasks for {% data variables.location.product_location %} in the {% data variables.enterprise.management_console %}. Editors cannot add public SSH keys to the {% data variables.enterprise.management_console %} to grant administrative SSH access to the instance.
|
|
||||||
* **Operator:** A {% data variables.enterprise.management_console %} user with the operator role
|
|
||||||
{%- else %}
|
|
||||||
{% data variables.enterprise.management_console %} users, sometimes called operators,
|
|
||||||
{%- endif %} can perform basic administrative tasks for {% data variables.location.product_location %} in the {% data variables.enterprise.management_console %} and can add SSH keys to the {% data variables.enterprise.management_console %} to grant administrative access to the instance via SSH.
|
|
||||||
|
|
||||||
## Creating or deleting a user account for the {% data variables.enterprise.management_console %}
|
## Creating or deleting a user account for the {% data variables.enterprise.management_console %}
|
||||||
|
|
||||||
@@ -55,7 +43,6 @@ While signed into the {% data variables.enterprise.management_console %} as the
|
|||||||
{% data reusables.enterprise_site_admin_settings.click-user-management %}
|
{% data reusables.enterprise_site_admin_settings.click-user-management %}
|
||||||
1. Click **Create user**.
|
1. Click **Create user**.
|
||||||
1. Fill in the user's name, username, and email address.
|
1. Fill in the user's name, username, and email address.
|
||||||
{% ifversion management-console-editor %}1. Use the drop-down menu to select the user's role. You may select the editor or operator role.{% endif %}
|
|
||||||
1. To finish creating the user account, click **Create**. If email notifications are configured for the instance, the user will automatically receive an invitation email with access instructions for the {% data variables.enterprise.management_console %}. For more information, see [Inviting new {% data variables.enterprise.management_console %} users](#inviting-new-management-console-users).
|
1. To finish creating the user account, click **Create**. If email notifications are configured for the instance, the user will automatically receive an invitation email with access instructions for the {% data variables.enterprise.management_console %}. For more information, see [Inviting new {% data variables.enterprise.management_console %} users](#inviting-new-management-console-users).
|
||||||
1. Optionally, to delete a {% data variables.enterprise.management_console %} user account, click {% octicon "trash" aria-label="The trash symbol" %} to the right of any user account you wish to delete. Then confirm deletion.
|
1. Optionally, to delete a {% data variables.enterprise.management_console %} user account, click {% octicon "trash" aria-label="The trash symbol" %} to the right of any user account you wish to delete. Then confirm deletion.
|
||||||
|
|
||||||
|
|||||||
@@ -35,7 +35,7 @@ Some types of operations require that you take {% data variables.location.produc
|
|||||||
|
|
||||||
We recommend that you schedule a maintenance window for at least 30 minutes in the future to give users time to prepare. When a maintenance window is scheduled, all users will see a banner when accessing the site.
|
We recommend that you schedule a maintenance window for at least 30 minutes in the future to give users time to prepare. When a maintenance window is scheduled, all users will see a banner when accessing the site.
|
||||||
|
|
||||||
When the instance is in maintenance mode, all normal HTTP and Git access is refused. This includes web and API requests, for which the appliance responds with status code `503` (Service Unavailable). Git fetch, clone, and push operations are also rejected with an error message indicating that the site is temporarily unavailable.{% ifversion ghes < 3.13 %} In high availability configurations, Git replication will be paused.{% endif %} GitHub Actions jobs will not be executed. Visiting the site in a browser results in a maintenance page.
|
When the instance is in maintenance mode, all normal HTTP and Git access is refused. This includes web and API requests, for which the appliance responds with status code `503` (Service Unavailable). Git fetch, clone, and push operations are also rejected with an error message indicating that the site is temporarily unavailable. GitHub Actions jobs will not be executed. Visiting the site in a browser results in a maintenance page.
|
||||||
|
|
||||||
You can perform initial validation of your maintenance operation by configuring an IP exception list to allow access to {% data variables.location.product_location %} from only the IP addresses and ranges provided. Attempts to access {% data variables.location.product_location %} from IP addresses not specified on the IP exception list will receive a response consistent with those sent when the instance is in maintenance mode.
|
You can perform initial validation of your maintenance operation by configuring an IP exception list to allow access to {% data variables.location.product_location %} from only the IP addresses and ranges provided. Attempts to access {% data variables.location.product_location %} from IP addresses not specified on the IP exception list will receive a response consistent with those sent when the instance is in maintenance mode.
|
||||||
|
|
||||||
|
|||||||
@@ -35,11 +35,3 @@ You can enable a retention policy for checks, actions, and associated data by se
|
|||||||
1. Under "Archive threshold (days)", type the number of days for the archival threshold. Checks older than this number of days will be archived before being permanently deleted.
|
1. Under "Archive threshold (days)", type the number of days for the archival threshold. Checks older than this number of days will be archived before being permanently deleted.
|
||||||
1. Under "Delete threshold (days)", type the number of days for the deletion threshold. An archived check exists in an archived state for the number of days specified here. After this threshold, the check will be permanently deleted.
|
1. Under "Delete threshold (days)", type the number of days for the deletion threshold. An archived check exists in an archived state for the number of days specified here. After this threshold, the check will be permanently deleted.
|
||||||
{% data reusables.enterprise_management_console.save-settings %}
|
{% data reusables.enterprise_management_console.save-settings %}
|
||||||
|
|
||||||
{% ifversion ghes < 3.13 %}
|
|
||||||
|
|
||||||
## Enabling interactive maps
|
|
||||||
|
|
||||||
You can enable the display of interactive maps in the web interface for users of {% data variables.location.product_location %}. For more information, see [AUTOTITLE](/admin/configuration/configuring-user-applications-for-your-enterprise/configuring-interactive-maps).
|
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|||||||
@@ -18,13 +18,6 @@ You can allow users of {% data variables.location.product_location %} to create
|
|||||||
|
|
||||||
To enable interactive maps, you must provide authentication credentials for Azure Maps.
|
To enable interactive maps, you must provide authentication credentials for Azure Maps.
|
||||||
|
|
||||||
{% ifversion ghes < 3.13 %}
|
|
||||||
|
|
||||||
> [!WARNING]
|
|
||||||
> Authentication with Azure Maps using an API token is {% data variables.release-phases.retired %} in {% data variables.product.prodname_ghe_server %} 3.12 and later. If you upgrade to the latest release of {% data variables.product.prodname_ghe_server %} on an instance already configured to authenticate with an API token, interactive maps will be disabled. You must reconfigure authentication using role-based access control (RBAC) for an application on a Microsoft Entra ID (previously known as Azure AD) tenant. {% data reusables.enterprise.azure-maps-auth-deprecation-link %}
|
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
* To configure interactive maps for your instance, you must have administrative access to a tenant in Microsoft Entra ID. For more information, contact the administrator for Microsoft resources at your company, or see [Quickstart: Create a new tenant in Microsoft Entra ID](https://learn.microsoft.com/entra/fundamentals/create-new-tenant) on Microsoft Learn.
|
* To configure interactive maps for your instance, you must have administrative access to a tenant in Microsoft Entra ID. For more information, contact the administrator for Microsoft resources at your company, or see [Quickstart: Create a new tenant in Microsoft Entra ID](https://learn.microsoft.com/entra/fundamentals/create-new-tenant) on Microsoft Learn.
|
||||||
|
|||||||
@@ -1,38 +0,0 @@
|
|||||||
---
|
|
||||||
title: Enforcing team policies in your enterprise
|
|
||||||
intro: 'You can enforce policies for teams in your enterprise''s organizations, or allow policies to be set in each organization.'
|
|
||||||
permissions: Enterprise owners can enforce policies for teams in an enterprise.
|
|
||||||
redirect_from:
|
|
||||||
- /articles/enforcing-team-settings-for-organizations-in-your-business-account
|
|
||||||
- /articles/enforcing-team-policies-for-organizations-in-your-enterprise-account
|
|
||||||
- /articles/enforcing-team-policies-in-your-enterprise-account
|
|
||||||
- /github/setting-up-and-managing-your-enterprise-account/enforcing-team-policies-in-your-enterprise-account
|
|
||||||
- /github/setting-up-and-managing-your-enterprise/enforcing-team-policies-in-your-enterprise-account
|
|
||||||
- /github/setting-up-and-managing-your-enterprise/setting-policies-for-organizations-in-your-enterprise-account/enforcing-team-policies-in-your-enterprise-account
|
|
||||||
- /admin/policies/enforcing-policies-for-your-enterprise/enforcing-team-policies-in-your-enterprise
|
|
||||||
versions:
|
|
||||||
ghes: '< 3.13'
|
|
||||||
type: how_to
|
|
||||||
topics:
|
|
||||||
- Enterprise
|
|
||||||
- Policies
|
|
||||||
- Teams
|
|
||||||
shortTitle: Team policies
|
|
||||||
---
|
|
||||||
|
|
||||||
## About policies for teams in your enterprise
|
|
||||||
|
|
||||||
You can enforce policies to control how members of your enterprise manage teams. You can also allow organization owners to manage policies for teams. For more information, see [AUTOTITLE](/organizations/organizing-members-into-teams/about-teams).
|
|
||||||
|
|
||||||
{% ifversion team-discussions %}
|
|
||||||
|
|
||||||
## Enforcing a policy for team discussions
|
|
||||||
|
|
||||||
Across all organizations owned by your enterprise, you can enable or disable team discussions, or allow owners to administer the setting on the organization level. For more information, see [AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions).
|
|
||||||
|
|
||||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
|
||||||
{% data reusables.enterprise-accounts.policies-tab %}
|
|
||||||
1. Under "{% octicon "law" aria-hidden="true" %} Policies", click **Teams**.
|
|
||||||
1. Under "Team discussions", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %}
|
|
||||||
1. Under "Team discussions", select the dropdown menu and click a policy.
|
|
||||||
{% endif %}
|
|
||||||
@@ -6,6 +6,7 @@ redirect_from:
|
|||||||
- /articles/setting-policies-for-organizations-in-your-enterprise-account
|
- /articles/setting-policies-for-organizations-in-your-enterprise-account
|
||||||
- /github/setting-up-and-managing-your-enterprise-account/setting-policies-for-organizations-in-your-enterprise-account
|
- /github/setting-up-and-managing-your-enterprise-account/setting-policies-for-organizations-in-your-enterprise-account
|
||||||
- /admin/policies/enforcing-policies-for-your-enterprise
|
- /admin/policies/enforcing-policies-for-your-enterprise
|
||||||
|
- /admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-team-policies-in-your-enterprise
|
||||||
versions:
|
versions:
|
||||||
ghec: '*'
|
ghec: '*'
|
||||||
ghes: '*'
|
ghes: '*'
|
||||||
@@ -15,7 +16,6 @@ topics:
|
|||||||
children:
|
children:
|
||||||
- /about-enterprise-policies
|
- /about-enterprise-policies
|
||||||
- /enforcing-repository-management-policies-in-your-enterprise
|
- /enforcing-repository-management-policies-in-your-enterprise
|
||||||
- /enforcing-team-policies-in-your-enterprise
|
|
||||||
- /enforcing-policies-for-projects-in-your-enterprise
|
- /enforcing-policies-for-projects-in-your-enterprise
|
||||||
- /restricting-email-notifications-for-your-enterprise
|
- /restricting-email-notifications-for-your-enterprise
|
||||||
- /enforcing-policies-for-github-sponsors-in-your-enterprise
|
- /enforcing-policies-for-github-sponsors-in-your-enterprise
|
||||||
@@ -29,4 +29,3 @@ children:
|
|||||||
- /managing-policies-for-code-governance
|
- /managing-policies-for-code-governance
|
||||||
shortTitle: Enforce policies
|
shortTitle: Enforce policies
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -106,9 +106,6 @@ The `$GITHUB_VIA` variable is available in the pre-receive hook environment when
|
|||||||
| <pre>releases delete button</pre> | Deletion of a release | [AUTOTITLE](/repositories/releasing-projects-on-github/managing-releases-in-a-repository#deleting-a-release) |
|
| <pre>releases delete button</pre> | Deletion of a release | [AUTOTITLE](/repositories/releasing-projects-on-github/managing-releases-in-a-repository#deleting-a-release) |
|
||||||
| <pre>stafftools branch restore</pre> | Restoration of a branch from the site admin dashboard | [AUTOTITLE](/admin/configuration/configuring-your-enterprise/site-admin-dashboard#repositories) |
|
| <pre>stafftools branch restore</pre> | Restoration of a branch from the site admin dashboard | [AUTOTITLE](/admin/configuration/configuring-your-enterprise/site-admin-dashboard#repositories) |
|
||||||
| <pre>tag create api</pre> | Creation of a tag via the API | [AUTOTITLE](/rest/git/tags#create-a-tag-object) |
|
| <pre>tag create api</pre> | Creation of a tag via the API | [AUTOTITLE](/rest/git/tags#create-a-tag-object) |
|
||||||
| {% ifversion ghes < 3.13 %} |
|
|
||||||
| <pre>slumlord (#SHA)</pre> | Commit via Subversion | [AUTOTITLE](/get-started/working-with-subversion-on-github/support-for-subversion-clients#making-commits-to-subversion) |
|
|
||||||
| {% endif %} |
|
|
||||||
| <pre>web branch create</pre> | Creation of a branch via the web interface | [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository#creating-a-branch) |
|
| <pre>web branch create</pre> | Creation of a branch via the web interface | [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository#creating-a-branch) |
|
||||||
|
|
||||||
#### Available for pull request merges
|
#### Available for pull request merges
|
||||||
|
|||||||
@@ -96,7 +96,6 @@ includeGuides:
|
|||||||
- /admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise
|
- /admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise
|
||||||
- /admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-projects-in-your-enterprise
|
- /admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-projects-in-your-enterprise
|
||||||
- /admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise
|
- /admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise
|
||||||
- /admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-team-policies-in-your-enterprise
|
|
||||||
- /admin/enforcing-policies/enforcing-policies-for-your-enterprise/restricting-email-notifications-for-your-enterprise
|
- /admin/enforcing-policies/enforcing-policies-for-your-enterprise/restricting-email-notifications-for-your-enterprise
|
||||||
- /admin/enforcing-policies/enforcing-policy-with-pre-receive-hooks/managing-pre-receive-hooks-on-your-instance
|
- /admin/enforcing-policies/enforcing-policy-with-pre-receive-hooks/managing-pre-receive-hooks-on-your-instance
|
||||||
- /admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/auditing-ssh-keys
|
- /admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/auditing-ssh-keys
|
||||||
@@ -137,4 +136,3 @@ includeGuides:
|
|||||||
- /admin/administering-your-instance/administering-your-instance-from-the-web-ui/accessing-the-management-console
|
- /admin/administering-your-instance/administering-your-instance-from-the-web-ui/accessing-the-management-console
|
||||||
- /admin/administering-your-instance/administering-your-instance-from-the-web-ui/troubleshooting-access-to-the-management-console
|
- /admin/administering-your-instance/administering-your-instance-from-the-web-ui/troubleshooting-access-to-the-management-console
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ redirect_from:
|
|||||||
|
|
||||||
{% data reusables.actions.about-actions-for-enterprises %} For more information, see [AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises).
|
{% data reusables.actions.about-actions-for-enterprises %} For more information, see [AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises).
|
||||||
|
|
||||||
With {% data variables.product.prodname_actions %}, developers can write and combine individual tasks called actions to create custom workflows. {% ifversion ghes %}To enable {% data variables.product.prodname_actions %} for {% data variables.location.product_location %}, you must host at least one machine to execute jobs.{% endif %} {% ifversion ghec %}You can host your own runner machine to execute jobs, and this{% elsif ghes %}This{% endif %} machine is called a self-hosted runner. {% data reusables.actions.self-hosted-runner-locations %} {% data reusables.actions.self-hosted-runner-architecture %} {% ifversion ghec %}All{% elsif ghes %}Self-hosted{% endif %} runners can run Linux, Windows, or macOS. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners).
|
With {% data variables.product.prodname_actions %}, developers can write and combine individual tasks called actions to create custom workflows. {% ifversion ghes %}To enable {% data variables.product.prodname_actions %} for {% data variables.location.product_location %}, you must host at least one machine to execute jobs.{% endif %} {% ifversion ghec %}You can host your own runner machine to execute jobs, and this{% elsif ghes %}This{% endif %} machine is called a self-hosted runner. {% data reusables.actions.self-hosted-runner-architecture %} {% ifversion ghec %}All{% elsif ghes %}Self-hosted{% endif %} runners can run Linux, Windows, or macOS. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners).
|
||||||
|
|
||||||
{% ifversion ghec %}
|
{% ifversion ghec %}
|
||||||
|
|
||||||
|
|||||||
@@ -15,10 +15,7 @@ redirect_from:
|
|||||||
## About deferring database seeding of a MySQL replica node
|
## About deferring database seeding of a MySQL replica node
|
||||||
|
|
||||||
>[!NOTE]
|
>[!NOTE]
|
||||||
>The ability to defer database seeding{% ifversion ghes < 3.13 %} was added in patch release
|
>The ability to defer database seeding is available as a {% data variables.release-phases.public_preview %}.
|
||||||
3.12.1
|
|
||||||
|
|
||||||
and{% endif %} is available as a {% data variables.release-phases.public_preview %}.
|
|
||||||
|
|
||||||
Adding a new MySQL replica node to your cluster when your primary node has more than seven days of data will normally trigger database seeding which can take several hours depending on the amount of data. You can choose to defer database seeding, allowing the config apply run to complete sooner, resulting in being able to open your appliance to traffic sooner.
|
Adding a new MySQL replica node to your cluster when your primary node has more than seven days of data will normally trigger database seeding which can take several hours depending on the amount of data. You can choose to defer database seeding, allowing the config apply run to complete sooner, resulting in being able to open your appliance to traffic sooner.
|
||||||
|
|
||||||
|
|||||||
@@ -30,8 +30,6 @@ To fail over to replica nodes, you must have configured high availability replic
|
|||||||
|
|
||||||
## Initiating a failover to your replica cluster
|
## Initiating a failover to your replica cluster
|
||||||
|
|
||||||
{% ifversion ghes < 3.13 %}{% data reusables.enterprise_clustering.cluster-ip-note %} For more information, see [AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities#ghe-cluster-failover).{% endif %}
|
|
||||||
|
|
||||||
1. SSH into the primary MySQL node in the replica cluster. For more information, see [AUTOTITLE](/enterprise/admin/configuration/accessing-the-administrative-shell-ssh#enabling-access-to-the-administrative-shell-via-ssh).
|
1. SSH into the primary MySQL node in the replica cluster. For more information, see [AUTOTITLE](/enterprise/admin/configuration/accessing-the-administrative-shell-ssh#enabling-access-to-the-administrative-shell-via-ssh).
|
||||||
1. To begin the failover to the secondary cluster and configure the nodes to respond to requests, run the following command.
|
1. To begin the failover to the secondary cluster and configure the nodes to respond to requests, run the following command.
|
||||||
|
|
||||||
|
|||||||
@@ -109,12 +109,10 @@ The graphs break down different metrics about {% data variables.product.prodname
|
|||||||
### Background jobs
|
### Background jobs
|
||||||
|
|
||||||
Number of tasks queued for background processing on the {% data variables.product.prodname_ghe_server %} appliance.
|
Number of tasks queued for background processing on the {% data variables.product.prodname_ghe_server %} appliance.
|
||||||
{% ifversion ghes > 3.12 %}
|
|
||||||
|
|
||||||
### Git Maintenance
|
### Git Maintenance
|
||||||
|
|
||||||
Monitoring Git maintenance failures can help customers with large and active repositories proactively manage repository health. Occasional "spurious failures" and "retries" are expected, but if a repository consistently shows Git maintenance marked as "failed", we recommend contacting [GitHub Support](https://support.github.com/).
|
Monitoring Git maintenance failures can help customers with large and active repositories proactively manage repository health. Occasional "spurious failures" and "retries" are expected, but if a repository consistently shows Git maintenance marked as "failed", we recommend contacting [GitHub Support](https://support.github.com/).
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
### Network
|
### Network
|
||||||
|
|
||||||
|
|||||||
@@ -28,10 +28,10 @@ To set up a trial, you must be signed in to a personal account. If you don't hav
|
|||||||
|
|
||||||
The trial lasts for **{% data reusables.enterprise.ghec-trial-length %} days** and includes the following features.
|
The trial lasts for **{% data reusables.enterprise.ghec-trial-length %} days** and includes the following features.
|
||||||
|
|
||||||
* Access to **most** {% data variables.product.prodname_ghe_cloud %} features.{% ifversion metered-ghe-ghas %}
|
* Access to **most** {% data variables.product.prodname_ghe_cloud %} features.
|
||||||
* {% data variables.product.prodname_copilot_for_business %}
|
* {% data variables.product.prodname_copilot_for_business %}
|
||||||
* {% data variables.product.prodname_GH_cs_and_sp %}
|
* {% data variables.product.prodname_GH_cs_and_sp %}
|
||||||
* Access to the **new billing platform**.{% ifversion enhanced-billing-platform %} See [AUTOTITLE](/billing/managing-your-billing/about-the-new-billing-platform).{% endif %}{% endif %}
|
* Access to the **new billing platform**.{% ifversion enhanced-billing-platform %} See [AUTOTITLE](/billing/using-the-new-billing-platform/about-the-new-billing-platform-for-enterprises).{% endif %}
|
||||||
* An **enterprise account**, which allows you to manage multiple organizations. See [AUTOTITLE](/enterprise-cloud@latest/get-started/learning-about-github/types-of-github-accounts).
|
* An **enterprise account**, which allows you to manage multiple organizations. See [AUTOTITLE](/enterprise-cloud@latest/get-started/learning-about-github/types-of-github-accounts).
|
||||||
* Up to **50 licenses** to grant access to users.
|
* Up to **50 licenses** to grant access to users.
|
||||||
|
|
||||||
@@ -74,10 +74,9 @@ You can end your trial at any time by purchasing {% data variables.product.prodn
|
|||||||
|
|
||||||
If you **purchase {% data variables.product.prodname_enterprise %}**:
|
If you **purchase {% data variables.product.prodname_enterprise %}**:
|
||||||
|
|
||||||
{% ifversion metered-ghe-ghas %}
|
* You can use usage-based billing for {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_GHAS %}{% ifversion ghas-products %} products{% endif %}, which means you pay monthly for the number of licenses you use. You will not need to buy a predefined number of licenses in advance. See [AUTOTITLE](/billing/using-the-new-billing-platform/about-usage-based-billing-for-licenses).
|
||||||
* You can use usage-based billing for {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_GHAS %}{% ifversion ghas-products %} products{% endif %}, which means you pay monthly for the number of licenses you use. You will not need to buy a predefined number of licenses in advance. See [AUTOTITLE](/billing/managing-your-billing/about-usage-based-billing-for-licenses).
|
|
||||||
|
|
||||||
If you did not set up a free trial and you want to use usage-based billing to pay for {% data variables.product.prodname_GHAS %}{% ifversion ghas-products %} products{% endif %} after the {% data variables.product.prodname_ghe_cloud %} trial ends, contact [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact).{% endif %}
|
If you did not set up a free trial and you want to use usage-based billing to pay for {% data variables.product.prodname_GHAS %}{% ifversion ghas-products %} products{% endif %} after the {% data variables.product.prodname_ghe_cloud %} trial ends, contact [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact).
|
||||||
|
|
||||||
* You can generate a {% data variables.product.prodname_ghe_server %} license file for the same quantity of users who are consuming a {% data variables.product.prodname_ghe_cloud %} license.
|
* You can generate a {% data variables.product.prodname_ghe_server %} license file for the same quantity of users who are consuming a {% data variables.product.prodname_ghe_cloud %} license.
|
||||||
|
|
||||||
|
|||||||
@@ -21,14 +21,7 @@ redirect_from:
|
|||||||
|
|
||||||
{% data variables.product.company_short %} strongly recommends regular backups of your instance's configuration and data. Before you proceed with any upgrade, back up your instance, then validate the backup in a staging environment. For more information, see [AUTOTITLE](/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance) and [AUTOTITLE](/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance).
|
{% data variables.product.company_short %} strongly recommends regular backups of your instance's configuration and data. Before you proceed with any upgrade, back up your instance, then validate the backup in a staging environment. For more information, see [AUTOTITLE](/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance) and [AUTOTITLE](/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance).
|
||||||
|
|
||||||
{% ifversion ghes < 3.13 %}
|
{% ifversion ghes < 3.15 %}
|
||||||
|
|
||||||
## Recommendations for server resources
|
|
||||||
|
|
||||||
If your appliance averages more than 70% CPU utilization, {% data variables.product.company_short %} strongly recommends scaling up your server resources before upgrading to 3.11 or above. The new hardware or instance type should have more vCPUs to accommodate the additional load from new features and improvements included with the latest releases.
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
{% ifversion ghes > 3.12 and ghes < 3.15 %}
|
|
||||||
|
|
||||||
## Elasticsearch Upgrade
|
## Elasticsearch Upgrade
|
||||||
|
|
||||||
@@ -44,10 +37,6 @@ As part of upgrading GitHub Enterprise Server to version 3.13 or later, the Elas
|
|||||||
|
|
||||||
To customers using standalone or HA topologies, it is recommended that new installations of 3.15 or later, or upgrades to 3.15 to use root disk size of at least 400GB. {% data variables.product.company_short %} strongly recommends following the guidance in [AUTOTITLE](/admin/monitoring-and-managing-your-instance/updating-the-virtual-machine-and-physical-resources/increasing-storage-capacity).
|
To customers using standalone or HA topologies, it is recommended that new installations of 3.15 or later, or upgrades to 3.15 to use root disk size of at least 400GB. {% data variables.product.company_short %} strongly recommends following the guidance in [AUTOTITLE](/admin/monitoring-and-managing-your-instance/updating-the-virtual-machine-and-physical-resources/increasing-storage-capacity).
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
{% ifversion ghes > 3.12 and ghes < 3.15 %}
|
|
||||||
|
|
||||||
## Undecryptable records
|
## Undecryptable records
|
||||||
|
|
||||||
If you are upgrading from {% data variables.product.prodname_ghe_server %} 3.11 or 3.12 to 3.13, or from 3.12 to 3.14, you may run into an issue with undecryptable records due to missing required keys for decryption. The only solution is to delete the undecryptable records. The type of records impacted by this issue are 2FA records, that means you might need to ask users to re-enable two-factor authentication (2FA).
|
If you are upgrading from {% data variables.product.prodname_ghe_server %} 3.11 or 3.12 to 3.13, or from 3.12 to 3.14, you may run into an issue with undecryptable records due to missing required keys for decryption. The only solution is to delete the undecryptable records. The type of records impacted by this issue are 2FA records, that means you might need to ask users to re-enable two-factor authentication (2FA).
|
||||||
|
|||||||
@@ -67,9 +67,7 @@ Name | Description
|
|||||||
 `user:follow`| Grants access to follow or unfollow other users.{% ifversion projects-oauth-scope %}
|
 `user:follow`| Grants access to follow or unfollow other users.{% ifversion projects-oauth-scope %}
|
||||||
**`project`** | Grants read/write access to user and organization {% data variables.projects.projects_v2 %}.
|
**`project`** | Grants read/write access to user and organization {% data variables.projects.projects_v2 %}.
|
||||||
 `read:project`| Grants read only access to user and organization {% data variables.projects.projects_v2 %}.{% endif %}
|
 `read:project`| Grants read only access to user and organization {% data variables.projects.projects_v2 %}.{% endif %}
|
||||||
**`delete_repo`** | Grants access to delete adminable repositories.{% ifversion team-discussions %}
|
**`delete_repo`** | Grants access to delete adminable repositories.
|
||||||
**`write:discussion`** | Allows read and write access for team discussions.
|
|
||||||
 `read:discussion` | Allows read access for team discussions.{% endif %}
|
|
||||||
**`write:packages`** | Grants access to upload or publish a package in {% data variables.product.prodname_registry %}. For more information, see [AUTOTITLE](/packages/learn-github-packages/publishing-a-package).
|
**`write:packages`** | Grants access to upload or publish a package in {% data variables.product.prodname_registry %}. For more information, see [AUTOTITLE](/packages/learn-github-packages/publishing-a-package).
|
||||||
**`read:packages`** | Grants access to download or install packages from {% data variables.product.prodname_registry %}. For more information, see [AUTOTITLE](/packages/learn-github-packages/installing-a-package).
|
**`read:packages`** | Grants access to download or install packages from {% data variables.product.prodname_registry %}. For more information, see [AUTOTITLE](/packages/learn-github-packages/installing-a-package).
|
||||||
**`delete:packages`** | Grants access to delete packages from {% data variables.product.prodname_registry %}. For more information, see [AUTOTITLE](/packages/learn-github-packages/deleting-and-restoring-a-package).
|
**`delete:packages`** | Grants access to delete packages from {% data variables.product.prodname_registry %}. For more information, see [AUTOTITLE](/packages/learn-github-packages/deleting-and-restoring-a-package).
|
||||||
|
|||||||
@@ -103,15 +103,6 @@ For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-d
|
|||||||
|
|
||||||
Enabling 2FA doesn't change how you authenticate to {% data variables.product.github %} on the command line using SSH URLs. For more information about setting up and using an SSH key, see [AUTOTITLE](/authentication/connecting-to-github-with-ssh).
|
Enabling 2FA doesn't change how you authenticate to {% data variables.product.github %} on the command line using SSH URLs. For more information about setting up and using an SSH key, see [AUTOTITLE](/authentication/connecting-to-github-with-ssh).
|
||||||
|
|
||||||
{% ifversion ghes < 3.13 %}
|
|
||||||
|
|
||||||
## Using two-factor authentication to access a repository using Subversion
|
|
||||||
|
|
||||||
{% data reusables.subversion.sunset %}
|
|
||||||
|
|
||||||
When you access a repository via Subversion, you must provide a {% data variables.product.pat_generic %} instead of entering your password. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
If you lose access to your two-factor authentication credentials, you can use your recovery codes or another recovery method (if you've set one up) to regain access to your account. For more information, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials).
|
If you lose access to your two-factor authentication credentials, you can use your recovery codes or another recovery method (if you've set one up) to regain access to your account. For more information, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials).
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: About billing for {% data variables.product.prodname_GHAS %}
|
title: About billing for {% data variables.product.prodname_GHAS %}
|
||||||
intro: '{% ifversion ghes = 3.12 %}Learn how the use of {% data variables.product.prodname_GHAS %} licenses is calculated.{% else %}Learn about the licensing models for {% data variables.product.prodname_AS %} products and how the use of {% data variables.product.prodname_GHAS_cs_and_sp %} licenses is calculated.{% endif %}'
|
intro: 'Learn about the licensing models for {% data variables.product.prodname_AS %} products and how the use of {% data variables.product.prodname_GHAS_cs_and_sp %} licenses is calculated.'
|
||||||
allowTitleToDifferFromFilename: true
|
allowTitleToDifferFromFilename: true
|
||||||
product: '{% data reusables.gated-features.ghas-billing %}'
|
product: '{% data reusables.gated-features.ghas-billing %}'
|
||||||
redirect_from:
|
redirect_from:
|
||||||
@@ -46,8 +46,6 @@ You can make extra features available to users with a license for {% data variab
|
|||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% ifversion metered-ghe-ghas %}
|
|
||||||
|
|
||||||
## Billing models for {% data variables.product.prodname_AS %} products
|
## Billing models for {% data variables.product.prodname_AS %} products
|
||||||
|
|
||||||
Each active committer to at least one repository with an {% data variables.product.prodname_AS %} product enabled uses one license. A committer is considered active if one of their commits has been pushed to the repository within the last 90 days, regardless of when it was originally authored.
|
Each active committer to at least one repository with an {% data variables.product.prodname_AS %} product enabled uses one license. A committer is considered active if one of their commits has been pushed to the repository within the last 90 days, regardless of when it was originally authored.
|
||||||
@@ -68,10 +66,6 @@ There are two different ways to pay for licenses.
|
|||||||
* Purchase a specific number of {% data variables.product.prodname_GHAS_cs_or_sp %} licenses that last for a defined period, typically at least a year.
|
* Purchase a specific number of {% data variables.product.prodname_GHAS_cs_or_sp %} licenses that last for a defined period, typically at least a year.
|
||||||
* If the usage of {% data variables.product.prodname_AS %} by active committers exceeds the number of licenses purchased, you need to purchase additional licenses to cover this overage usage.
|
* If the usage of {% data variables.product.prodname_AS %} by active committers exceeds the number of licenses purchased, you need to purchase additional licenses to cover this overage usage.
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
{% ifversion metered-ghe-ghas %}
|
|
||||||
|
|
||||||
## Managing committers and costs
|
## Managing committers and costs
|
||||||
|
|
||||||
{% ifversion fpt %}
|
{% ifversion fpt %}
|
||||||
@@ -97,16 +91,10 @@ You can control usage and costs with {% ifversion ghec %}cost centers, policies,
|
|||||||
If your enterprise uses {% data variables.product.prodname_AS %} on both {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}, you can ensure users aren't consuming multiple licenses unnecessarily by synchronizing license usage between environments.{% ifversion ghec %} {% data variables.product.prodname_AS %} is included in license sync in {% data variables.product.prodname_ghe_server %} version 3.12 and later.{% endif %} See [AUTOTITLE](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud).
|
If your enterprise uses {% data variables.product.prodname_AS %} on both {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}, you can ensure users aren't consuming multiple licenses unnecessarily by synchronizing license usage between environments.{% ifversion ghec %} {% data variables.product.prodname_AS %} is included in license sync in {% data variables.product.prodname_ghe_server %} version 3.12 and later.{% endif %} See [AUTOTITLE](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud).
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% endif %}
|
{% ifversion ghec or ghes %}
|
||||||
|
|
||||||
{% ifversion ghec or ghes > 3.12 %}
|
|
||||||
<!--Volume/Subscription billing for GHCS and GH SP is not available for GitHub Teams-->
|
<!--Volume/Subscription billing for GHCS and GH SP is not available for GitHub Teams-->
|
||||||
### Volume/subscription billing
|
### Volume/subscription billing
|
||||||
|
|
||||||
{% elsif ghes < 3.13 %}
|
|
||||||
<!--Volume/Subscription billing is the only option for GHES 3.12-->
|
|
||||||
## License size
|
|
||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
Each license specifies a maximum number of accounts that can use {% data variables.product.prodname_AS %}. Each active committer to at least one repository with the product enabled consumes one license. When you remove a user from your {% data variables.enterprise.enterprise_or_org %} account, the user's license is freed within 24 hours.
|
Each license specifies a maximum number of accounts that can use {% data variables.product.prodname_AS %}. Each active committer to at least one repository with the product enabled consumes one license. When you remove a user from your {% data variables.enterprise.enterprise_or_org %} account, the user's license is freed within 24 hours.
|
||||||
@@ -138,8 +126,6 @@ Users can contribute to multiple repositories or organizations. Usage is measure
|
|||||||
|
|
||||||
When you enable or disable {% data variables.product.prodname_GH_cs_or_sp %} for one or more repositories, {% data variables.product.github %} displays an overview of how this will change your usage.
|
When you enable or disable {% data variables.product.prodname_GH_cs_or_sp %} for one or more repositories, {% data variables.product.github %} displays an overview of how this will change your usage.
|
||||||
|
|
||||||
{% ifversion metered-ghe-ghas %}
|
|
||||||
|
|
||||||
* Metered billing, showing an increase or reduction in the number of active committers using licenses.
|
* Metered billing, showing an increase or reduction in the number of active committers using licenses.
|
||||||
* Volume/subscription billing, showing the number of licenses used or freed by unique active committers.
|
* Volume/subscription billing, showing the number of licenses used or freed by unique active committers.
|
||||||
|
|
||||||
@@ -155,25 +141,10 @@ The following example timeline demonstrates how the active committer count for {
|
|||||||
| <span style="white-space: nowrap;">August 15</span> | A member of your enterprise enables {% data variables.product.prodname_GH_cs_and_sp %} for a second repository, repository **Y**. In the last 90 days, a total of 20 developers contributed to that repository. Of those 20 developers, 10 also recently worked on repo **X** and do not require additional licenses. | 49 + 10 =<br>**59** | Billing increases to 59 committers, accounting for the 10 additional unique contributors. |
|
| <span style="white-space: nowrap;">August 15</span> | A member of your enterprise enables {% data variables.product.prodname_GH_cs_and_sp %} for a second repository, repository **Y**. In the last 90 days, a total of 20 developers contributed to that repository. Of those 20 developers, 10 also recently worked on repo **X** and do not require additional licenses. | 49 + 10 =<br>**59** | Billing increases to 59 committers, accounting for the 10 additional unique contributors. |
|
||||||
| <span style="white-space: nowrap;">August 16</span> | A member of your enterprise disables {% data variables.product.prodname_GH_cs_and_sp %} for repository **X**. Of the 49 developers who were working on repository **X**, 10 still also work on repository **Y**, which has a total of 20 developers contributing in the last 90 days. | 49 - 29 =<br>**20** | Billing for repository **X** continues until the end of the monthly billing cycle, but the overall billing count decreases to 20 committers for the next cycle. |
|
| <span style="white-space: nowrap;">August 16</span> | A member of your enterprise disables {% data variables.product.prodname_GH_cs_and_sp %} for repository **X**. Of the 49 developers who were working on repository **X**, 10 still also work on repository **Y**, which has a total of 20 developers contributing in the last 90 days. | 49 - 29 =<br>**20** | Billing for repository **X** continues until the end of the monthly billing cycle, but the overall billing count decreases to 20 committers for the next cycle. |
|
||||||
|
|
||||||
{% else %}
|
|
||||||
|
|
||||||
The following example timeline demonstrates how active committer count for {% data variables.product.prodname_AS %} could change over time in an enterprise. For each month, you will find events, along with the resulting committer count.
|
|
||||||
|
|
||||||
| Date | Events during the month | Total committers |
|
|
||||||
| :- | :- | -: |
|
|
||||||
| <span style="white-space: nowrap;">April 15</span> | A member of your enterprise enables {% data variables.product.prodname_GHAS %} for repository **X**. Repository **X** has 50 committers over the past 90 days. | **50** |
|
|
||||||
| <span style="white-space: nowrap;">May 1</span> | Developer **A** leaves the team working on repository **X**. Developer **A**'s contributions continue to count for 90 days. | **50** | **50** |
|
|
||||||
| <span style="white-space: nowrap;">August 1</span> | Developer **A**'s contributions no longer count towards the licenses required, because 90 days have passed. | 50 - 1 =<br>**49** |
|
|
||||||
| <span style="white-space: nowrap;">August 15</span> | A member of your enterprise enables {% data variables.product.prodname_GHAS %} for a second repository, repository **Y**. In the last 90 days, a total of 20 developers contributed to that repository. Of those 20 developers, 10 also recently worked on repo **X** and do not require additional licenses. | 49 + 10 =<br>**59** |
|
|
||||||
| <span style="white-space: nowrap;">August 16</span> | A member of your enterprise disables {% data variables.product.prodname_GHAS %} for repository **X**. Of the 49 developers who were working on repository **X**, 10 still also work on repository **Y**, which has a total of 20 developers contributing in the last 90 days. | 49 - 29 =<br>**20** |
|
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## Further reading
|
## Further reading
|
||||||
|
|
||||||
* [AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/viewing-your-github-advanced-security-usage)
|
* [AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/viewing-your-github-advanced-security-usage)
|
||||||
{%- ifversion metered-ghe-ghas %}{% ifversion ghec %}
|
{% ifversion ghec %}
|
||||||
* [AUTOTITLE](/enterprise-cloud@latest/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/managing-your-github-advanced-security-licensing){% elsif ghes %}
|
* [AUTOTITLE](/enterprise-cloud@latest/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/managing-your-github-advanced-security-licensing){% elsif ghes %}
|
||||||
* [AUTOTITLE](/enterprise-cloud@latest/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/managing-your-github-advanced-security-licensing) in the documentation for {% data variables.product.prodname_ghe_cloud %}{% endif %}
|
* [AUTOTITLE](/enterprise-cloud@latest/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/managing-your-github-advanced-security-licensing) in the documentation for {% data variables.product.prodname_ghe_cloud %}{% endif %}
|
||||||
* {% ifversion fpt or ghec %}[AUTOTITLE](/billing/managing-your-billing/preventing-overspending){% elsif ghes %}[AUTOTITLE](/enterprise-cloud@latest/billing/managing-your-billing/preventing-overspending) in the documentation for {% data variables.product.prodname_ghe_cloud %}{% endif %}
|
* {% ifversion fpt or ghec %}[AUTOTITLE](/billing/managing-your-billing/preventing-overspending){% elsif ghes %}[AUTOTITLE](/enterprise-cloud@latest/billing/managing-your-billing/preventing-overspending) in the documentation for {% data variables.product.prodname_ghe_cloud %}{% endif %}
|
||||||
{% endif %}
|
|
||||||
|
|||||||
@@ -41,12 +41,8 @@ To set up a trial of {% data variables.product.prodname_GHAS %} using this metho
|
|||||||
|
|
||||||
You can finish your trial at any time by purchasing licenses for {% data variables.product.prodname_GH_cs_or_sp %}. If you haven't made a purchase by the end of the 30 days, your trial will expire.
|
You can finish your trial at any time by purchasing licenses for {% data variables.product.prodname_GH_cs_or_sp %}. If you haven't made a purchase by the end of the 30 days, your trial will expire.
|
||||||
|
|
||||||
{% ifversion metered-ghe-ghas %}
|
|
||||||
|
|
||||||
If you pay for {% data variables.product.prodname_ghe_cloud %} with metered billing, but did not set up a free trial of {% data variables.product.prodname_GHAS %}, you can still use metered-based billing to pay for {% data variables.product.prodname_AS %} products after the {% data variables.product.prodname_ghe_cloud %} trial ends. For more information, contact [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact).
|
If you pay for {% data variables.product.prodname_ghe_cloud %} with metered billing, but did not set up a free trial of {% data variables.product.prodname_GHAS %}, you can still use metered-based billing to pay for {% data variables.product.prodname_AS %} products after the {% data variables.product.prodname_ghe_cloud %} trial ends. For more information, contact [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact).
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||||
{% data reusables.enterprise-accounts.settings-tab %}
|
{% data reusables.enterprise-accounts.settings-tab %}
|
||||||
{% data reusables.enterprise-accounts.licensing-tab-both-platforms %}
|
{% data reusables.enterprise-accounts.licensing-tab-both-platforms %}
|
||||||
|
|||||||
@@ -37,8 +37,6 @@ To ensure the same user isn't consuming more than one license for multiple enter
|
|||||||
In addition to {% ifversion enterprise-licensing-language %}showing billable {% data variables.product.prodname_enterprise %} licenses{% else %}licensed seats{% endif %}, your bill may include other charges, such as {% data variables.product.prodname_GHAS %}. See [AUTOTITLE](/billing/managing-your-billing/about-billing-for-your-enterprise).
|
In addition to {% ifversion enterprise-licensing-language %}showing billable {% data variables.product.prodname_enterprise %} licenses{% else %}licensed seats{% endif %}, your bill may include other charges, such as {% data variables.product.prodname_GHAS %}. See [AUTOTITLE](/billing/managing-your-billing/about-billing-for-your-enterprise).
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% ifversion metered-ghe-ghas %}
|
|
||||||
|
|
||||||
## Two billing models for {% data variables.product.prodname_enterprise %} licenses
|
## Two billing models for {% data variables.product.prodname_enterprise %} licenses
|
||||||
|
|
||||||
With usage-based billing, you pay for the number of licenses you use each month. You do not need to buy a predefined number of licenses in advance. See, [AUTOTITLE](/billing/managing-your-billing/about-usage-based-billing-for-licenses).
|
With usage-based billing, you pay for the number of licenses you use each month. You do not need to buy a predefined number of licenses in advance. See, [AUTOTITLE](/billing/managing-your-billing/about-usage-based-billing-for-licenses).
|
||||||
@@ -47,8 +45,6 @@ You are already enrolled in usage-based billing if you created a trial of {% dat
|
|||||||
|
|
||||||
If you currently pay for your {% data variables.product.prodname_enterprise %} licenses by invoice with a volume, subscription, or prepaid agreement, you will continue to be billed in this way until your agreement expires. At renewal, you have the option to switch to the metered billing model.
|
If you currently pay for your {% data variables.product.prodname_enterprise %} licenses by invoice with a volume, subscription, or prepaid agreement, you will continue to be billed in this way until your agreement expires. At renewal, you have the option to switch to the metered billing model.
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## People that consume a license
|
## People that consume a license
|
||||||
|
|
||||||
{% data reusables.enterprise-managed.repo-collaborators-note %}
|
{% data reusables.enterprise-managed.repo-collaborators-note %}
|
||||||
|
|||||||
@@ -14,12 +14,9 @@ versions:
|
|||||||
shortTitle: Connect an Azure subscription
|
shortTitle: Connect an Azure subscription
|
||||||
---
|
---
|
||||||
|
|
||||||
{% ifversion metered-ghe-ghas %}
|
|
||||||
|
|
||||||
{% data reusables.billing.usage-based-billing %}
|
{% data reusables.billing.usage-based-billing %}
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## About connection of an Azure subscription
|
## About connection of an Azure subscription
|
||||||
|
|
||||||
You can pay for usage of {% data variables.product.github %} features through Azure by connecting an Azure Subscription ID to your organization {% ifversion ghec %}or enterprise{% endif %} account on {% data variables.location.product_location %}. {% ifversion fpt %}For more information about organization accounts, see [AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/about-organizations).{% elsif ghec %}
|
You can pay for usage of {% data variables.product.github %} features through Azure by connecting an Azure Subscription ID to your organization {% ifversion ghec %}or enterprise{% endif %} account on {% data variables.location.product_location %}. {% ifversion fpt %}For more information about organization accounts, see [AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/about-organizations).{% elsif ghec %}
|
||||||
@@ -44,14 +41,11 @@ If you use {% data variables.product.prodname_ghe_cloud %} through a Microsoft E
|
|||||||
| {% data variables.product.prodname_actions %} usage beyond the amounts included with your plan | [AUTOTITLE](/billing/managing-billing-for-github-actions/about-billing-for-github-actions) | [AUTOTITLE](/billing/managing-billing-for-github-actions/about-billing-for-github-actions#about-spending-limits) |
|
| {% data variables.product.prodname_actions %} usage beyond the amounts included with your plan | [AUTOTITLE](/billing/managing-billing-for-github-actions/about-billing-for-github-actions) | [AUTOTITLE](/billing/managing-billing-for-github-actions/about-billing-for-github-actions#about-spending-limits) |
|
||||||
| {% data variables.product.prodname_registry %} usage beyond the amounts included with your plan | [AUTOTITLE](/billing/managing-billing-for-github-packages/about-billing-for-github-packages) | [AUTOTITLE](/billing/managing-billing-for-github-packages/about-billing-for-github-packages#about-spending-limits) |
|
| {% data variables.product.prodname_registry %} usage beyond the amounts included with your plan | [AUTOTITLE](/billing/managing-billing-for-github-packages/about-billing-for-github-packages) | [AUTOTITLE](/billing/managing-billing-for-github-packages/about-billing-for-github-packages#about-spending-limits) |
|
||||||
| {% data variables.product.prodname_copilot_business_short %} usage | [AUTOTITLE](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot-business-and-github-copilot-enterprise) | N/A |
|
| {% data variables.product.prodname_copilot_business_short %} usage | [AUTOTITLE](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot-business-and-github-copilot-enterprise) | N/A |
|
||||||
| {% ifversion metered-ghe-ghas %} |
|
|
||||||
| {% data variables.product.prodname_AS %} usage (only available with a trial of {% data variables.product.prodname_ghe_cloud %}) | [AUTOTITLE](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security#usage-based-billing-for-github-advanced-security) | N/A |
|
| {% data variables.product.prodname_AS %} usage (only available with a trial of {% data variables.product.prodname_ghe_cloud %}) | [AUTOTITLE](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security#usage-based-billing-for-github-advanced-security) | N/A |
|
||||||
| {% data variables.product.prodname_enterprise %} usage | [AUTOTITLE](/billing/managing-your-billing/about-billing-for-your-enterprise) | N/A |
|
| {% data variables.product.prodname_enterprise %} usage | [AUTOTITLE](/billing/managing-your-billing/about-billing-for-your-enterprise) | N/A |
|
||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## About billing through Azure
|
## About billing through Azure
|
||||||
|
|
||||||
If you link your {% data variables.product.company_short %} account to Azure, any usage-based costs starting from that point will be billed through Azure and charged on the 1st of each month. However, remaining {% data variables.product.company_short %} charges, for example charges for your {% data variables.product.prodname_dotcom %} plan, will still be billed on your usual billing date.
|
If you link your {% data variables.product.company_short %} account to Azure, any usage-based costs starting from that point will be billed through Azure and charged on the 1st of each month. However, remaining {% data variables.product.company_short %} charges, for example charges for your {% data variables.product.prodname_dotcom %} plan, will still be billed on your usual billing date.
|
||||||
|
|||||||
@@ -42,12 +42,8 @@ If you want to view an overview of your subscription and usage for {% data varia
|
|||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% ifversion metered-ghe-ghas %}
|
|
||||||
|
|
||||||
{% data reusables.billing.usage-based-billing %}
|
{% data reusables.billing.usage-based-billing %}
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## Viewing the subscription and usage for your enterprise account
|
## Viewing the subscription and usage for your enterprise account
|
||||||
|
|
||||||
You can view the subscription and usage for your enterprise and download a file with license details.
|
You can view the subscription and usage for your enterprise and download a file with license details.
|
||||||
|
|||||||
@@ -28,12 +28,8 @@ Usage-based billing applies when the cost of a paid product depends on how much
|
|||||||
|
|
||||||
Your plan may come with included amounts of usage-based products. For example, with {% data variables.product.prodname_pro %}, your personal account gets 3,000 minutes of {% data variables.product.prodname_actions %} usage for free each month. You can control usage beyond the included amounts by setting spending limits.
|
Your plan may come with included amounts of usage-based products. For example, with {% data variables.product.prodname_pro %}, your personal account gets 3,000 minutes of {% data variables.product.prodname_actions %} usage for free each month. You can control usage beyond the included amounts by setting spending limits.
|
||||||
|
|
||||||
{% ifversion us-sales-tax %}
|
|
||||||
|
|
||||||
{% data reusables.billing.us-sales-tax %}
|
{% data reusables.billing.us-sales-tax %}
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## Included amounts by plan
|
## Included amounts by plan
|
||||||
|
|
||||||
<table>
|
<table>
|
||||||
|
|||||||
@@ -57,14 +57,10 @@ The products shown in the new billing platform are determined by your {% data va
|
|||||||
* {% data variables.product.prodname_registry %}
|
* {% data variables.product.prodname_registry %}
|
||||||
* {% data variables.large_files.product_name_long %}
|
* {% data variables.large_files.product_name_long %}
|
||||||
|
|
||||||
{% ifversion metered-ghe-ghas %}
|
|
||||||
|
|
||||||
{% data reusables.billing.actions-usage-delay %}
|
{% data reusables.billing.actions-usage-delay %}
|
||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## Key functionalities
|
## Key functionalities
|
||||||
|
|
||||||
With the new billing platform, you can:
|
With the new billing platform, you can:
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: About usage-based billing for licenses
|
title: About usage-based billing for licenses
|
||||||
intro: Learn about usage-based billing for your licenses with the new billing platform, whether you pay through {% data variables.product.company_short %} or Azure.
|
intro: 'Learn about usage-based billing for your licenses with the new billing platform, whether you pay through {% data variables.product.company_short %} or Azure.'
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /early-access/billing/managing-usage-based-billing-for-github-licenses-through-github
|
- /early-access/billing/managing-usage-based-billing-for-github-licenses-through-github
|
||||||
- /early-access/billing/managing-usage-based-billing-for-github-licenses-through-azure
|
- /early-access/billing/managing-usage-based-billing-for-github-licenses-through-azure
|
||||||
@@ -11,11 +11,11 @@ redirect_from:
|
|||||||
- /billing/using-the-new-billing-platform/about-usage-based-billing-for-licenses
|
- /billing/using-the-new-billing-platform/about-usage-based-billing-for-licenses
|
||||||
versions:
|
versions:
|
||||||
ghec: '*'
|
ghec: '*'
|
||||||
ghes: '>= 3.13'
|
ghes: '*'
|
||||||
type: overview
|
type: overview
|
||||||
topics:
|
topics:
|
||||||
- Enterprise
|
- Enterprise
|
||||||
permissions: 'Enterprise administrators'
|
permissions: Enterprise administrators
|
||||||
product: '{% data reusables.billing.enhanced-billing-platform-product %}'
|
product: '{% data reusables.billing.enhanced-billing-platform-product %}'
|
||||||
shortTitle: Usage-based billing for licenses
|
shortTitle: Usage-based billing for licenses
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -74,12 +74,10 @@ On this page, you can view your usage in the following categories:
|
|||||||
{% endif %}
|
{% endif %}
|
||||||
* **By products:** You can use the product tabs to view usage and discounts for different products.
|
* **By products:** You can use the product tabs to view usage and discounts for different products.
|
||||||
|
|
||||||
{% ifversion metered-ghe-ghas %}
|

|
||||||
|
|
||||||
{% data reusables.billing.actions-usage-delay %}
|
{% data reusables.billing.actions-usage-delay %}
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
{% ifversion ghec %}
|
{% ifversion ghec %}
|
||||||
|
|
||||||
## Viewing prepaid credits
|
## Viewing prepaid credits
|
||||||
|
|||||||
@@ -11,12 +11,9 @@ topics:
|
|||||||
shortTitle: About licenses
|
shortTitle: About licenses
|
||||||
---
|
---
|
||||||
|
|
||||||
{% ifversion metered-ghe-ghas %}
|
|
||||||
|
|
||||||
{% data reusables.billing.usage-based-billing %}
|
{% data reusables.billing.usage-based-billing %}
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## About licensing for {% data variables.product.prodname_enterprise %}
|
## About licensing for {% data variables.product.prodname_enterprise %}
|
||||||
|
|
||||||
{% data reusables.enterprise.about-deployment-methods %}
|
{% data reusables.enterprise.about-deployment-methods %}
|
||||||
|
|||||||
@@ -12,12 +12,9 @@ topics:
|
|||||||
shortTitle: Download your license
|
shortTitle: Download your license
|
||||||
---
|
---
|
||||||
|
|
||||||
{% ifversion metered-ghe-ghas %}
|
|
||||||
|
|
||||||
{% data reusables.billing.usage-based-billing %}
|
{% data reusables.billing.usage-based-billing %}
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## About license files for {% data variables.product.prodname_enterprise %}
|
## About license files for {% data variables.product.prodname_enterprise %}
|
||||||
|
|
||||||
After you purchase or upgrade a license for {% data variables.product.prodname_enterprise %} from {% data variables.contact.contact_enterprise_sales %}, you must download your new license file. For more information about licenses for {% data variables.product.prodname_enterprise %}, see [AUTOTITLE](/billing/managing-your-license-for-github-enterprise/about-licenses-for-github-enterprise).
|
After you purchase or upgrade a license for {% data variables.product.prodname_enterprise %} from {% data variables.contact.contact_enterprise_sales %}, you must download your new license file. For more information about licenses for {% data variables.product.prodname_enterprise %}, see [AUTOTITLE](/billing/managing-your-license-for-github-enterprise/about-licenses-for-github-enterprise).
|
||||||
|
|||||||
@@ -18,13 +18,6 @@ After you purchase or upgrade a license for {% data variables.product.prodname_e
|
|||||||
|
|
||||||
## Uploading your license from the {% data variables.enterprise.management_console %}
|
## Uploading your license from the {% data variables.enterprise.management_console %}
|
||||||
|
|
||||||
{% ifversion ghes < 3.13 %}
|
|
||||||
|
|
||||||
> [!WARNING]
|
|
||||||
> Updating your license causes a small amount of downtime for {% data variables.location.product_location %}.
|
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
1. Sign into {% data variables.location.product_location_enterprise %} as a site administrator.
|
1. Sign into {% data variables.location.product_location_enterprise %} as a site administrator.
|
||||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||||
{% data reusables.enterprise-accounts.settings-tab %}
|
{% data reusables.enterprise-accounts.settings-tab %}
|
||||||
@@ -35,9 +28,7 @@ After you purchase or upgrade a license for {% data variables.product.prodname_e
|
|||||||
1. To upload your license, click **License file**, or drag your license file onto **License file**.
|
1. To upload your license, click **License file**, or drag your license file onto **License file**.
|
||||||
|
|
||||||

|

|
||||||
1. Click **Upload**.{% ifversion ghes > 3.12 %} Your license will be updated in the background. The change may take a few minutes before it is visible on your instance.{% endif %}
|
1. Click **Upload**. Your license will be updated in the background. The change may take a few minutes before it is visible on your instance.
|
||||||
|
|
||||||
{% ifversion ghes > 3.12 %}
|
|
||||||
|
|
||||||
## Uploading your license with the REST API
|
## Uploading your license with the REST API
|
||||||
|
|
||||||
@@ -52,5 +43,3 @@ For more information about accessing your instance via the extension, see [AUTOT
|
|||||||
## Uploading a license via SSH
|
## Uploading a license via SSH
|
||||||
|
|
||||||
You can upload and interact with your license from the command line via SSH. See the documentation for the `ghe-license` command in [AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities#ghe-license). For more information about accessing your instance via SSH, see [AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh).
|
You can upload and interact with your license from the command line via SSH. See the documentation for the `ghe-license` command in [AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities#ghe-license). For more information about accessing your instance via SSH, see [AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh).
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|||||||
@@ -255,12 +255,8 @@ If your codebase depends on a library or framework that is not recognized by the
|
|||||||
|
|
||||||
{% data reusables.code-scanning.beta-model-packs %}
|
{% data reusables.code-scanning.beta-model-packs %}
|
||||||
|
|
||||||
{% ifversion codeql-threat-models %}
|
|
||||||
|
|
||||||
### Using {% data variables.product.prodname_codeql %} model packs
|
### Using {% data variables.product.prodname_codeql %} model packs
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
To add one or more published {% data variables.product.prodname_codeql %} model packs, specify them inside the `with: packs:` entry within the `uses: {% data reusables.actions.action-codeql-action-init %}` section of the workflow. Within `packs` you specify one or more packages to use and, optionally, which version to download. Where you don't specify a version, the latest version is downloaded. If you want to use packages that are not publicly available, you need to set the `GITHUB_TOKEN` environment variable to a secret that has access to the packages. For more information, see [AUTOTITLE](/actions/security-guides/automatic-token-authentication) and [AUTOTITLE](/actions/security-guides/encrypted-secrets).
|
To add one or more published {% data variables.product.prodname_codeql %} model packs, specify them inside the `with: packs:` entry within the `uses: {% data reusables.actions.action-codeql-action-init %}` section of the workflow. Within `packs` you specify one or more packages to use and, optionally, which version to download. Where you don't specify a version, the latest version is downloaded. If you want to use packages that are not publicly available, you need to set the `GITHUB_TOKEN` environment variable to a secret that has access to the packages. For more information, see [AUTOTITLE](/actions/security-guides/automatic-token-authentication) and [AUTOTITLE](/actions/security-guides/encrypted-secrets).
|
||||||
|
|
||||||
``` yaml copy
|
``` yaml copy
|
||||||
@@ -440,16 +436,12 @@ packs:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% ifversion codeql-threat-models %}
|
|
||||||
|
|
||||||
### Extending {% data variables.product.prodname_codeql %} coverage with threat models
|
### Extending {% data variables.product.prodname_codeql %} coverage with threat models
|
||||||
|
|
||||||
{% data reusables.code-scanning.beta-threat-models %}
|
{% data reusables.code-scanning.beta-threat-models %}
|
||||||
|
|
||||||
The default threat model includes remote sources of untrusted data. You can extend the {% data variables.product.prodname_codeql %} threat model to include local sources of untrusted data (for example: command-line arguments, environment variables, file systems, and databases) by specifying `threat-models: local` in a custom configuration file. If you extend the threat model, the default threat model will also be used.
|
The default threat model includes remote sources of untrusted data. You can extend the {% data variables.product.prodname_codeql %} threat model to include local sources of untrusted data (for example: command-line arguments, environment variables, file systems, and databases) by specifying `threat-models: local` in a custom configuration file. If you extend the threat model, the default threat model will also be used.
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
### Specifying additional queries
|
### Specifying additional queries
|
||||||
|
|
||||||
You specify additional queries in a `queries` array. Each element of the array contains a `uses` parameter with a value that identifies a single query file, a directory containing query files, or a query suite definition file.
|
You specify additional queries in a `queries` array. Each element of the array contains a `uses` parameter with a value that identifies a single query file, a directory containing query files, or a query suite definition file.
|
||||||
|
|||||||
@@ -45,12 +45,11 @@ For repositories that are not eligible for default setup, you can configure adva
|
|||||||
A repository must meet all the following criteria to be eligible for default setup, otherwise you need to use advanced setup.
|
A repository must meet all the following criteria to be eligible for default setup, otherwise you need to use advanced setup.
|
||||||
|
|
||||||
* Advanced setup for {% data variables.product.prodname_code_scanning %} is not already enabled.
|
* Advanced setup for {% data variables.product.prodname_code_scanning %} is not already enabled.
|
||||||
{% ifversion default-setup-pre-enablement %}* Uses Go, JavaScript/TypeScript, Python, or Ruby.{% endif %}
|
* Uses Go, JavaScript/TypeScript, Python, or Ruby.
|
||||||
{% data reusables.code-scanning.require-actions-ghcs %}
|
{% data reusables.code-scanning.require-actions-ghcs %}
|
||||||
|
|
||||||
{% ifversion default-setup-pre-enablement %}
|
|
||||||
{% data reusables.code-scanning.default-setup-pre-enablement-explanation %}
|
{% data reusables.code-scanning.default-setup-pre-enablement-explanation %}
|
||||||
{% endif %}
|
|
||||||
{% ifversion pre-security-configurations %}
|
{% ifversion pre-security-configurations %}
|
||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
@@ -86,8 +85,8 @@ Through the "{% data variables.product.UI_advanced_security %}" page of your org
|
|||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
> * {% data reusables.code-scanning.limitation-org-enable-all %}
|
> * {% data reusables.code-scanning.limitation-org-enable-all %}
|
||||||
> * Enabling {% data variables.product.prodname_code_scanning %} for all eligible repositories in an organization will not override existing {% data variables.product.prodname_code_scanning %} configurations. For information on configuring default setup with different settings for specific repositories, see [AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning).{% ifversion default-setup-pre-enablement %}
|
> * Enabling {% data variables.product.prodname_code_scanning %} for all eligible repositories in an organization will not override existing {% data variables.product.prodname_code_scanning %} configurations. For information on configuring default setup with different settings for specific repositories, see [AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning).
|
||||||
> * Enabling default setup for all eligible repositories in an organization includes eligible repositories without {% data variables.product.prodname_codeql %}-supported languages. If a {% data variables.product.prodname_codeql %}-supported language is later added to one of these repositories, default setup will begin scanning that repository and consuming {% data variables.product.prodname_actions %} minutes.{% endif %}
|
> * Enabling default setup for all eligible repositories in an organization includes eligible repositories without {% data variables.product.prodname_codeql %}-supported languages. If a {% data variables.product.prodname_codeql %}-supported language is later added to one of these repositories, default setup will begin scanning that repository and consuming {% data variables.product.prodname_actions %} minutes.
|
||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
|
|||||||
@@ -33,30 +33,20 @@ Default setup for {% data variables.product.prodname_code_scanning %} is the qui
|
|||||||
* When creating or committing to a pull request based against the repository's default branch, or any protected branch, excluding pull requests from forks.
|
* When creating or committing to a pull request based against the repository's default branch, or any protected branch, excluding pull requests from forks.
|
||||||
* On a weekly schedule.
|
* On a weekly schedule.
|
||||||
|
|
||||||
{% ifversion code-scanning-default-setup-exclude-dormant-repos %}
|
|
||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
> If no pushes and pull requests have occurred in a repository with default setup enabled for 6 months, the weekly schedule will be disabled to save your {% data variables.product.prodname_actions %} minutes.
|
> If no pushes and pull requests have occurred in a repository with default setup enabled for 6 months, the weekly schedule will be disabled to save your {% data variables.product.prodname_actions %} minutes.
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
You can also enable default setup for multiple or all repositories in an organization at the same time. For information on bulk enablement, see [AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning-at-scale).
|
You can also enable default setup for multiple or all repositories in an organization at the same time. For information on bulk enablement, see [AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning-at-scale).
|
||||||
|
|
||||||
If you need more granular control over your {% data variables.product.prodname_code_scanning %} configuration, you should instead configure advanced setup. For more information, see [AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning).
|
If you need more granular control over your {% data variables.product.prodname_code_scanning %} configuration, you should instead configure advanced setup. For more information, see [AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning).
|
||||||
|
|
||||||
### Requirements for using default setup
|
### Requirements for using default setup
|
||||||
|
|
||||||
Your repository is eligible for default setup for {% data variables.product.prodname_code_scanning %} if:{% ifversion default-setup-pre-enablement %}
|
Your repository is eligible for default setup for {% data variables.product.prodname_code_scanning %} if:
|
||||||
<!-- No restrictions on languages. Can be set up before CodeQL supported languages are added. -->
|
|
||||||
{% else %}
|
|
||||||
* It includes at least one {% data variables.product.prodname_codeql %}-supported language.{% endif %}
|
|
||||||
{% data reusables.code-scanning.require-actions-ghcs %}
|
{% data reusables.code-scanning.require-actions-ghcs %}
|
||||||
|
|
||||||
{% ifversion default-setup-pre-enablement %}
|
|
||||||
{% data reusables.code-scanning.default-setup-pre-enablement-explanation %}
|
{% data reusables.code-scanning.default-setup-pre-enablement-explanation %}
|
||||||
{% else %}
|
|
||||||
If your repository includes at least one {% data variables.product.prodname_codeql %}-supported language, you can use default setup even if your repository also includes languages that aren't supported by {% data variables.product.prodname_codeql %}, such as R. Unsupported languages will not be scanned by default setup. For more information on {% data variables.product.prodname_codeql %}-supported languages, see [AUTOTITLE](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql#about-codeql).
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
You can use default setup for all {% data variables.product.prodname_codeql %}-supported languages for self-hosted runners or {% data variables.product.prodname_dotcom %}-hosted runners. See [Assigning labels to runners](#assigning-labels-to-runners), later in this article.
|
You can use default setup for all {% data variables.product.prodname_codeql %}-supported languages for self-hosted runners or {% data variables.product.prodname_dotcom %}-hosted runners. See [Assigning labels to runners](#assigning-labels-to-runners), later in this article.
|
||||||
|
|
||||||
@@ -75,9 +65,7 @@ Compiled languages are not automatically included in default setup configuration
|
|||||||
## Configuring default setup for a repository
|
## Configuring default setup for a repository
|
||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
{% ifversion default-setup-pre-enablement %}> If the analyses fail for all {% data variables.product.prodname_codeql %}-supported languages in a repository, default setup will still be enabled, but it will not run any scans or use any {% data variables.product.prodname_actions %} minutes until another {% data variables.product.prodname_codeql %}-supported language is added to the repository or default setup is manually reconfigured, and the analysis of a {% data variables.product.prodname_codeql %}-supported language succeeds.
|
> If the analyses fail for all {% data variables.product.prodname_codeql %}-supported languages in a repository, default setup will still be enabled, but it will not run any scans or use any {% data variables.product.prodname_actions %} minutes until another {% data variables.product.prodname_codeql %}-supported language is added to the repository or default setup is manually reconfigured, and the analysis of a {% data variables.product.prodname_codeql %}-supported language succeeds.
|
||||||
{% else %}> At least one {% data variables.product.prodname_codeql %}-supported language's analysis in a repository must succeed, or else default setup will not be successfully enabled in that repository.
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
{% data reusables.repositories.navigate-to-repo %}
|
{% data reusables.repositories.navigate-to-repo %}
|
||||||
|
|
||||||
|
|||||||
@@ -17,9 +17,8 @@ topics:
|
|||||||
|
|
||||||
After running an initial analysis of your code with default setup, you may need to make changes to your configuration to better meet your needs. For existing configurations of default setup, you can edit:
|
After running an initial analysis of your code with default setup, you may need to make changes to your configuration to better meet your needs. For existing configurations of default setup, you can edit:
|
||||||
* Which languages default setup will analyze.
|
* Which languages default setup will analyze.
|
||||||
* The query suite run during analysis. For more information on the available query suites, see [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/codeql-query-suites).{% ifversion codeql-threat-models %}
|
* The query suite run during analysis. For more information on the available query suites, see [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/codeql-query-suites).
|
||||||
* The threat models ({% data variables.release-phases.public_preview %}) to use for analysis. Your choice of threat model determines which sources of tainted data are treated as a risk to your application. During the {% data variables.release-phases.public_preview %}, threat models are supported only for analysis of {% data variables.code-scanning.code_scanning_threat_model_support %}. For more information about threat models, see [Including local sources of tainted data in default setup](#including-local-sources-of-tainted-data-in-default-setup).
|
* The threat models ({% data variables.release-phases.public_preview %}) to use for analysis. Your choice of threat model determines which sources of tainted data are treated as a risk to your application. During the {% data variables.release-phases.public_preview %}, threat models are supported only for analysis of {% data variables.code-scanning.code_scanning_threat_model_support %}. For more information about threat models, see [Including local sources of tainted data in default setup](#including-local-sources-of-tainted-data-in-default-setup).
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
If your codebase depends on a library or framework that is not recognized by the standard libraries included with {% data variables.product.prodname_codeql %}, you can also extend the {% data variables.product.prodname_codeql %} coverage in default setup using {% data variables.product.prodname_codeql %} model packs. For more information, see [Extending CodeQL coverage with CodeQL model packs in default setup](#extending-codeql-coverage-with-codeql-model-packs-in-default-setup).
|
If your codebase depends on a library or framework that is not recognized by the standard libraries included with {% data variables.product.prodname_codeql %}, you can also extend the {% data variables.product.prodname_codeql %} coverage in default setup using {% data variables.product.prodname_codeql %} model packs. For more information, see [Extending CodeQL coverage with CodeQL model packs in default setup](#extending-codeql-coverage-with-codeql-model-packs-in-default-setup).
|
||||||
|
|
||||||
@@ -41,12 +40,8 @@ If you need to change any other aspects of your {% data variables.product.prodna
|
|||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% ifversion codeql-threat-models %}
|
|
||||||
|
|
||||||
1. ({% data variables.release-phases.public_preview_caps %}) Optionally, in the "Threat model" row of the "Scan settings" section, select **Remote and local sources**. This option is only available for repositories with code in a supported language: {% data variables.code-scanning.code_scanning_threat_model_support %}.
|
1. ({% data variables.release-phases.public_preview_caps %}) Optionally, in the "Threat model" row of the "Scan settings" section, select **Remote and local sources**. This option is only available for repositories with code in a supported language: {% data variables.code-scanning.code_scanning_threat_model_support %}.
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
1. To update your configuration, as well as run an initial analysis of your code with the new configuration, click **Save changes**. All future analyses will use your new configuration.
|
1. To update your configuration, as well as run an initial analysis of your code with the new configuration, click **Save changes**. All future analyses will use your new configuration.
|
||||||
|
|
||||||
## Defining the alert severities that cause a check failure for a pull request
|
## Defining the alert severities that cause a check failure for a pull request
|
||||||
@@ -71,8 +66,6 @@ For more information, see [AUTOTITLE](/code-security/code-scanning/managing-your
|
|||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% ifversion codeql-threat-models %}
|
|
||||||
|
|
||||||
## Including local sources of tainted data in default setup
|
## Including local sources of tainted data in default setup
|
||||||
|
|
||||||
{% data reusables.code-scanning.beta-threat-models %}
|
{% data reusables.code-scanning.beta-threat-models %}
|
||||||
@@ -81,8 +74,6 @@ If your codebase only considers remote network requests to be potential sources
|
|||||||
|
|
||||||
You can edit the threat model used in a default setup configuration. For more information, see [Customizing your existing configuration of default setup](#customizing-your-existing-configuration-of-default-setup).
|
You can edit the threat model used in a default setup configuration. For more information, see [Customizing your existing configuration of default setup](#customizing-your-existing-configuration-of-default-setup).
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## Extending {% data variables.product.prodname_codeql %} coverage with {% data variables.product.prodname_codeql %} model packs in default setup
|
## Extending {% data variables.product.prodname_codeql %} coverage with {% data variables.product.prodname_codeql %} model packs in default setup
|
||||||
|
|
||||||
{% data reusables.code-scanning.beta-model-packs %}
|
{% data reusables.code-scanning.beta-model-packs %}
|
||||||
|
|||||||
@@ -31,7 +31,7 @@ The model editor has two different modes:
|
|||||||
|
|
||||||
* **Dependency mode:** The editor identifies all of the publicly accessible APIs in the selected {% data variables.product.prodname_codeql %} database. This view guides you through modeling each public API that the codebase makes available. When you have finished modeling the entire API, you can save the model and use it to improve the {% data variables.product.prodname_codeql %} analysis for all codebases that use the dependency.
|
* **Dependency mode:** The editor identifies all of the publicly accessible APIs in the selected {% data variables.product.prodname_codeql %} database. This view guides you through modeling each public API that the codebase makes available. When you have finished modeling the entire API, you can save the model and use it to improve the {% data variables.product.prodname_codeql %} analysis for all codebases that use the dependency.
|
||||||
|
|
||||||
The rest of this article covers the practical aspects of modelling dependencies using the {% data variables.product.prodname_codeql %} model editor. For technical information, see [Customizing library models for Java and Kotlin](https://codeql.github.com/docs/codeql-language-guides/customizing-library-models-for-java-and-kotlin/){% ifversion fpt or ghec or ghes > 3.14 %}, [Customizing Library Models for Python](https://codeql.github.com/docs/codeql-language-guides/customizing-library-models-for-python/), [Customizing Library Models for Ruby](https://codeql.github.com/docs/codeql-language-guides/customizing-library-models-for-ruby/), and [Customizing library models for C#](https://codeql.github.com/docs/codeql-language-guides/customizing-library-models-for-csharp/){% elsif ghes > 3.12 %}, [Customizing Library Models for Ruby](https://codeql.github.com/docs/codeql-language-guides/customizing-library-models-for-ruby/), and [Customizing library models for C#](https://codeql.github.com/docs/codeql-language-guides/customizing-library-models-for-csharp/){% endif %} in the {% data variables.product.prodname_codeql %} language documentation.
|
The rest of this article covers the practical aspects of modelling dependencies using the {% data variables.product.prodname_codeql %} model editor. For technical information, see [Customizing library models for Java and Kotlin](https://codeql.github.com/docs/codeql-language-guides/customizing-library-models-for-java-and-kotlin/){% ifversion fpt or ghec or ghes > 3.14 %}, [Customizing Library Models for Python](https://codeql.github.com/docs/codeql-language-guides/customizing-library-models-for-python/), [Customizing Library Models for Ruby](https://codeql.github.com/docs/codeql-language-guides/customizing-library-models-for-ruby/), and [Customizing library models for C#](https://codeql.github.com/docs/codeql-language-guides/customizing-library-models-for-csharp/){% elsif ghes %}, [Customizing Library Models for Ruby](https://codeql.github.com/docs/codeql-language-guides/customizing-library-models-for-ruby/), and [Customizing library models for C#](https://codeql.github.com/docs/codeql-language-guides/customizing-library-models-for-csharp/){% endif %} in the {% data variables.product.prodname_codeql %} language documentation.
|
||||||
|
|
||||||
## Displaying the {% data variables.product.prodname_codeql %} model editor
|
## Displaying the {% data variables.product.prodname_codeql %} model editor
|
||||||
|
|
||||||
|
|||||||
@@ -164,8 +164,8 @@ Examples of how to configure access to the private registries supported by {% da
|
|||||||
* [`hex-repository`](#hex-repository)
|
* [`hex-repository`](#hex-repository)
|
||||||
* [`maven-repository`](#maven-repository)
|
* [`maven-repository`](#maven-repository)
|
||||||
* [`npm-registry`](#npm-registry)
|
* [`npm-registry`](#npm-registry)
|
||||||
* [`nuget-feed`](#nuget-feed){% ifversion dependabot-updates-pub-private-registry %}
|
* [`nuget-feed`](#nuget-feed)
|
||||||
* [`pub-repository`](#pub-repository){% endif %}
|
* [`pub-repository`](#pub-repository)
|
||||||
* [`python-index`](#python-index)
|
* [`python-index`](#python-index)
|
||||||
* [`rubygems-server`](#rubygems-server)
|
* [`rubygems-server`](#rubygems-server)
|
||||||
* [`terraform-registry`](#terraform-registry)
|
* [`terraform-registry`](#terraform-registry)
|
||||||
@@ -408,8 +408,6 @@ registries:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% ifversion dependabot-updates-pub-private-registry %}
|
|
||||||
|
|
||||||
### `pub-repository`
|
### `pub-repository`
|
||||||
|
|
||||||
The `pub-repository` type supports a URL and a token.
|
The `pub-repository` type supports a URL and a token.
|
||||||
@@ -433,8 +431,6 @@ updates:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
### `python-index`
|
### `python-index`
|
||||||
|
|
||||||
The `python-index` type supports username and password, or token. {% data reusables.dependabot.password-definition %}
|
The `python-index` type supports username and password, or token. {% data reusables.dependabot.password-definition %}
|
||||||
|
|||||||
@@ -372,9 +372,7 @@ Package manager | YAML value | Supported versions |
|
|||||||
| Bundler | `bundler` | {% ifversion ghes < 3.15 %}v1, {% endif %}v2 |
|
| Bundler | `bundler` | {% ifversion ghes < 3.15 %}v1, {% endif %}v2 |
|
||||||
| Cargo | `cargo` | v1 |
|
| Cargo | `cargo` | v1 |
|
||||||
| Composer | `composer` | {% ifversion dependabot-updates-composerv1-closing-down %}v2{% else %}v1, v2{% endif %} |
|
| Composer | `composer` | {% ifversion dependabot-updates-composerv1-closing-down %}v2{% else %}v1, v2{% endif %} |
|
||||||
| {% ifversion dependabot-version-updates-devcontainer-support %} |
|
|
||||||
| Dev containers | `devcontainers` | Not applicable |
|
| Dev containers | `devcontainers` | Not applicable |
|
||||||
| {% endif %} |
|
|
||||||
| Docker | `docker` | v1 |
|
| Docker | `docker` | v1 |
|
||||||
| {% ifversion dependabot-docker-compose-support %} |
|
| {% ifversion dependabot-docker-compose-support %} |
|
||||||
| Docker Compose | `docker-compose` | v2, v3 |
|
| Docker Compose | `docker-compose` | v2, v3 |
|
||||||
@@ -393,7 +391,7 @@ Package manager | YAML value | Supported versions |
|
|||||||
| Gradle | `gradle` | Not applicable |
|
| Gradle | `gradle` | Not applicable |
|
||||||
| Maven | `maven` | Not applicable |
|
| Maven | `maven` | Not applicable |
|
||||||
| npm | `npm` | v7, v8, v9 |
|
| npm | `npm` | v7, v8, v9 |
|
||||||
| NuGet | `nuget` | {% ifversion fpt or ghec or ghes > 3.14 %}<=6.12.0{% elsif ghes = 3.14 or ghes = 3.13 %}<= 6.8.0{% elsif ghes = 3.12 %}<= 6.7.0{% else %}<= 4.8{% endif %} |
|
| NuGet | `nuget` | {% ifversion fpt or ghec or ghes > 3.14 %}<=6.12.0{% elsif ghes = 3.14 or ghes = 3.13 %}<= 6.8.0 {% endif %} |
|
||||||
| pip| `pip` | v21.1.2 |
|
| pip| `pip` | v21.1.2 |
|
||||||
| pip-compile | `pip` | 6.1.0 |
|
| pip-compile | `pip` | 6.1.0 |
|
||||||
| pipenv | `pip` | <= 2021-05-29 |
|
| pipenv | `pip` | <= 2021-05-29 |
|
||||||
@@ -669,8 +667,8 @@ Specify authentication details that {% data variables.product.prodname_dependabo
|
|||||||
> * Gradle
|
> * Gradle
|
||||||
> * Maven
|
> * Maven
|
||||||
> * Npm
|
> * Npm
|
||||||
> * NuGet{% ifversion dependabot-updates-pub-private-registry %}
|
> * NuGet
|
||||||
> * Pub{% endif %}
|
> * Pub
|
||||||
> * Python
|
> * Python
|
||||||
> * Yarn
|
> * Yarn
|
||||||
|
|
||||||
|
|||||||
@@ -38,8 +38,8 @@ You'll find detailed guidance for the setup of the following package managers:
|
|||||||
* [Helm Charts](#helm-charts){% endif %}
|
* [Helm Charts](#helm-charts){% endif %}
|
||||||
* [Maven](#maven)
|
* [Maven](#maven)
|
||||||
* [npm](#npm)
|
* [npm](#npm)
|
||||||
* [NuGet](#nuget){% ifversion dependabot-updates-pub-private-registry %}
|
* [NuGet](#nuget)
|
||||||
* [pub](#pub){% endif %}
|
* [pub](#pub)
|
||||||
* [Python](#python)
|
* [Python](#python)
|
||||||
* [Yarn](#yarn)
|
* [Yarn](#yarn)
|
||||||
|
|
||||||
@@ -431,8 +431,6 @@ registries:
|
|||||||
|
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% ifversion dependabot-updates-pub-private-registry %}
|
|
||||||
|
|
||||||
### pub
|
### pub
|
||||||
|
|
||||||
You can define the private registry configuration in a `dependabot.yml` file using the `pub-repository` type. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#pub-repository).
|
You can define the private registry configuration in a `dependabot.yml` file using the `pub-repository` type. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#pub-repository).
|
||||||
@@ -464,8 +462,6 @@ pub supports URL and token authentication. The URL used for the registry should
|
|||||||
|
|
||||||
{% data variables.product.prodname_dependabot %} doesn't support overrides to the default package registry. For more information about overrides and why some users may implement them, see [Overriding the default package repository](https://dart.dev/tools/pub/custom-package-repositories#default-override) in the Dart documentation.
|
{% data variables.product.prodname_dependabot %} doesn't support overrides to the default package registry. For more information about overrides and why some users may implement them, see [Overriding the default package repository](https://dart.dev/tools/pub/custom-package-repositories#default-override) in the Dart documentation.
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
### Python
|
### Python
|
||||||
|
|
||||||
Supported by Artifactory, Azure Artifacts, Cloudsmith, Nexus, and ProGet. The {% data variables.product.prodname_registry %} registry is not supported.
|
Supported by Artifactory, Azure Artifacts, Cloudsmith, Nexus, and ProGet. The {% data variables.product.prodname_registry %} registry is not supported.
|
||||||
@@ -653,14 +649,6 @@ If you use the `replace-base` setting, you should also configure a remote reposi
|
|||||||
|
|
||||||
You can use a virtual registry to group together all private and public dependencies under a single domain. For more information, see [npm Registry](https://jfrog.com/help/r/jfrog-artifactory-documentation/npm-registry) in the JFrog Artifactory documentation.
|
You can use a virtual registry to group together all private and public dependencies under a single domain. For more information, see [npm Registry](https://jfrog.com/help/r/jfrog-artifactory-documentation/npm-registry) in the JFrog Artifactory documentation.
|
||||||
|
|
||||||
{% ifversion dependabot-updates-reference-private-registries %}{% else %}
|
|
||||||
|
|
||||||
#### Limitations and workarounds
|
|
||||||
|
|
||||||
The `target branch` setting does not work with {% data variables.product.prodname_dependabot_security_updates %}
|
|
||||||
on Artifactory. If you get a 401 authentication error, you need to remove the `target-branch` property from your `dependabot.yml` file. For more information, see [ARTIFACTORY: Why GitHub Dependabot security updates are failing with 401 Authentication error, when it initiates a connection with Artifactory npm private registry for security updates](https://jfrog.com/help/r/artifactory-why-github-dependabot-security-updates-are-failing-with-401-authentication-error-when-it-initiates-a-connection-with-artifactory-npm-private-registry-for-security-updates/issue-description) in the JFrog Artifactory documentation.
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
### Azure Artifacts
|
### Azure Artifacts
|
||||||
|
|
||||||
For information about Azure Artifacts and instructions on how to configure {% data variables.product.prodname_dependabot %} to work with Azure Artifacts, see [Azure DevOps](https://learn.microsoft.com/en-us/azure/devops/artifacts/?view=azure-devops) in the Azure Artifacts documentation, and [Use Dependabot in GitHub with Azure Artifacts](https://josh-ops.com/posts/github-dependabot-with-azure-artifacts/), respectively.
|
For information about Azure Artifacts and instructions on how to configure {% data variables.product.prodname_dependabot %} to work with Azure Artifacts, see [Azure DevOps](https://learn.microsoft.com/en-us/azure/devops/artifacts/?view=azure-devops) in the Azure Artifacts documentation, and [Use Dependabot in GitHub with Azure Artifacts](https://josh-ops.com/posts/github-dependabot-with-azure-artifacts/), respectively.
|
||||||
|
|||||||
@@ -110,9 +110,7 @@ When you have enabled a feature, you should communicate with repository administ
|
|||||||
|
|
||||||
You can use security overview to see which teams and repositories are affected by security alerts, with a breakdown of alerts by severity. For more information, see [AUTOTITLE](/code-security/security-overview/assessing-code-security-risk).
|
You can use security overview to see which teams and repositories are affected by security alerts, with a breakdown of alerts by severity. For more information, see [AUTOTITLE](/code-security/security-overview/assessing-code-security-risk).
|
||||||
|
|
||||||
{% ifversion security-overview-dashboard %}
|
|
||||||
Security overview also has a dashboard where you can explore high-level trends and metrics to gain insight into your organization's security landscape. For more information, see [AUTOTITLE](/code-security/security-overview/viewing-security-insights).
|
Security overview also has a dashboard where you can explore high-level trends and metrics to gain insight into your organization's security landscape. For more information, see [AUTOTITLE](/code-security/security-overview/viewing-security-insights).
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
You can use various tools to monitor the actions that your organization's members are taking in response to security alerts. For more information, see [AUTOTITLE](/code-security/getting-started/auditing-security-alerts).
|
You can use various tools to monitor the actions that your organization's members are taking in response to security alerts. For more information, see [AUTOTITLE](/code-security/getting-started/auditing-security-alerts).
|
||||||
|
|
||||||
|
|||||||
@@ -103,9 +103,7 @@ You can apply various filters to the alerts list to help you find the alerts you
|
|||||||
|`is:publicly-leaked`|Displays alerts for secrets that have been found in a public repository.|
|
|`is:publicly-leaked`|Displays alerts for secrets that have been found in a public repository.|
|
||||||
|`is:multi-repository`|Displays alerts for secrets that have been found in more than one repository within the same organization or enterprise.|
|
|`is:multi-repository`|Displays alerts for secrets that have been found in more than one repository within the same organization or enterprise.|
|
||||||
| {% endif %} |
|
| {% endif %} |
|
||||||
| {% ifversion secret-scanning-bypass-filter %} |
|
|
||||||
|`bypassed: true`|Displays alerts for secrets where push protection has been bypassed. For more information, see [AUTOTITLE](/code-security/secret-scanning/introduction/about-push-protection).|
|
|`bypassed: true`|Displays alerts for secrets where push protection has been bypassed. For more information, see [AUTOTITLE](/code-security/secret-scanning/introduction/about-push-protection).|
|
||||||
| {% endif %} |
|
|
||||||
|`validity:active`| Displays alerts for secrets that are known to be active. {% ifversion fpt or ghec %}Applies only to {% data variables.product.github %} tokens unless you enable validity checks.{% endif %}For more information about validity statuses, see [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/evaluating-alerts#checking-a-secrets-validity).|
|
|`validity:active`| Displays alerts for secrets that are known to be active. {% ifversion fpt or ghec %}Applies only to {% data variables.product.github %} tokens unless you enable validity checks.{% endif %}For more information about validity statuses, see [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/evaluating-alerts#checking-a-secrets-validity).|
|
||||||
|`validity:inactive`| Displays alerts for secrets that are no longer active.|
|
|`validity:inactive`| Displays alerts for secrets that are no longer active.|
|
||||||
|`validity:unknown`| Displays alerts for secrets where the validity status of the secret is unknown.|
|
|`validity:unknown`| Displays alerts for secrets where the validity status of the secret is unknown.|
|
||||||
|
|||||||
@@ -5,7 +5,9 @@ intro: 'You can enable {% data variables.product.prodname_secret_scanning %} to
|
|||||||
permissions: '{% data reusables.permissions.security-repo-enable %}'
|
permissions: '{% data reusables.permissions.security-repo-enable %}'
|
||||||
product: '{% data reusables.gated-features.secret-scanning-non-provider-patterns %}'
|
product: '{% data reusables.gated-features.secret-scanning-non-provider-patterns %}'
|
||||||
versions:
|
versions:
|
||||||
feature: secret-scanning-non-provider-patterns
|
fpt: '*'
|
||||||
|
ghec: '*'
|
||||||
|
ghes: '*'
|
||||||
type: how_to
|
type: how_to
|
||||||
topics:
|
topics:
|
||||||
- Secret scanning
|
- Secret scanning
|
||||||
|
|||||||
@@ -65,18 +65,17 @@ There are dedicated views for each type of security alert. You can limit your an
|
|||||||
|
|
||||||
## About security overview for organizations
|
## About security overview for organizations
|
||||||
|
|
||||||
The application security team at your company can use the different views for both broad and specific analyses of your organization's security status. For example, {% ifversion security-overview-dashboard %}the team can use the "Overview" dashboard view to track your organization's security landscape and progression{% else %}the team can use the "Coverage" view to monitor the adoption of features across your organization or by a specific team as you roll out {% data variables.product.prodname_GHAS %} features, or use the "Risk" view to identify repositories with more than five open {% data variables.secret-scanning.alerts %}{% endif %}. {% ifversion pre-security-configurations %}You can also use security overview to find a set of repositories and enable or disable security features for them all at the same time. For more information, see [AUTOTITLE](/code-security/security-overview/enabling-security-features-for-multiple-repositories).{% endif %}
|
The application security team at your company can use the different views for both broad and specific analyses of your organization's security status. For example, the team can use the "Overview" dashboard view to track your organization's security landscape and progression. {% ifversion pre-security-configurations %}You can also use security overview to find a set of repositories and enable or disable security features for them all at the same time. For more information, see [AUTOTITLE](/code-security/security-overview/enabling-security-features-for-multiple-repositories).{% endif %}
|
||||||
|
|
||||||
You can find security overview on the **Security** tab for any organization. Each view shows a summary of the data that you have access to. As you add filters, all data and metrics across the view change to reflect the repositories or alerts that you've selected. For information about permissions, see [Permission to view data in security overview](#permission-to-view-data-in-security-overview).
|
You can find security overview on the **Security** tab for any organization. Each view shows a summary of the data that you have access to. As you add filters, all data and metrics across the view change to reflect the repositories or alerts that you've selected. For information about permissions, see [Permission to view data in security overview](#permission-to-view-data-in-security-overview).
|
||||||
|
|
||||||
Security overview has multiple views that provide different ways to explore enablement and alert data.
|
Security overview has multiple views that provide different ways to explore enablement and alert data.
|
||||||
|
|
||||||
{% ifversion security-overview-dashboard %}
|
* **Overview:** visualize trends in **Detection**, **Remediation**, and **Prevention** of security alerts, see [AUTOTITLE](/code-security/security-overview/viewing-security-insights).
|
||||||
* **Overview:** visualize trends in **Detection**, **Remediation**, and **Prevention** of security alerts, see [AUTOTITLE](/code-security/security-overview/viewing-security-insights).{% endif %}
|
|
||||||
* **Risk and Alert views:** explore the risk from security alerts of all types or focus on a single alert type and identify your risk from specific vulnerable dependencies, code weaknesses, or leaked secrets, see [AUTOTITLE](/code-security/security-overview/assessing-code-security-risk).
|
* **Risk and Alert views:** explore the risk from security alerts of all types or focus on a single alert type and identify your risk from specific vulnerable dependencies, code weaknesses, or leaked secrets, see [AUTOTITLE](/code-security/security-overview/assessing-code-security-risk).
|
||||||
* **Coverage:** assess the adoption of security features across repositories in the organization, see [AUTOTITLE](/code-security/security-overview/assessing-adoption-code-security).{% ifversion ghas-products %}{% ifversion secret-risk-assessment %}
|
* **Coverage:** assess the adoption of security features across repositories in the organization, see [AUTOTITLE](/code-security/security-overview/assessing-adoption-code-security).{% ifversion ghas-products %}{% ifversion secret-risk-assessment %}
|
||||||
* **Assessments:** regardless of the enablement status of {% data variables.product.prodname_AS %} features, organizations on {% data variables.product.prodname_team %} and {% data variables.product.prodname_enterprise %} can run a free report to scan the code in the organization for leaked secrets, see [AUTOTITLE](/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/about-secret-risk-assessment).{% endif %}{% endif %}{% ifversion security-overview-tool-adoption %}
|
* **Assessments:** regardless of the enablement status of {% data variables.product.prodname_AS %} features, organizations on {% data variables.product.prodname_team %} and {% data variables.product.prodname_enterprise %} can run a free report to scan the code in the organization for leaked secrets, see [AUTOTITLE](/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/about-secret-risk-assessment).{% endif %}{% endif %}
|
||||||
* **Enablement trends:** see how quickly different teams are adopting security features.{% endif %}{% ifversion security-overview-org-codeql-pr-alerts %}
|
* **Enablement trends:** see how quickly different teams are adopting security features.{% ifversion security-overview-org-codeql-pr-alerts %}
|
||||||
* **CodeQL pull request alerts:** assess the impact of running CodeQL on pull requests and how development teams are resolving code scanning alerts, see [AUTOTITLE](/code-security/security-overview/viewing-metrics-for-pull-request-alerts).{% endif %}
|
* **CodeQL pull request alerts:** assess the impact of running CodeQL on pull requests and how development teams are resolving code scanning alerts, see [AUTOTITLE](/code-security/security-overview/viewing-metrics-for-pull-request-alerts).{% endif %}
|
||||||
* **Secret scanning:** find out which types of secret are blocked by push protection{% ifversion security-overview-delegated-bypass-requests %} and which teams are bypassing push protection{% endif %}, see [AUTOTITLE](/code-security/security-overview/viewing-metrics-for-secret-scanning-push-protection){% ifversion security-overview-delegated-bypass-requests %} and [AUTOTITLE](/code-security/security-overview/reviewing-requests-to-bypass-push-protection){% endif %}.
|
* **Secret scanning:** find out which types of secret are blocked by push protection{% ifversion security-overview-delegated-bypass-requests %} and which teams are bypassing push protection{% endif %}, see [AUTOTITLE](/code-security/security-overview/viewing-metrics-for-secret-scanning-push-protection){% ifversion security-overview-delegated-bypass-requests %} and [AUTOTITLE](/code-security/security-overview/reviewing-requests-to-bypass-push-protection){% endif %}.
|
||||||
|
|
||||||
@@ -106,7 +105,6 @@ If you are an **organization or team member**, you can view security overview fo
|
|||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% ifversion security-overview-dashboard %}
|
|
||||||
{% rowheaders %}
|
{% rowheaders %}
|
||||||
|
|
||||||
| Organization or team member with | Overview dashboard view | Risk and alerts views | Coverage view |
|
| Organization or team member with | Overview dashboard view | Risk and alerts views | Coverage view |
|
||||||
@@ -118,19 +116,6 @@ If you are an **organization or team member**, you can view security overview fo
|
|||||||
| Custom organization role with permission to view one or more types of security alert | View allowed alert data for all repositories | View allowed alert data for all repositories in all views | No access |
|
| Custom organization role with permission to view one or more types of security alert | View allowed alert data for all repositories | View allowed alert data for all repositories in all views | No access |
|
||||||
|
|
||||||
{% endrowheaders %}
|
{% endrowheaders %}
|
||||||
{% else %}
|
|
||||||
{% rowheaders %}
|
|
||||||
|
|
||||||
| Organization or team member with | Risk and alerts views | Coverage view |
|
|
||||||
|--------------------|-------------|---------------------|
|
|
||||||
| `admin` access for one or more repositories | View data for those repositories | View data for those repositories, and enable and disable security features |
|
|
||||||
| `write` access for one or more repositories | View {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_dependabot %} data for those repositories | No access |
|
|
||||||
| `read` or `triage` access for one or more repositories | No access | No access |
|
|
||||||
| Security alert access for one or more repositories | View all security alert data for those repositories | No access |
|
|
||||||
| Custom organization role with permission to view one or more types of security alert | View allowed alert data for all repositories in all views | No access |
|
|
||||||
|
|
||||||
{% endrowheaders %}
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
> To ensure a consistent and responsive experience, for organization members, the organization-level security overview pages will only display results from the most recently updated 3,000 repositories. If your results have been restricted, a notification will appear at the top of the page. Organization owners and security managers will see results from all repositories.
|
> To ensure a consistent and responsive experience, for organization members, the organization-level security overview pages will only display results from the most recently updated 3,000 repositories. If your results have been restricted, a notification will appear at the top of the page. Organization owners and security managers will see results from all repositories.
|
||||||
|
|||||||
@@ -36,12 +36,8 @@ You can use security overview to see which repositories and teams have already e
|
|||||||
You can download a CSV file of the data displayed on the "Security coverage" page. This data file can be used for efforts like security research and in-depth data analysis, and can integrate easily with external datasets. For more information, see [AUTOTITLE](/code-security/security-overview/exporting-data-from-security-overview).
|
You can download a CSV file of the data displayed on the "Security coverage" page. This data file can be used for efforts like security research and in-depth data analysis, and can integrate easily with external datasets. For more information, see [AUTOTITLE](/code-security/security-overview/exporting-data-from-security-overview).
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% ifversion security-overview-tool-adoption %}
|
|
||||||
|
|
||||||
You can use the "Enablement trends" view to see enablement status and enablement status trends over time for {% data variables.product.prodname_dependabot %}, {% data variables.product.prodname_code_scanning %}, or {% data variables.product.prodname_secret_scanning %} for repositories in an organization{% ifversion security-overview-enterprise-enablement-report %}, or across organizations in an enterprise{% endif %}. For each of these features, you can view a graph visualizing the percentage of repositories that have the feature enabled, as well as a detailed table with enablement percentages for different points in time. For more information, see [Viewing enablement trends for an organization](#viewing-enablement-trends-for-an-organization){% ifversion security-overview-enterprise-enablement-report %} and [Viewing enablement trends for an enterprise](#viewing-enablement-trends-for-an-enterprise){% endif %}.
|
You can use the "Enablement trends" view to see enablement status and enablement status trends over time for {% data variables.product.prodname_dependabot %}, {% data variables.product.prodname_code_scanning %}, or {% data variables.product.prodname_secret_scanning %} for repositories in an organization{% ifversion security-overview-enterprise-enablement-report %}, or across organizations in an enterprise{% endif %}. For each of these features, you can view a graph visualizing the percentage of repositories that have the feature enabled, as well as a detailed table with enablement percentages for different points in time. For more information, see [Viewing enablement trends for an organization](#viewing-enablement-trends-for-an-organization){% ifversion security-overview-enterprise-enablement-report %} and [Viewing enablement trends for an enterprise](#viewing-enablement-trends-for-an-enterprise){% endif %}.
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## Viewing the enablement of security features for an organization
|
## Viewing the enablement of security features for an organization
|
||||||
|
|
||||||
You can view data to assess the enablement of features for secure coding across repositories in an organization.
|
You can view data to assess the enablement of features for secure coding across repositories in an organization.
|
||||||
@@ -78,8 +74,6 @@ In the enterprise-level view, you can view data about the enablement of features
|
|||||||
|
|
||||||
{% data reusables.security-overview.enterprise-filters-tip %}
|
{% data reusables.security-overview.enterprise-filters-tip %}
|
||||||
|
|
||||||
{% ifversion security-overview-tool-adoption %}
|
|
||||||
|
|
||||||
## Viewing enablement trends for an organization
|
## Viewing enablement trends for an organization
|
||||||
|
|
||||||
{% ifversion ghes < 3.15 %}
|
{% ifversion ghes < 3.15 %}
|
||||||
@@ -100,8 +94,6 @@ You can view data to assess the enablement status and enablement status trends o
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
{% ifversion security-overview-enterprise-enablement-report %}
|
{% ifversion security-overview-enterprise-enablement-report %}
|
||||||
|
|
||||||
## Viewing enablement trends for an enterprise
|
## Viewing enablement trends for an enterprise
|
||||||
@@ -130,6 +122,6 @@ You can view data to assess the enablement status and enablement status trends o
|
|||||||
|
|
||||||
Some security features can and should be enabled on all repositories. For example, {% data variables.secret-scanning.alerts %} and push protection reduce the risk of a security leak no matter what information is stored in the repository. If you see repositories that don't already use these features, you should either enable them or discuss an enablement plan with the team who owns the repository. For information on enabling features for a whole organization, see {% ifversion security-configurations %}[AUTOTITLE](/code-security/securing-your-organization/enabling-security-features-in-your-organization){% else %}[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization){% endif %}.
|
Some security features can and should be enabled on all repositories. For example, {% data variables.secret-scanning.alerts %} and push protection reduce the risk of a security leak no matter what information is stored in the repository. If you see repositories that don't already use these features, you should either enable them or discuss an enablement plan with the team who owns the repository. For information on enabling features for a whole organization, see {% ifversion security-configurations %}[AUTOTITLE](/code-security/securing-your-organization/enabling-security-features-in-your-organization){% else %}[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization){% endif %}.
|
||||||
|
|
||||||
Other features are not suitable for use in all repositories. For example, there would be no point in enabling {% data variables.product.prodname_dependabot %}{% ifversion default-setup-pre-enablement %}{% else %} or {% data variables.product.prodname_code_scanning %}{% endif %} for repositories that only use ecosystems or languages that are unsupported. As such, it's normal to have some repositories where these features are not enabled.
|
Other features are not suitable for use in all repositories. For example, there would be no point in enabling {% data variables.product.prodname_dependabot %} for repositories that only use ecosystems or languages that are unsupported. As such, it's normal to have some repositories where these features are not enabled.
|
||||||
|
|
||||||
Your enterprise may also have configured policies to limit the use of some security features. For more information, see [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise).
|
Your enterprise may also have configured policies to limit the use of some security features. For more information, see [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise).
|
||||||
|
|||||||
@@ -38,8 +38,7 @@ These views provide you with the data and filters to:
|
|||||||
* Understand how your organization is affected by secret leaks and exposures.{% endif %}{% ifversion security-overview-export-data %}
|
* Understand how your organization is affected by secret leaks and exposures.{% endif %}{% ifversion security-overview-export-data %}
|
||||||
* Export your current selection of data for further analysis and reporting. {% endif %}
|
* Export your current selection of data for further analysis and reporting. {% endif %}
|
||||||
|
|
||||||
{% ifversion security-overview-dashboard %}
|
For information about the **Overview**, see [AUTOTITLE](/code-security/security-overview/viewing-security-insights).
|
||||||
For information about the **Overview**, see [AUTOTITLE](/code-security/security-overview/viewing-security-insights).{% endif %}
|
|
||||||
|
|
||||||
## Viewing organization-level security risks in code
|
## Viewing organization-level security risks in code
|
||||||
|
|
||||||
|
|||||||
@@ -24,8 +24,8 @@ You can use checkboxes to select which repositories you want to include, or use
|
|||||||
|
|
||||||
* To exclude certain repositories from the selection, you can assign a topic such as `test` to these repositories, then exclude them from the results with a search like `-topic:test`. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics).
|
* To exclude certain repositories from the selection, you can assign a topic such as `test` to these repositories, then exclude them from the results with a search like `-topic:test`. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics).
|
||||||
* If a team uses repositories that all require a certain feature, you can use the `team:` filter to search for repositories where a team has write access.
|
* If a team uses repositories that all require a certain feature, you can use the `team:` filter to search for repositories where a team has write access.
|
||||||
* If you're enabling {% data variables.product.prodname_code_scanning %}, you can see which repositories are eligible for default setup with the search `code-scanning-default-setup:eligible`. For more information, see [AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-at-scale).{% ifversion security-overview-repository-properties %}
|
* If you're enabling {% data variables.product.prodname_code_scanning %}, you can see which repositories are eligible for default setup with the search `code-scanning-default-setup:eligible`. For more information, see [AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-at-scale).
|
||||||
* You can use custom repository properties to filter security overview to show results from specific groups of repositories. Custom properties are metadata that organization owners can add and set for repositories in an organization. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization).{% endif %}
|
* You can use custom repository properties to filter security overview to show results from specific groups of repositories. Custom properties are metadata that organization owners can add and set for repositories in an organization. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization).
|
||||||
|
|
||||||
For more information on filters you can use in different parts of security overview, see [AUTOTITLE](/code-security/security-overview/filtering-alerts-in-security-overview).
|
For more information on filters you can use in different parts of security overview, see [AUTOTITLE](/code-security/security-overview/filtering-alerts-in-security-overview).
|
||||||
|
|
||||||
|
|||||||
@@ -42,8 +42,8 @@ Currently, there are two logical operators that you can apply to your filters on
|
|||||||
All security views have features to help you define filters. These provide an easy way to set up filters and understand the options available.
|
All security views have features to help you define filters. These provide an easy way to set up filters and understand the options available.
|
||||||
|
|
||||||
* **Interactive search text box.** When you click in the search box and press the keyboard "Space" key, a pop-up text box shows the filter options available in that view. You can use the mouse or keyboard arrow keys to select the options you want in the text box before pressing the keyboard "Return" key to add the filter. Supported for all views.
|
* **Interactive search text box.** When you click in the search box and press the keyboard "Space" key, a pop-up text box shows the filter options available in that view. You can use the mouse or keyboard arrow keys to select the options you want in the text box before pressing the keyboard "Return" key to add the filter. Supported for all views.
|
||||||
* **Dropdown selectors and toggles.** Shown at the end of the "Search text box" or in the header of the data table. As you choose the data to view, the filters shown in the search text box are updated accordingly. Supported on the alert views.{% ifversion security-overview-3-13-overview %}
|
* **Dropdown selectors and toggles.** Shown at the end of the "Search text box" or in the header of the data table. As you choose the data to view, the filters shown in the search text box are updated accordingly. Supported on the alert views.
|
||||||
* **Advanced filters dialog.** When you click the **{% octicon "filter" aria-hidden="true" %} Filter** button, you can use dropdown lists to select the "Qualifier", "Operator", and "Values" for each filter. Supported on the "Overview" and metric views.{% endif %}
|
* **Advanced filters dialog.** When you click the **{% octicon "filter" aria-hidden="true" %} Filter** button, you can use dropdown lists to select the "Qualifier", "Operator", and "Values" for each filter. Supported on the "Overview" and metric views.
|
||||||
|
|
||||||
## Repository name, visibility, and status filters
|
## Repository name, visibility, and status filters
|
||||||
|
|
||||||
@@ -56,9 +56,7 @@ You can also filter by repository visibility (internal, private, or public) and
|
|||||||
|
|
||||||
| Qualifier | Description | Views |
|
| Qualifier | Description | Views |
|
||||||
|--------|--------|------|
|
|--------|--------|------|
|
||||||
| {% ifversion security-overview-dashboard %} |
|
|
||||||
| `visibility` | Display data for all repositories that are `public`, `private`, or `internal`. | "Overview" and metrics |
|
| `visibility` | Display data for all repositories that are `public`, `private`, or `internal`. | "Overview" and metrics |
|
||||||
| {% endif %} |
|
|
||||||
| `is` | Display data for all repositories that are `public`, `private`, or `internal`. | "Risk" and "Coverage" |
|
| `is` | Display data for all repositories that are `public`, `private`, or `internal`. | "Risk" and "Coverage" |
|
||||||
| `archived` | Display only data for archived (`true`) or active (`false`) repositories. | All except "Alerts" views |
|
| `archived` | Display only data for archived (`true`) or active (`false`) repositories. | All except "Alerts" views |
|
||||||
|
|
||||||
@@ -71,8 +69,6 @@ These qualifiers are available in all views.
|
|||||||
| `team` | Display data for all repositories that the specified team has write access or admin access to. For more information on repository roles, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization). |
|
| `team` | Display data for all repositories that the specified team has write access or admin access to. For more information on repository roles, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization). |
|
||||||
| `topic` | Display data for all repositories that are classified with a specific topic. For more information on repository topics, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics). |
|
| `topic` | Display data for all repositories that are classified with a specific topic. For more information on repository topics, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics). |
|
||||||
|
|
||||||
{% ifversion security-overview-repository-properties %}
|
|
||||||
|
|
||||||
## Custom repository property filters
|
## Custom repository property filters
|
||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
@@ -84,8 +80,6 @@ If you add custom properties to your organization and set values for repositorie
|
|||||||
|
|
||||||
* **`props.CUSTOM_PROPERTY_NAME` qualifier.** The qualifier consists of a `props.` prefix, followed by the name of the custom property. For example, `props.data_sensitivity:high` displays results for repositories with the `data_sensitivity` property set to the value `high`. |
|
* **`props.CUSTOM_PROPERTY_NAME` qualifier.** The qualifier consists of a `props.` prefix, followed by the name of the custom property. For example, `props.data_sensitivity:high` displays results for repositories with the `data_sensitivity` property set to the value `high`. |
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
{% ifversion security-overview-dashboard-enterprise %}
|
{% ifversion security-overview-dashboard-enterprise %}
|
||||||
|
|
||||||
## Repository owner name and type filters
|
## Repository owner name and type filters
|
||||||
@@ -139,8 +133,6 @@ In the "Risk" view, you can filter repositories by the number of alerts they hav
|
|||||||
| `dependabot-alerts` | Display data for repositories that have a specific number (`=`), more than (`>`) or fewer than (`<`) a specific number of {% data variables.product.prodname_dependabot_alerts %}. For example: `dependabot-alerts:<=10` for repositories with fewer than or equal to 10 alerts.|
|
| `dependabot-alerts` | Display data for repositories that have a specific number (`=`), more than (`>`) or fewer than (`<`) a specific number of {% data variables.product.prodname_dependabot_alerts %}. For example: `dependabot-alerts:<=10` for repositories with fewer than or equal to 10 alerts.|
|
||||||
| `secret-scanning-alerts` | Display data for repositories that have a specific number (`=`), more than (`>`) or fewer than (`<`) a specific number of {% data variables.secret-scanning.alerts %}. For example: `secret-scanning-alerts:=10` for repositories with exactly 10 alerts.|
|
| `secret-scanning-alerts` | Display data for repositories that have a specific number (`=`), more than (`>`) or fewer than (`<`) a specific number of {% data variables.secret-scanning.alerts %}. For example: `secret-scanning-alerts:=10` for repositories with exactly 10 alerts.|
|
||||||
|
|
||||||
{% ifversion security-overview-dashboard %}
|
|
||||||
|
|
||||||
## Alert type and property filters
|
## Alert type and property filters
|
||||||
|
|
||||||
You can filter the "Overview" view by the type{% ifversion security-overview-3-14-overview %} and property{% endif %} of alerts. Use the `tool` qualifier to display only data for alerts generated by a specific tool{% ifversion security-overview-3-14-overview %} or type of tool{% endif %}.
|
You can filter the "Overview" view by the type{% ifversion security-overview-3-14-overview %} and property{% endif %} of alerts. Use the `tool` qualifier to display only data for alerts generated by a specific tool{% ifversion security-overview-3-14-overview %} or type of tool{% endif %}.
|
||||||
@@ -170,8 +162,6 @@ You can also filter the "Overview" view by properties of alerts.
|
|||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## {% data variables.product.prodname_dependabot %} alert view filters
|
## {% data variables.product.prodname_dependabot %} alert view filters
|
||||||
|
|
||||||
You can filter the view to show {% data variables.product.prodname_dependabot_alerts %} that are ready to fix or where additional information about exposure is available. You can click any result to see full details of the alert.
|
You can filter the view to show {% data variables.product.prodname_dependabot_alerts %} that are ready to fix or where additional information about exposure is available. You can click any result to see full details of the alert.
|
||||||
|
|||||||
@@ -34,7 +34,7 @@ You can also find more granular metrics, such as:
|
|||||||
* The repositories that are bypassing push protection the most
|
* The repositories that are bypassing push protection the most
|
||||||
* The percentage distribution of reasons that users give when they bypass the protection
|
* The percentage distribution of reasons that users give when they bypass the protection
|
||||||
|
|
||||||
{% ifversion security-overview-additional-tools %}Use the date picker to set the time range that you want to view alert activity and metrics for, and click in the search box to add further filters on the alerts and metrics displayed. For more information, see [AUTOTITLE](/code-security/security-overview/filtering-alerts-in-security-overview#additional-filters-for-secret-scanning-alert-views).
|
Use the date picker to set the time range that you want to view alert activity and metrics for, and click in the search box to add further filters on the alerts and metrics displayed. For more information, see [AUTOTITLE](/code-security/security-overview/filtering-alerts-in-security-overview#additional-filters-for-secret-scanning-alert-views).
|
||||||
|
|
||||||
You can see {% data variables.product.prodname_secret_scanning %} metrics if you have:
|
You can see {% data variables.product.prodname_secret_scanning %} metrics if you have:
|
||||||
|
|
||||||
@@ -44,12 +44,6 @@ You can see {% data variables.product.prodname_secret_scanning %} metrics if you
|
|||||||
|
|
||||||
The metrics are based on activity from the default period or your selected period.
|
The metrics are based on activity from the default period or your selected period.
|
||||||
|
|
||||||
{% else %}
|
|
||||||
|
|
||||||
The metrics are based on activity from the default period or your selected period.
|
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## Viewing metrics for {% data variables.product.prodname_secret_scanning %} push protection for an organization
|
## Viewing metrics for {% data variables.product.prodname_secret_scanning %} push protection for an organization
|
||||||
|
|
||||||
{% data reusables.organizations.navigate-to-org %}
|
{% data reusables.organizations.navigate-to-org %}
|
||||||
|
|||||||
@@ -5,7 +5,9 @@ intro: 'You can use the overview dashboard in security overview to monitor the s
|
|||||||
permissions: '{% data reusables.permissions.security-overview %}'
|
permissions: '{% data reusables.permissions.security-overview %}'
|
||||||
product: '{% data reusables.gated-features.security-overview-fpt-both %}'
|
product: '{% data reusables.gated-features.security-overview-fpt-both %}'
|
||||||
versions:
|
versions:
|
||||||
feature: security-overview-dashboard
|
fpt: '*'
|
||||||
|
ghec: '*'
|
||||||
|
ghes: '*'
|
||||||
type: how_to
|
type: how_to
|
||||||
topics:
|
topics:
|
||||||
- Security overview
|
- Security overview
|
||||||
@@ -237,7 +239,7 @@ Some metrics in the security overview dashboard include a trend indicator, which
|
|||||||
|
|
||||||
### Alert trends graph
|
### Alert trends graph
|
||||||
|
|
||||||
The alert trends graph shows the change in the number of alerts in your organization{% ifversion security-overview-dashboard-enterprise %} or enterprise{% endif %} over the time period you have chosen. {% ifversion security-overview-3-13-overview %}By default, alerts{% else %}Alerts{% endif %} are grouped by severity. You can toggle the graph between open and closed alerts{% ifversion security-overview-3-13-overview %} and change the way alerts are grouped{% endif %}.
|
The alert trends graph shows the change in the number of alerts in your organization{% ifversion security-overview-dashboard-enterprise %} or enterprise{% endif %} over the time period you have chosen. By default, alerts are grouped by severity. You can toggle the graph between open and closed alerts and change the way alerts are grouped.
|
||||||
|
|
||||||
Open alerts include both newly created and existing open security alerts. New alerts are represented on their creation date, while alerts that existed before the chosen time period are represented at the start of the period. Once an alert is remediated or dismissed, it is not included in the graph. Instead, the alert will move to the closed alerts graph.
|
Open alerts include both newly created and existing open security alerts. New alerts are represented on their creation date, while alerts that existed before the chosen time period are represented at the start of the period. Once an alert is remediated or dismissed, it is not included in the graph. Instead, the alert will move to the closed alerts graph.
|
||||||
|
|
||||||
|
|||||||
@@ -5,11 +5,11 @@ intro: '{% data variables.product.prodname_discussions %} is a collaborative com
|
|||||||
introLinks:
|
introLinks:
|
||||||
quickstart: /discussions/quickstart
|
quickstart: /discussions/quickstart
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /enterprise-cloud@latest/organizations/collaborating-with-your-team/about-team-discussions
|
- /organizations/collaborating-with-your-team/about-team-discussions
|
||||||
- /enterprise-cloud@latest/organizations/collaborating-with-your-team/creating-a-team-discussion
|
- /organizations/collaborating-with-your-team/creating-a-team-discussion
|
||||||
- /enterprise-cloud@latest/organizations/collaborating-with-your-team/editing-or-deleting-a-team-discussion
|
- /organizations/collaborating-with-your-team/editing-or-deleting-a-team-discussion
|
||||||
- /enterprise-cloud@latest/organizations/collaborating-with-your-team/pinning-a-team-discussion
|
- /organizations/collaborating-with-your-team/pinning-a-team-discussion
|
||||||
- /enterprise-cloud@latest/organizations/collaborating-with-your-team
|
- /organizations/collaborating-with-your-team
|
||||||
featuredLinks:
|
featuredLinks:
|
||||||
startHere:
|
startHere:
|
||||||
- /discussions/collaborating-with-your-community-using-discussions/about-discussions
|
- /discussions/collaborating-with-your-community-using-discussions/about-discussions
|
||||||
|
|||||||
@@ -22,10 +22,10 @@ To set up a trial, you must be signed in to a personal account. If you don't hav
|
|||||||
|
|
||||||
The trial lasts for **{% data reusables.enterprise.ghec-trial-length %} days** and includes the following features.
|
The trial lasts for **{% data reusables.enterprise.ghec-trial-length %} days** and includes the following features.
|
||||||
|
|
||||||
* Access to **most** {% data variables.product.prodname_ghe_cloud %} features.{% ifversion metered-ghe-ghas %}
|
* Access to **most** {% data variables.product.prodname_ghe_cloud %} features.
|
||||||
* {% data variables.product.prodname_copilot_for_business %}
|
* {% data variables.product.prodname_copilot_for_business %}
|
||||||
* {% data variables.product.prodname_GH_cs_and_sp %}
|
* {% data variables.product.prodname_GH_cs_and_sp %}
|
||||||
* Access to the **new billing platform**. See [AUTOTITLE](/billing/managing-your-billing/about-the-new-billing-platform).{% endif %}
|
* Access to the **new billing platform**. See [AUTOTITLE](/billing/using-the-new-billing-platform/about-the-new-billing-platform-for-enterprises).
|
||||||
* An **enterprise account**, which allows you to manage multiple organizations. See [AUTOTITLE](/enterprise-cloud@latest/get-started/learning-about-github/types-of-github-accounts).
|
* An **enterprise account**, which allows you to manage multiple organizations. See [AUTOTITLE](/enterprise-cloud@latest/get-started/learning-about-github/types-of-github-accounts).
|
||||||
* Up to **50 licenses** to grant access to users.
|
* Up to **50 licenses** to grant access to users.
|
||||||
|
|
||||||
|
|||||||
@@ -90,8 +90,6 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
|
|||||||
|<kbd>a</kbd> | Show or hide annotations on diffs |
|
|<kbd>a</kbd> | Show or hide annotations on diffs |
|
||||||
|<kbd>b</kbd> | Open blame view. For more information, see [AUTOTITLE](/repositories/working-with-files/using-files/viewing-a-file). |
|
|<kbd>b</kbd> | Open blame view. For more information, see [AUTOTITLE](/repositories/working-with-files/using-files/viewing-a-file). |
|
||||||
|
|
||||||
{% ifversion code-view-ui %}
|
|
||||||
|
|
||||||
## Navigating within code files
|
## Navigating within code files
|
||||||
|
|
||||||
If you view a code file in a repository using the **Code** view and click on any line in the file, you will see a cursor. You can then navigate within the content of the file, also known as a blob (binary large object), using keyboard shortcuts.
|
If you view a code file in a repository using the **Code** view and click on any line in the file, you will see a cursor. You can then navigate within the content of the file, also known as a blob (binary large object), using keyboard shortcuts.
|
||||||
@@ -104,8 +102,6 @@ If you view a code file in a repository using the **Code** view and click on any
|
|||||||
|<kbd>Command</kbd>+<kbd>Enter</kbd> (Mac) or </br> <kbd>Control</kbd>+<kbd>Enter</kbd> (Windows/Linux) | Highlights the code symbol currently selected by the cursor and all other occurrences of the symbol in the code, and shows the symbol in the symbols pane
|
|<kbd>Command</kbd>+<kbd>Enter</kbd> (Mac) or </br> <kbd>Control</kbd>+<kbd>Enter</kbd> (Windows/Linux) | Highlights the code symbol currently selected by the cursor and all other occurrences of the symbol in the code, and shows the symbol in the symbols pane
|
||||||
| {% endif %} |
|
| {% endif %} |
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## Comments
|
## Comments
|
||||||
|
|
||||||
| Keyboard shortcut | Description |
|
| Keyboard shortcut | Description |
|
||||||
|
|||||||
@@ -77,14 +77,3 @@ When you `git clone`, `git fetch`, `git pull`, or `git push` to a remote reposit
|
|||||||
## Cloning with {% data variables.product.prodname_cli %}
|
## Cloning with {% data variables.product.prodname_cli %}
|
||||||
|
|
||||||
You can also install {% data variables.product.prodname_cli %} to use {% data variables.product.github %} workflows in your terminal. For more information, see [AUTOTITLE](/github-cli/github-cli/about-github-cli).
|
You can also install {% data variables.product.prodname_cli %} to use {% data variables.product.github %} workflows in your terminal. For more information, see [AUTOTITLE](/github-cli/github-cli/about-github-cli).
|
||||||
|
|
||||||
{% ifversion ghes < 3.13 %}
|
|
||||||
|
|
||||||
## Cloning with Subversion
|
|
||||||
|
|
||||||
{% data reusables.subversion.sunset %}
|
|
||||||
|
|
||||||
You can also use a [Subversion](https://subversion.apache.org/) client to access any repository on {% data variables.product.github %}. Subversion offers a different feature set than Git. For more information, see [AUTOTITLE](/get-started/working-with-subversion-on-github/what-are-the-differences-between-subversion-and-git)
|
|
||||||
|
|
||||||
You can also access repositories on {% data variables.product.github %} from Subversion clients. For more information, see [AUTOTITLE](/get-started/working-with-subversion-on-github/support-for-subversion-clients).
|
|
||||||
{% endif %}
|
|
||||||
|
|||||||
@@ -16,6 +16,10 @@ redirect_from:
|
|||||||
- /categories/using-git
|
- /categories/using-git
|
||||||
- /github/using-git
|
- /github/using-git
|
||||||
- /github/getting-started-with-github
|
- /github/getting-started-with-github
|
||||||
|
- /get-started/working-with-subversion-on-github
|
||||||
|
- /get-started/working-with-subversion-on-github/subversion-properties-supported-by-github
|
||||||
|
- /get-started/working-with-subversion-on-github/support-for-subversion-clients
|
||||||
|
- /get-started/working-with-subversion-on-github/what-are-the-differences-between-subversion-and-git
|
||||||
versions:
|
versions:
|
||||||
fpt: '*'
|
fpt: '*'
|
||||||
ghes: '*'
|
ghes: '*'
|
||||||
@@ -59,7 +63,6 @@ children:
|
|||||||
- /exploring-projects-on-github
|
- /exploring-projects-on-github
|
||||||
- /git-basics
|
- /git-basics
|
||||||
- /using-git
|
- /using-git
|
||||||
- /working-with-subversion-on-github
|
|
||||||
- /exploring-integrations
|
- /exploring-integrations
|
||||||
- /archiving-your-github-personal-account-and-public-repositories
|
- /archiving-your-github-personal-account-and-public-repositories
|
||||||
- /using-github-docs
|
- /using-github-docs
|
||||||
|
|||||||
@@ -72,8 +72,7 @@ In addition to the features available with {% data variables.product.prodname_fr
|
|||||||
With {% data variables.product.prodname_free_team %} for organizations, you can work with unlimited collaborators on unlimited public repositories with a full feature set, or unlimited private repositories with a limited feature set.
|
With {% data variables.product.prodname_free_team %} for organizations, you can work with unlimited collaborators on unlimited public repositories with a full feature set, or unlimited private repositories with a limited feature set.
|
||||||
|
|
||||||
In addition to the features available with {% data variables.product.prodname_free_user %} for personal accounts, {% data variables.product.prodname_free_team %} for organizations includes:
|
In addition to the features available with {% data variables.product.prodname_free_user %} for personal accounts, {% data variables.product.prodname_free_team %} for organizations includes:
|
||||||
* {% data variables.product.prodname_gcf %}{% ifversion team-discussions %}
|
* {% data variables.product.prodname_gcf %}
|
||||||
* Team discussions{% endif %}
|
|
||||||
* Team access controls for managing groups
|
* Team access controls for managing groups
|
||||||
* 2,000 {% data variables.product.prodname_actions %} minutes per month
|
* 2,000 {% data variables.product.prodname_actions %} minutes per month
|
||||||
|
|
||||||
|
|||||||
@@ -88,7 +88,7 @@ You can make and save changes to the files in your repository. On {% data variab
|
|||||||
1. Under the `readme-edits` branch you created, click the `README.md` file.
|
1. Under the `readme-edits` branch you created, click the `README.md` file.
|
||||||
1. To edit the file, click {% octicon "pencil" aria-label="Edit file" %}.
|
1. To edit the file, click {% octicon "pencil" aria-label="Edit file" %}.
|
||||||
1. In the editor, write a bit about yourself.
|
1. In the editor, write a bit about yourself.
|
||||||
{% ifversion code-view-ui %}1. Click **Commit changes**.{% endif %}
|
1. Click **Commit changes**.
|
||||||
1. In the "Commit changes" box, write a commit message that describes your changes.
|
1. In the "Commit changes" box, write a commit message that describes your changes.
|
||||||
1. Click **Commit changes**.
|
1. Click **Commit changes**.
|
||||||
|
|
||||||
|
|||||||
@@ -22,11 +22,7 @@ topics:
|
|||||||
|
|
||||||
{% data variables.product.github %} 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.
|
{% data variables.product.github %} 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 team-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.
|
|
||||||
{% else %}
|
|
||||||
You can create and participate in issues, pull requests, and team discussions, depending on the type of conversation you'd like to have.
|
You can create and participate in issues, pull requests, and team discussions, depending on the type of conversation you'd like to have.
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
{% ifversion copilot %}
|
{% ifversion copilot %}
|
||||||
|
|
||||||
@@ -57,17 +53,6 @@ You can create and participate in issues, pull requests, and team discussions, d
|
|||||||
* Often do not result in an actionable task
|
* Often do not result in an actionable task
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% ifversion team-discussions %}
|
|
||||||
|
|
||||||
### Team discussions
|
|
||||||
|
|
||||||
* Can be started on your team's page for conversations that span across projects and don't belong in a specific issue or pull request. Instead of opening an issue in a repository to discuss an idea, you can include the entire team by having a conversation in a team discussion.
|
|
||||||
* Allow you to hold discussions with your team about planning, analysis, design, user research and general project decision making in one place.{% ifversion ghes %}
|
|
||||||
* Provide a collaborative experience outside the codebase, allowing the brainstorming of ideas.
|
|
||||||
* Often don’t have a clear owner.
|
|
||||||
* Often do not result in an actionable task.{% endif %}
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## Which discussion tool should I use?
|
## Which discussion tool should I use?
|
||||||
|
|
||||||
### Scenarios for issues
|
### Scenarios for issues
|
||||||
@@ -126,27 +111,6 @@ This example shows the {% data variables.product.prodname_discussions %} welcome
|
|||||||
|
|
||||||
This community maintainer started a discussion to welcome the community, and to ask members to introduce themselves. This post fosters an inviting atmosphere for visitors and contributors. The post also clarifies that the team's happy to help with contributions to the repository.
|
This community maintainer started a discussion to welcome the community, and to ask members to introduce themselves. This post fosters an inviting atmosphere for visitors and contributors. The post also clarifies that the team's happy to help with contributions to the repository.
|
||||||
|
|
||||||
{% ifversion team-discussions %}
|
|
||||||
|
|
||||||
### Scenarios for team discussions
|
|
||||||
|
|
||||||
* I have a question that's not necessarily related to specific files in the repository.
|
|
||||||
* I want to share news with my collaborators, or my team.
|
|
||||||
* I want to start or participate in an open-ended conversation.
|
|
||||||
* I want to make an announcement to my team.
|
|
||||||
|
|
||||||
#### Team discussion example
|
|
||||||
|
|
||||||
This example shows a team post for the `octo-team` team.
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
The `octocat` team member posted a team discussion, informing the team of various things:
|
|
||||||
* A team member called Mona started remote game events.
|
|
||||||
* There is a blog post describing how the teams use {% data variables.product.prodname_actions %} to produce their docs.
|
|
||||||
* Material about the April All Hands is now available for all team members to view.
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
{% ifversion copilot %}
|
{% ifversion copilot %}
|
||||||
|
|
||||||
## Using {% data variables.product.prodname_copilot_short %} to gain context
|
## Using {% data variables.product.prodname_copilot_short %} to gain context
|
||||||
@@ -185,6 +149,4 @@ For pull requests, you can create draft pull requests if your proposed changes a
|
|||||||
|
|
||||||
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 [AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/about-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 [AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/about-discussions).
|
||||||
|
|
||||||
{% ifversion team-discussions %}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 [AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions).{% endif %}
|
|
||||||
|
|
||||||
To learn some advanced formatting features that will help you communicate, see [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github).
|
To learn some advanced formatting features that will help you communicate, see [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github).
|
||||||
|
|||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
title: Working with Subversion on GitHub
|
|
||||||
intro: You can use Subversion clients and some Subversion workflows and properties with GitHub.
|
|
||||||
redirect_from:
|
|
||||||
- /articles/working-with-subversion-on-github
|
|
||||||
- /github/importing-your-projects-to-github/working-with-subversion-on-github
|
|
||||||
- /get-started/importing-your-projects-to-github/working-with-subversion-on-github
|
|
||||||
versions:
|
|
||||||
ghes: '<3.13'
|
|
||||||
children:
|
|
||||||
- /what-are-the-differences-between-subversion-and-git
|
|
||||||
- /support-for-subversion-clients
|
|
||||||
- /subversion-properties-supported-by-github
|
|
||||||
shortTitle: Subversion
|
|
||||||
---
|
|
||||||
@@ -1,29 +0,0 @@
|
|||||||
---
|
|
||||||
title: Subversion properties supported by GitHub
|
|
||||||
intro: 'There are several Subversion workflows and properties that are similar to existing functionality on {% data variables.product.github %}.'
|
|
||||||
redirect_from:
|
|
||||||
- /articles/subversion-properties-supported-by-github
|
|
||||||
- /github/importing-your-projects-to-github/subversion-properties-supported-by-github
|
|
||||||
- /github/importing-your-projects-to-github/working-with-subversion-on-github/subversion-properties-supported-by-github
|
|
||||||
- /get-started/importing-your-projects-to-github/working-with-subversion-on-github/subversion-properties-supported-by-github
|
|
||||||
versions:
|
|
||||||
ghes: '<3.13'
|
|
||||||
shortTitle: Properties supported by GitHub
|
|
||||||
---
|
|
||||||
{% data reusables.subversion.sunset %}
|
|
||||||
|
|
||||||
## Executable files (`svn:executable`)
|
|
||||||
|
|
||||||
We convert `svn:executable` properties by updating the file mode directly before adding it to the Git repository.
|
|
||||||
|
|
||||||
## MIME types (`svn:mime-type`)
|
|
||||||
|
|
||||||
{% data variables.product.github %} internally tracks the mime-type properties of files and the commits that added them.
|
|
||||||
|
|
||||||
## Ignoring unversioned items (`svn:ignore`)
|
|
||||||
|
|
||||||
If you've set files and directories to be ignored in Subversion, {% data variables.product.github %} will track them internally. Files ignored by subversion clients are completely distinct from entries in a _.gitignore_ file.
|
|
||||||
|
|
||||||
## Currently unsupported properties
|
|
||||||
|
|
||||||
{% data variables.product.github %} doesn't currently support `svn:externals`, `svn:global-ignores`, or any properties not listed above, including custom properties.
|
|
||||||
@@ -1,136 +0,0 @@
|
|||||||
---
|
|
||||||
title: Support for Subversion clients
|
|
||||||
intro: GitHub repositories can be accessed from both Git and Subversion (SVN) clients. This article covers using a Subversion client on GitHub and some common problems that you might run into.
|
|
||||||
redirect_from:
|
|
||||||
- /articles/support-for-subversion-clients
|
|
||||||
- /github/importing-your-projects-to-github/support-for-subversion-clients
|
|
||||||
- /github/importing-your-projects-to-github/working-with-subversion-on-github/support-for-subversion-clients
|
|
||||||
- /get-started/importing-your-projects-to-github/working-with-subversion-on-github/support-for-subversion-clients
|
|
||||||
versions:
|
|
||||||
ghes: '<3.13'
|
|
||||||
shortTitle: Support for Subversion clients
|
|
||||||
---
|
|
||||||
GitHub supports Subversion clients via the HTTPS protocol. We use a Subversion bridge to communicate svn commands to GitHub.
|
|
||||||
|
|
||||||
{% data reusables.subversion.sunset %}
|
|
||||||
|
|
||||||
## Supported Subversion features on GitHub
|
|
||||||
|
|
||||||
### Checkout
|
|
||||||
|
|
||||||
The first thing you'll want to do is a Subversion checkout. Since Git clones keep the working directory (where you edit files) separate from the repository data, there is only one branch in the working directory at a time.
|
|
||||||
|
|
||||||
Subversion checkouts are different: they mix the repository data in the working directories, so there is a working directory for each branch and tag you've checked out. For repositories with many branches and tags, checking out everything can be a bandwidth burden, so you should start with a partial checkout.
|
|
||||||
|
|
||||||
{% data reusables.repositories.navigate-to-repo %}
|
|
||||||
{% data reusables.repositories.copy-clone-url %}
|
|
||||||
|
|
||||||
1. Make an empty checkout of the repository:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
$ svn co --depth empty https://github.com/USER/REPO
|
|
||||||
> Checked out revision 1.
|
|
||||||
$ cd REPO
|
|
||||||
```
|
|
||||||
|
|
||||||
1. Get the `trunk` branch. The Subversion bridge maps trunk to the Git HEAD branch.
|
|
||||||
|
|
||||||
```shell
|
|
||||||
$ svn up trunk
|
|
||||||
> A trunk
|
|
||||||
> A trunk/README.md
|
|
||||||
> A trunk/gizmo.rb
|
|
||||||
> Updated to revision 1.
|
|
||||||
```
|
|
||||||
|
|
||||||
1. Get an empty checkout of the `branches` directory. This is where all of the non-`HEAD` branches live, and where you'll be making feature branches.
|
|
||||||
|
|
||||||
```shell
|
|
||||||
$ svn up --depth empty branches
|
|
||||||
Updated to revision 1.
|
|
||||||
```
|
|
||||||
|
|
||||||
### Creating branches
|
|
||||||
|
|
||||||
You can also create branches using the Subversion bridge to GitHub.
|
|
||||||
|
|
||||||
From your svn client, make sure the default branch is current by updating `trunk`:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
$ svn up trunk
|
|
||||||
> At revision 1.
|
|
||||||
```
|
|
||||||
|
|
||||||
Next, you can use `svn copy` to create a new branch:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
$ svn copy trunk branches/more_awesome
|
|
||||||
> A branches/more_awesome
|
|
||||||
$ svn commit -m 'Added more_awesome topic branch'
|
|
||||||
> Adding branches/more_awesome
|
|
||||||
|
|
||||||
> Committed revision 2.
|
|
||||||
```
|
|
||||||
|
|
||||||
You can confirm that the new branch exists in the repository's branch dropdown:
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
You can also confirm the new branch via the command line:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
$ git fetch
|
|
||||||
> From https://github.com/USER/REPO/
|
|
||||||
> * [new branch] more_awesome -> origin/more_awesome
|
|
||||||
```
|
|
||||||
|
|
||||||
### Making commits to Subversion
|
|
||||||
|
|
||||||
After you've added some features and fixed some bugs, you'll want to commit those
|
|
||||||
changes to GitHub. This works just like the Subversion you're used to. Edit your files, and use `svn commit` to record your changes:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
$ svn status
|
|
||||||
> M gizmo.rb
|
|
||||||
$ svn commit -m 'Guard against known problems'
|
|
||||||
> Sending more_awesome/gizmo.rb
|
|
||||||
> Transmitting file data .
|
|
||||||
> Committed revision 3.
|
|
||||||
$ svn status
|
|
||||||
> ? test
|
|
||||||
$ svn add test
|
|
||||||
> A test
|
|
||||||
> A test/gizmo_test.rb
|
|
||||||
$ svn commit -m 'Test coverage for problems'
|
|
||||||
> Adding more_awesome/test
|
|
||||||
> Adding more_awesome/test/gizmo_test.rb
|
|
||||||
> Transmitting file data .
|
|
||||||
> Committed revision 4.
|
|
||||||
```
|
|
||||||
|
|
||||||
### Switching between branches
|
|
||||||
|
|
||||||
To switch between branches, you'll probably want to start with a checkout of `trunk`:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
svn co --depth empty https://github.com/USER/REPO/trunk
|
|
||||||
```
|
|
||||||
|
|
||||||
Then, you can switch to another branch:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
svn switch https://github.com/USER/REPO/branches/more_awesome
|
|
||||||
```
|
|
||||||
|
|
||||||
## Finding the Git commit SHA for a Subversion commit
|
|
||||||
|
|
||||||
GitHub's Subversion server exposes the Git commit sha for each Subversion commit.
|
|
||||||
|
|
||||||
To see the commit SHA, you should ask for the `git-commit` unversioned remote property.
|
|
||||||
|
|
||||||
```shell
|
|
||||||
$ svn propget git-commit --revprop -r HEAD https://github.com/USER/REPO
|
|
||||||
05fcc584ed53d7b0c92e116cb7e64d198b13c4e3
|
|
||||||
```
|
|
||||||
|
|
||||||
With this commit SHA, you can, for example, look up the corresponding Git commit on GitHub.
|
|
||||||
@@ -1,66 +0,0 @@
|
|||||||
---
|
|
||||||
title: What are the differences between Subversion and Git?
|
|
||||||
intro: 'Subversion (SVN) repositories are similar to Git repositories, but there are several differences when it comes to the architecture of your projects.'
|
|
||||||
redirect_from:
|
|
||||||
- /articles/what-are-the-differences-between-svn-and-git
|
|
||||||
- /articles/what-are-the-differences-between-subversion-and-git
|
|
||||||
- /github/importing-your-projects-to-github/what-are-the-differences-between-subversion-and-git
|
|
||||||
- /github/importing-your-projects-to-github/working-with-subversion-on-github/what-are-the-differences-between-subversion-and-git
|
|
||||||
- /get-started/importing-your-projects-to-github/working-with-subversion-on-github/what-are-the-differences-between-subversion-and-git
|
|
||||||
versions:
|
|
||||||
ghes: '<3.13'
|
|
||||||
shortTitle: Subversion & Git differences
|
|
||||||
---
|
|
||||||
## Directory structure
|
|
||||||
|
|
||||||
Each _reference_, or labeled snapshot of a commit, in a project is organized within specific subdirectories, such as `trunk`, `branches`, and `tags`. For example, an SVN project with two features under development might look like this:
|
|
||||||
|
|
||||||
sample_project/trunk/README.md
|
|
||||||
sample_project/trunk/lib/widget.rb
|
|
||||||
sample_project/branches/new_feature/README.md
|
|
||||||
sample_project/branches/new_feature/lib/widget.rb
|
|
||||||
sample_project/branches/another_new_feature/README.md
|
|
||||||
sample_project/branches/another_new_feature/lib/widget.rb
|
|
||||||
|
|
||||||
An SVN workflow looks like this:
|
|
||||||
|
|
||||||
* The `trunk` directory represents the latest stable release of a project.
|
|
||||||
* Active feature work is developed within subdirectories under `branches`.
|
|
||||||
* When a feature is finished, the feature directory is merged into `trunk` and removed.
|
|
||||||
|
|
||||||
Git projects are also stored within a single directory. However, Git obscures the details of its references by storing them in a special _.git_ directory. For example, a Git project with two features under development might look like this:
|
|
||||||
|
|
||||||
sample_project/.git
|
|
||||||
sample_project/README.md
|
|
||||||
sample_project/lib/widget.rb
|
|
||||||
|
|
||||||
A Git workflow looks like this:
|
|
||||||
|
|
||||||
* A Git repository stores the full history of all of its branches and tags within the _.git_ directory.
|
|
||||||
* The latest stable release is contained within the default branch.
|
|
||||||
* Active feature work is developed in separate branches.
|
|
||||||
* When a feature is finished, the feature branch is merged into the default branch and deleted.
|
|
||||||
|
|
||||||
Unlike SVN, with Git the directory structure remains the same, but the contents of the files change based on your branch.
|
|
||||||
|
|
||||||
## Including subprojects
|
|
||||||
|
|
||||||
A _subproject_ is a project that's developed and managed somewhere outside of your main project. You typically import a subproject to add some functionality to your project without needing to maintain the code yourself. Whenever the subproject is updated, you can synchronize it with your project to ensure that everything is up-to-date.
|
|
||||||
|
|
||||||
In SVN, a subproject is called an _SVN external_. In Git, it's called a _Git submodule_. Although conceptually similar, Git submodules are not kept up-to-date automatically; you must explicitly ask for a new version to be brought into your project.
|
|
||||||
|
|
||||||
For more information, see [Git Tools Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) in the Git documentation.
|
|
||||||
|
|
||||||
## Preserving history
|
|
||||||
|
|
||||||
SVN is configured to assume that the history of a project never changes. Git allows you to modify previous commits and changes using tools like [`git rebase`](/get-started/using-git/about-git-rebase).
|
|
||||||
|
|
||||||
> [!TIP]
|
|
||||||
> [GitHub supports Subversion clients](/get-started/working-with-subversion-on-github/support-for-subversion-clients), which may produce some unexpected results if you're using both Git and SVN on the same project. If you've manipulated Git's commit history, those same commits will always remain within SVN's history. If you accidentally committed some sensitive data, we have [an article that will help you remove it from Git's history](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository).
|
|
||||||
|
|
||||||
{% data reusables.subversion.sunset %}
|
|
||||||
|
|
||||||
## Further reading
|
|
||||||
|
|
||||||
* ["Branching and Merging" from the _Git SCM_ book](https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging)
|
|
||||||
* [AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-a-subversion-repository)
|
|
||||||
@@ -12,7 +12,6 @@ featuredLinks:
|
|||||||
popular:
|
popular:
|
||||||
- /graphql/overview/explorer
|
- /graphql/overview/explorer
|
||||||
- /graphql/overview/public-schema
|
- /graphql/overview/public-schema
|
||||||
- /graphql/overview/schema-previews
|
|
||||||
- /graphql/guides/using-pagination-in-the-graphql-api
|
- /graphql/guides/using-pagination-in-the-graphql-api
|
||||||
guideCards:
|
guideCards:
|
||||||
- /graphql/guides/migrating-from-rest-to-graphql
|
- /graphql/guides/migrating-from-rest-to-graphql
|
||||||
@@ -23,6 +22,7 @@ changelog:
|
|||||||
layout: product-landing
|
layout: product-landing
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /v4
|
- /v4
|
||||||
|
- /graphql/overview/schema-previews
|
||||||
versions:
|
versions:
|
||||||
fpt: '*'
|
fpt: '*'
|
||||||
ghec: '*'
|
ghec: '*'
|
||||||
|
|||||||
@@ -19,10 +19,6 @@ Breaking changes are any changes that might require action from our integrators.
|
|||||||
* **Breaking:** Changes that will break existing queries to the GraphQL API. For example, removing a field would be a breaking change.
|
* **Breaking:** Changes that will break existing queries to the GraphQL API. For example, removing a field would be a breaking change.
|
||||||
* **Dangerous:** Changes that won't break existing queries but could affect the runtime behavior of clients. Adding an enum value is an example of a dangerous change.
|
* **Dangerous:** Changes that won't break existing queries but could affect the runtime behavior of clients. Adding an enum value is an example of a dangerous change.
|
||||||
|
|
||||||
{% ifversion ghes < 3.13 %}
|
|
||||||
We strive to provide stable APIs for our integrators. When a new feature is still evolving, we release it behind a [schema preview](/graphql/overview/schema-previews).
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
We'll announce upcoming breaking changes at least three months before making changes to the GraphQL schema, to give integrators time to make the necessary adjustments. Changes go into effect on the first day of a quarter (January 1st, April 1st, July 1st, or October 1st). For example, if we announce a change on January 15th, it will be made on July 1st.
|
We'll announce upcoming breaking changes at least three months before making changes to the GraphQL schema, to give integrators time to make the necessary adjustments. Changes go into effect on the first day of a quarter (January 1st, April 1st, July 1st, or October 1st). For example, if we announce a change on January 15th, it will be made on July 1st.
|
||||||
|
|
||||||
<!-- Content after this section is automatically generated -->
|
<!-- Content after this section is automatically generated -->
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Changelog
|
title: Changelog
|
||||||
intro: 'The GraphQL schema changelog is a list of recent and upcoming changes to our GraphQL API schema. It includes backwards-compatible changes{% ifversion ghes < 3.13 %}, schema previews,{% endif %} and upcoming breaking changes.'
|
intro: 'The GraphQL schema changelog is a list of recent and upcoming changes to our GraphQL API schema. It includes backwards-compatible changes and upcoming breaking changes.'
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /v4/changelog
|
- /v4/changelog
|
||||||
versions:
|
versions:
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ versions:
|
|||||||
children:
|
children:
|
||||||
- /about-the-graphql-api
|
- /about-the-graphql-api
|
||||||
- /public-schema
|
- /public-schema
|
||||||
- /schema-previews
|
|
||||||
- /breaking-changes
|
- /breaking-changes
|
||||||
- /changelog
|
- /changelog
|
||||||
- /explorer
|
- /explorer
|
||||||
|
|||||||
@@ -1,22 +0,0 @@
|
|||||||
---
|
|
||||||
title: Schema previews
|
|
||||||
intro: 'You can preview upcoming features and changes to the {% data variables.product.prodname_dotcom %} GraphQL schema before they are added to the {% data variables.product.prodname_dotcom %} GraphQL API.'
|
|
||||||
redirect_from:
|
|
||||||
- /v4/previews
|
|
||||||
versions:
|
|
||||||
ghes: '<=3.12'
|
|
||||||
topics:
|
|
||||||
- API
|
|
||||||
autogenerated: graphql
|
|
||||||
---
|
|
||||||
|
|
||||||
## About schema previews
|
|
||||||
|
|
||||||
During the preview period, we may change some features based on developer feedback. If we do make changes, we'll announce them on the [developer blog](https://developer.github.com/changes/) without advance notice.
|
|
||||||
|
|
||||||
To access a schema preview, you'll need to provide a custom [media type](/rest/overview/media-types) in the `Accept` header for your requests. Feature documentation for each preview specifies which custom media type to provide.
|
|
||||||
|
|
||||||
> [!NOTE]
|
|
||||||
> The GraphQL schema members under preview cannot be accessed via the Explorer at this time.
|
|
||||||
|
|
||||||
<!-- Content after this section is automatically generated -->
|
|
||||||
@@ -27,7 +27,7 @@ To track how smaller issues fit into the larger goal, milestones, or labels. For
|
|||||||
|
|
||||||
Issues and pull requests include built-in features to let you easily communicate with your collaborators. Use @mentions to alert a person or entire team about a comment. Assign collaborators to issues to communicate responsibility. Link to related issues or pull requests to communicate how they are connected.
|
Issues and pull requests include built-in features to let you easily communicate with your collaborators. Use @mentions to alert a person or entire team about a comment. Assign collaborators to issues to communicate responsibility. Link to related issues or pull requests to communicate how they are connected.
|
||||||
|
|
||||||
## Make use of the description{% ifversion projects-v2-status-updates %}, README, and status updates{% else %} and README{% endif %}
|
## Make use of the description, README, and status updates
|
||||||
|
|
||||||
Use your project's description and README to share information about the project.
|
Use your project's description and README to share information about the project.
|
||||||
|
|
||||||
@@ -39,12 +39,8 @@ For example:
|
|||||||
|
|
||||||
Project READMEs support Markdown which allows you to use images and advanced formatting such as links, lists, and headers. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project).
|
Project READMEs support Markdown which allows you to use images and advanced formatting such as links, lists, and headers. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project).
|
||||||
|
|
||||||
{% ifversion projects-v2-status-updates %}
|
|
||||||
|
|
||||||
You can also share high-level updates with other users of your project by posting status updates. Status updates allow you to mark the project with a status, such as "On track" or "At risk", set start and target dates, and share written updates with your team. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/sharing-project-updates).
|
You can also share high-level updates with other users of your project by posting status updates. Status updates allow you to mark the project with a status, such as "On track" or "At risk", set start and target dates, and share written updates with your team. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/sharing-project-updates).
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## Use views
|
## Use views
|
||||||
|
|
||||||
Use project views to look at your project from different angles.
|
Use project views to look at your project from different angles.
|
||||||
|
|||||||
@@ -3,9 +3,11 @@ title: 'Sharing {% data variables.projects.project_v2 %} updates'
|
|||||||
intro: 'You can post updates to your {% data variables.projects.projects_v2 %} that share the current status, start date, and target date of the {% data variables.projects.project_v2 %} itself.'
|
intro: 'You can post updates to your {% data variables.projects.projects_v2 %} that share the current status, start date, and target date of the {% data variables.projects.project_v2 %} itself.'
|
||||||
allowTitleToDifferFromFilename: true
|
allowTitleToDifferFromFilename: true
|
||||||
versions:
|
versions:
|
||||||
feature: projects-v2-status-updates
|
fpt: '*'
|
||||||
|
ghec: '*'
|
||||||
|
ghes: '*'
|
||||||
type: overview
|
type: overview
|
||||||
permissions: 'Anyone with write access for a project can add a status update. Anyone with read access for a project can view status updates and subscribe.'
|
permissions: Anyone with write access for a project can add a status update. Anyone with read access for a project can view status updates and subscribe.
|
||||||
topics:
|
topics:
|
||||||
- Projects
|
- Projects
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -1,50 +0,0 @@
|
|||||||
---
|
|
||||||
title: About team discussions
|
|
||||||
intro: 'Your team can plan together, update one another, or talk about any topic you''d like in discussion posts on your team''s page in an organization.'
|
|
||||||
redirect_from:
|
|
||||||
- /articles/about-team-discussions
|
|
||||||
- /github/building-a-strong-community/about-team-discussions
|
|
||||||
- /github/setting-up-and-managing-organizations-and-teams/about-team-discussions
|
|
||||||
versions:
|
|
||||||
feature: team-discussions
|
|
||||||
topics:
|
|
||||||
- Community
|
|
||||||
---
|
|
||||||
|
|
||||||
{% data reusables.organizations.team-discussions-migration %}
|
|
||||||
|
|
||||||
{% data reusables.organizations.team-discussions-purpose %}
|
|
||||||
|
|
||||||
Any organization member can post on your team's page or participate in a public discussion. {% data reusables.organizations.team-discussions-permissions %}
|
|
||||||
|
|
||||||
You can link to any team discussion to reference it elsewhere. You can pin important posts to your team's page for quick reference later. For more information, see [AUTOTITLE](/organizations/collaborating-with-your-team/pinning-a-team-discussion).
|
|
||||||
|
|
||||||
{% data reusables.organizations.team-discussions-default %} Owners can disable team discussions for the entire organization. For more information, see [AUTOTITLE](/organizations/organizing-members-into-teams/disabling-team-discussions-for-your-organization).
|
|
||||||
|
|
||||||
## Notifications for team discussions
|
|
||||||
|
|
||||||
When someone posts or replies to a public discussion on a team's page, members of the team and members of any child teams receive email or web notifications. When someone posts or replies to a private discussion on a team's page, only members of the team receive notifications.
|
|
||||||
|
|
||||||
> [!TIP]
|
|
||||||
> Depending on your notification settings, you'll receive updates by email, the web notifications page on {% data variables.product.github %}, or both. For more information, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications).
|
|
||||||
|
|
||||||
By default, if your username is mentioned in a team discussion, you'll receive notifications for the post mentioning your username and any replies to that post. Also, by default, if you reply to a post, you will receive notifications for other replies to the post.
|
|
||||||
|
|
||||||
To turn off notifications for team discussions, you can unsubscribe to a specific discussion post or change your notification settings to unwatch or completely ignore a specific team's discussions. You can subscribe to notifications for a specific discussion post even if you're unwatching that team's discussions.
|
|
||||||
|
|
||||||
For more information, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions) and [AUTOTITLE](/organizations/organizing-members-into-teams/about-teams#nested-teams).
|
|
||||||
|
|
||||||
{% ifversion fpt or ghec %}
|
|
||||||
|
|
||||||
## Organization discussions
|
|
||||||
|
|
||||||
You can also use organization discussions to facilitate conversations across your organization. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization).
|
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## Further reading
|
|
||||||
|
|
||||||
* [AUTOTITLE](/get-started/using-github/communicating-on-github)
|
|
||||||
* [AUTOTITLE](/organizations/organizing-members-into-teams/about-teams)
|
|
||||||
* [AUTOTITLE](/organizations/collaborating-with-your-team/creating-a-team-discussion)
|
|
||||||
* [AUTOTITLE](/organizations/collaborating-with-your-team/editing-or-deleting-a-team-discussion)
|
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
---
|
|
||||||
title: Creating a team discussion
|
|
||||||
intro: 'Any organization member can create a _public_ team discussion post. To create a _private_ team discussion post, you must be a member of the team or an organization owner.'
|
|
||||||
redirect_from:
|
|
||||||
- /articles/creating-a-team-discussion
|
|
||||||
- /github/building-a-strong-community/creating-a-team-discussion
|
|
||||||
- /github/setting-up-and-managing-organizations-and-teams/creating-a-team-discussion
|
|
||||||
versions:
|
|
||||||
feature: team-discussions
|
|
||||||
topics:
|
|
||||||
- Community
|
|
||||||
shortTitle: Create a team discussion
|
|
||||||
---
|
|
||||||
|
|
||||||
{% data reusables.organizations.team-discussions-migration %}
|
|
||||||
|
|
||||||
{% data reusables.organizations.team-discussions-permissions %} For more information, see [AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions).
|
|
||||||
|
|
||||||
{% data reusables.profile.access_org %}
|
|
||||||
{% data reusables.user-settings.access_org %}
|
|
||||||
{% data reusables.organizations.specific_team %}
|
|
||||||
{% data reusables.organizations.team-discussions-tab %}
|
|
||||||
1. Type a team discussion title and a comment to start a conversation.
|
|
||||||
1. Optionally, select whether you want your post to be private or public using the drop-down menu.
|
|
||||||
1. Click **Comment**.
|
|
||||||
|
|
||||||
## Further reading
|
|
||||||
|
|
||||||
* [AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions)
|
|
||||||
* [AUTOTITLE](/organizations/collaborating-with-your-team/editing-or-deleting-a-team-discussion)
|
|
||||||
* [AUTOTITLE](/organizations/collaborating-with-your-team/pinning-a-team-discussion)
|
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
---
|
|
||||||
title: Editing or deleting a team discussion
|
|
||||||
intro: 'Organization members can edit or delete discussions on a team''s page. If you''re an organization member, you can edit or delete the discussion.'
|
|
||||||
redirect_from:
|
|
||||||
- /articles/editing-or-deleting-a-team-discussion
|
|
||||||
- /github/building-a-strong-community/editing-or-deleting-a-team-discussion
|
|
||||||
- /github/setting-up-and-managing-organizations-and-teams/editing-or-deleting-a-team-discussion
|
|
||||||
versions:
|
|
||||||
feature: team-discussions
|
|
||||||
topics:
|
|
||||||
- Community
|
|
||||||
shortTitle: Manage a team discussion
|
|
||||||
---
|
|
||||||
|
|
||||||
{% data reusables.organizations.team-discussions-migration %}
|
|
||||||
|
|
||||||
{% data reusables.profile.access_org %}
|
|
||||||
{% data reusables.user-settings.access_org %}
|
|
||||||
{% data reusables.organizations.specific_team %}
|
|
||||||
{% data reusables.organizations.team-discussions-tab %}
|
|
||||||
1. Click {% octicon "kebab-horizontal" aria-label="The edit icon" %} next to the team discussion you want to edit or delete.
|
|
||||||
1. Click **Edit**. Optionally, click **Delete**.
|
|
||||||

|
|
||||||
1. Modify the team discussion title and comment as needed, and click **Update comment**.
|
|
||||||
|
|
||||||
## Further reading
|
|
||||||
|
|
||||||
* [AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions)
|
|
||||||
* [AUTOTITLE](/organizations/collaborating-with-your-team/creating-a-team-discussion)
|
|
||||||
* [AUTOTITLE](/organizations/collaborating-with-your-team/pinning-a-team-discussion)
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
---
|
|
||||||
title: Collaborating with your team
|
|
||||||
intro: 'Within an organization, your team can work together across projects using team discussions.'
|
|
||||||
redirect_from:
|
|
||||||
- /articles/collaborating-with-your-team
|
|
||||||
- /github/building-a-strong-community/collaborating-with-your-team
|
|
||||||
- /github/setting-up-and-managing-organizations-and-teams/collaborating-with-your-team
|
|
||||||
versions:
|
|
||||||
feature: team-discussions
|
|
||||||
topics:
|
|
||||||
- Community
|
|
||||||
children:
|
|
||||||
- /about-team-discussions
|
|
||||||
- /creating-a-team-discussion
|
|
||||||
- /editing-or-deleting-a-team-discussion
|
|
||||||
- /pinning-a-team-discussion
|
|
||||||
shortTitle: Collaborate with your team
|
|
||||||
---
|
|
||||||
|
|
||||||
{% data reusables.organizations.team-discussions-migration %}
|
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
---
|
|
||||||
title: Pinning a team discussion
|
|
||||||
intro: 'You can pin important discussions to your organization''s team pages for easy reference, and unpin discussions that are no longer relevant.'
|
|
||||||
redirect_from:
|
|
||||||
- /articles/pinning-a-team-discussion
|
|
||||||
- /github/building-a-strong-community/pinning-a-team-discussion
|
|
||||||
- /github/setting-up-and-managing-organizations-and-teams/pinning-a-team-discussion
|
|
||||||
versions:
|
|
||||||
feature: team-discussions
|
|
||||||
topics:
|
|
||||||
- Community
|
|
||||||
---
|
|
||||||
|
|
||||||
{% data reusables.organizations.team-discussions-migration %}
|
|
||||||
|
|
||||||
{% data reusables.profile.access_org %}
|
|
||||||
{% data reusables.user-settings.access_org %}
|
|
||||||
{% data reusables.organizations.specific_team %}
|
|
||||||
{% data reusables.organizations.team-discussions-tab %}
|
|
||||||
1. Click {% octicon "pin" aria-label="Pin this discussion" %} next to the team discussion you want to pin. You can also unpin a discussion by clicking the icon.
|
|
||||||
|
|
||||||
## Further reading
|
|
||||||
|
|
||||||
* [AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions)
|
|
||||||
* [AUTOTITLE](/organizations/collaborating-with-your-team/creating-a-team-discussion)
|
|
||||||
* [AUTOTITLE](/organizations/collaborating-with-your-team/editing-or-deleting-a-team-discussion)
|
|
||||||
@@ -6,6 +6,7 @@ redirect_from:
|
|||||||
- /articles/about-improved-organization-permissions
|
- /articles/about-improved-organization-permissions
|
||||||
- /categories/setting-up-and-managing-organizations-and-teams
|
- /categories/setting-up-and-managing-organizations-and-teams
|
||||||
- /github/setting-up-and-managing-organizations-and-teams
|
- /github/setting-up-and-managing-organizations-and-teams
|
||||||
|
- /organizations/organizing-members-into-teams/disabling-team-discussions-for-your-organization
|
||||||
introLinks:
|
introLinks:
|
||||||
overview: /organizations/collaborating-with-groups-in-organizations/about-organizations
|
overview: /organizations/collaborating-with-groups-in-organizations/about-organizations
|
||||||
featuredLinks:
|
featuredLinks:
|
||||||
@@ -38,7 +39,6 @@ children:
|
|||||||
- /managing-peoples-access-to-your-organization-with-roles
|
- /managing-peoples-access-to-your-organization-with-roles
|
||||||
- /managing-user-access-to-your-organizations-repositories
|
- /managing-user-access-to-your-organizations-repositories
|
||||||
- /organizing-members-into-teams
|
- /organizing-members-into-teams
|
||||||
- /collaborating-with-your-team
|
|
||||||
- /managing-access-to-your-organizations-project-boards
|
- /managing-access-to-your-organizations-project-boards
|
||||||
- /managing-programmatic-access-to-your-organization
|
- /managing-programmatic-access-to-your-organization
|
||||||
- /managing-oauth-access-to-your-organizations-data
|
- /managing-oauth-access-to-your-organizations-data
|
||||||
|
|||||||
@@ -123,9 +123,6 @@ To search for specific events, use the `action` qualifier in your query. Actions
|
|||||||
| `sponsors`| Contains all events related to sponsor buttons (see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository))
|
| `sponsors`| Contains all events related to sponsor buttons (see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository))
|
||||||
| {% endif %} |
|
| {% endif %} |
|
||||||
| `team` | Contains all activities related to teams in your organization.
|
| `team` | Contains all activities related to teams in your organization.
|
||||||
| {% ifversion team-discussions %} |
|
|
||||||
| `team_discussions` | Contains activities related to managing team discussions for an organization.
|
|
||||||
| {% endif %} |
|
|
||||||
| `workflows` | Contains activities related to {% data variables.product.prodname_actions %} workflows.
|
| `workflows` | Contains activities related to {% data variables.product.prodname_actions %} workflows.
|
||||||
|
|
||||||
You can search for specific sets of actions using these terms. For example:
|
You can search for specific sets of actions using these terms. For example:
|
||||||
|
|||||||
@@ -70,7 +70,7 @@ ssh-keygen -s ./ca-key -V '+1d' -I KEY-IDENTITY -O extension:id@{% data variable
|
|||||||
> [!WARNING]
|
> [!WARNING]
|
||||||
> After a certificate has been signed and issued, the certificate cannot be revoked.
|
> After a certificate has been signed and issued, the certificate cannot be revoked.
|
||||||
|
|
||||||
For CAs uploaded {% ifversion ghec %}after March 27th, 2024{% elsif ghes %}to {% data variables.product.prodname_ghe_server %} version 3.13 or later{% endif %}, you {% ifversion ghes < 3.13 %}will need to{% else %}must{% endif %} use the `-V` flag to configure a lifetime less than 366 days for the certificate. For CAs uploaded {% ifversion ghec %}before this date{% elsif ghes %}before version 3.13{% endif %}, the `-V` flag is optional, and you can create certificates that are irrevocable and live forever.
|
For CAs uploaded {% ifversion ghec %}after March 27th, 2024{% elsif ghes %}to {% data variables.product.prodname_ghe_server %} version 3.13 or later{% endif %}, you must use the `-V` flag to configure a lifetime less than 366 days for the certificate. For CAs uploaded {% ifversion ghec %}before this date{% elsif ghes %}before version 3.13{% endif %}, the `-V` flag is optional, and you can create certificates that are irrevocable and live forever.
|
||||||
|
|
||||||
{% ifversion ssh-ca-expires %}
|
{% ifversion ssh-ca-expires %}
|
||||||
If you have legacy CAs that are exempt from the expiration requirement, you can upgrade the CA to enforce the requirement. To learn more, see [AUTOTITLE](/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities) and [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-ssh-certificate-authorities-for-your-enterprise).
|
If you have legacy CAs that are exempt from the expiration requirement, you can upgrade the CA to enforce the requirement. To learn more, see [AUTOTITLE](/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities) and [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-ssh-certificate-authorities-for-your-enterprise).
|
||||||
|
|||||||
@@ -3,7 +3,9 @@ title: Managing custom properties for repositories in your organization
|
|||||||
intro: 'With custom properties, you can add metadata to repositories in your organization. You can use those properties to target repositories with rulesets.'
|
intro: 'With custom properties, you can add metadata to repositories in your organization. You can use those properties to target repositories with rulesets.'
|
||||||
permissions: 'Organization owners {% ifversion custom-org-roles %}and users with the "Manage the organization''s custom properties definitions" permission {% endif %}can add and set a custom property schema at the organization level.'
|
permissions: 'Organization owners {% ifversion custom-org-roles %}and users with the "Manage the organization''s custom properties definitions" permission {% endif %}can add and set a custom property schema at the organization level.'
|
||||||
versions:
|
versions:
|
||||||
feature: repository-properties
|
fpt: '*'
|
||||||
|
ghec: '*'
|
||||||
|
ghes: '*'
|
||||||
topics:
|
topics:
|
||||||
- Repositories
|
- Repositories
|
||||||
shortTitle: Custom properties
|
shortTitle: Custom properties
|
||||||
|
|||||||
@@ -49,10 +49,8 @@ Organization permissions do not grant read, write, or administrator access to an
|
|||||||
| {% ifversion ghec %} |
|
| {% ifversion ghec %} |
|
||||||
Manage organization OAuth app policies | Access to the "OAuth app policy" settings for the organization. | [AUTOTITLE](/organizations/managing-oauth-access-to-your-organizations-data/about-oauth-app-access-restrictions) |
|
Manage organization OAuth app policies | Access to the "OAuth app policy" settings for the organization. | [AUTOTITLE](/organizations/managing-oauth-access-to-your-organizations-data/about-oauth-app-access-restrictions) |
|
||||||
| {% endif %} |
|
| {% endif %} |
|
||||||
| {% ifversion repository-properties %} |
|
|
||||||
| Edit custom properties values at the organization level | Access to set custom property values on all repositories in the organization. | [AUTOTITLE](/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization) |
|
| Edit custom properties values at the organization level | Access to set custom property values on all repositories in the organization. | [AUTOTITLE](/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization) |
|
||||||
| Manage the organization's custom properties definitions | Access to create and edit custom property definitions for the organization. | [AUTOTITLE](/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization) |
|
| Manage the organization's custom properties definitions | Access to create and edit custom property definitions for the organization. | [AUTOTITLE](/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization) |
|
||||||
| {% endif %} |
|
|
||||||
| {% ifversion repo-rules-enterprise %} |
|
| {% ifversion repo-rules-enterprise %} |
|
||||||
| Manage organization ref update rules and rulesets | Access to manage rulesets and view ruleset insights at the organization level. | [AUTOTITLE](/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization) |
|
| Manage organization ref update rules and rulesets | Access to manage rulesets and view ruleset insights at the organization level. | [AUTOTITLE](/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization) |
|
||||||
| {% endif %} |
|
| {% endif %} |
|
||||||
|
|||||||
@@ -156,12 +156,6 @@ Some of the features listed below are limited to organizations using {% data var
|
|||||||
| {% ifversion ghec %} |
|
| {% ifversion ghec %} |
|
||||||
| View organization insights (see [AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-dependencies-in-your-organization)) | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |
|
| View organization insights (see [AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-dependencies-in-your-organization)) | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |
|
||||||
| {% endif %} |
|
| {% endif %} |
|
||||||
| {% ifversion team-discussions %} |
|
|
||||||
| View and post public team discussions to **all teams** (see [AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions)) | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |
|
|
||||||
| View and post private team discussions to **all teams** (see [AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions)) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} |{% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} |
|
|
||||||
| Edit and delete team discussions in **all teams** (see [AUTOTITLE](/communities/moderating-comments-and-conversations/managing-disruptive-comments)) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} |
|
|
||||||
| Disable team discussions for an organization (see [AUTOTITLE](/organizations/organizing-members-into-teams/disabling-team-discussions-for-your-organization)) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} |
|
|
||||||
| {% endif %} |
|
|
||||||
| Hide comments on writable commits, pull requests, and issues (see [AUTOTITLE](/communities/moderating-comments-and-conversations/managing-disruptive-comments#hiding-a-comment)) | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |
|
| Hide comments on writable commits, pull requests, and issues (see [AUTOTITLE](/communities/moderating-comments-and-conversations/managing-disruptive-comments#hiding-a-comment)) | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |
|
||||||
| Hide comments on _all_ commits, pull requests, and issues (see [AUTOTITLE](/communities/moderating-comments-and-conversations/managing-disruptive-comments#hiding-a-comment)) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |
|
| Hide comments on _all_ commits, pull requests, and issues (see [AUTOTITLE](/communities/moderating-comments-and-conversations/managing-disruptive-comments#hiding-a-comment)) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |
|
||||||
| Block and unblock non-member contributors (see [AUTOTITLE](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} |{% octicon "x" aria-label="No" %} |
|
| Block and unblock non-member contributors (see [AUTOTITLE](/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} |{% octicon "x" aria-label="No" %} |
|
||||||
@@ -255,15 +249,7 @@ Some of the features listed below are limited to organizations using {% data var
|
|||||||
| {% ifversion projects-v1 %} |
|
| {% ifversion projects-v1 %} |
|
||||||
| Create {% data variables.projects.projects_v1_boards %} (see [AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization)) | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |
|
| Create {% data variables.projects.projects_v1_boards %} (see [AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization)) | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |
|
||||||
| {% endif %} |
|
| {% endif %} |
|
||||||
| {% ifversion team-discussions %} |
|
|
||||||
| View and post public team discussions to **all teams** (see [AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions)) | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |
|
|
||||||
| View and post private team discussions to **all teams** (see [AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions)) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} |
|
|
||||||
| Edit and delete team discussions in **all teams** (for more information, see [AUTOTITLE](/communities/moderating-comments-and-conversations/managing-disruptive-comments)) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} |
|
|
||||||
| {% endif %} |
|
|
||||||
| Hide comments on commits, pull requests, and issues (see [AUTOTITLE](/communities/moderating-comments-and-conversations/managing-disruptive-comments#hiding-a-comment)) | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |
|
| Hide comments on commits, pull requests, and issues (see [AUTOTITLE](/communities/moderating-comments-and-conversations/managing-disruptive-comments#hiding-a-comment)) | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |
|
||||||
| {% ifversion team-discussions %} |
|
|
||||||
| Disable team discussions for an organization (see [AUTOTITLE](/organizations/organizing-members-into-teams/disabling-team-discussions-for-your-organization)) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} |
|
|
||||||
| {% endif %} |
|
|
||||||
| Set a team profile picture in **all teams** (see [AUTOTITLE](/organizations/organizing-members-into-teams/setting-your-teams-profile-picture)) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} |
|
| Set a team profile picture in **all teams** (see [AUTOTITLE](/organizations/organizing-members-into-teams/setting-your-teams-profile-picture)) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} |
|
||||||
| Manage the publication of {% data variables.product.prodname_pages %} sites from repositories in the organization (see [AUTOTITLE](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} |
|
| Manage the publication of {% data variables.product.prodname_pages %} sites from repositories in the organization (see [AUTOTITLE](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} |
|
||||||
| [Move teams in an organization's hierarchy](/organizations/organizing-members-into-teams/moving-a-team-in-your-organizations-hierarchy) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} |
|
| [Move teams in an organization's hierarchy](/organizations/organizing-members-into-teams/moving-a-team-in-your-organizations-hierarchy) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} |
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ title: Setting a personal access token policy for your organization
|
|||||||
intro: 'Organization owners can control access to resources by applying policies to {% data variables.product.pat_generic_plural %}'
|
intro: 'Organization owners can control access to resources by applying policies to {% data variables.product.pat_generic_plural %}'
|
||||||
versions:
|
versions:
|
||||||
fpt: '*'
|
fpt: '*'
|
||||||
ghes: '>3.10'
|
ghes: '*'
|
||||||
ghec: '*'
|
ghec: '*'
|
||||||
shortTitle: Set a token policy
|
shortTitle: Set a token policy
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -44,11 +44,7 @@ You can view all the teams you belong to on your personal dashboard. For more in
|
|||||||
|
|
||||||
Each team has its own page within an organization. On a team's page, you can view team members, child teams, and the team's repositories. Organization owners and team maintainers can access team settings and update the team's description and profile picture from the team's page.
|
Each team has its own page within an organization. On a team's page, you can view team members, child teams, and the team's repositories. Organization owners and team maintainers can access team settings and update the team's description and profile picture from the team's page.
|
||||||
|
|
||||||
{% ifversion team-discussions %}
|
|
||||||
Organization members can create and participate in discussions with the team. For more information, see [AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions).
|
|
||||||
{% else %}
|
|
||||||
{% data reusables.organizations.team-discussions-deprecation %}
|
{% data reusables.organizations.team-discussions-deprecation %}
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## Nested teams
|
## Nested teams
|
||||||
|
|
||||||
|
|||||||
@@ -25,9 +25,8 @@ People with the team maintainer role can manage team membership and settings.
|
|||||||
* [Change the team's visibility](/organizations/organizing-members-into-teams/changing-team-visibility)
|
* [Change the team's visibility](/organizations/organizing-members-into-teams/changing-team-visibility)
|
||||||
* [Request to add a child team](/organizations/organizing-members-into-teams/requesting-to-add-a-child-team)
|
* [Request to add a child team](/organizations/organizing-members-into-teams/requesting-to-add-a-child-team)
|
||||||
* [Request to add or change a parent team](/organizations/organizing-members-into-teams/requesting-to-add-or-change-a-parent-team)
|
* [Request to add or change a parent team](/organizations/organizing-members-into-teams/requesting-to-add-or-change-a-parent-team)
|
||||||
* [Set the team profile picture](/organizations/organizing-members-into-teams/setting-your-teams-profile-picture){% ifversion team-discussions %}
|
* [Set the team profile picture](/organizations/organizing-members-into-teams/setting-your-teams-profile-picture)
|
||||||
* [Edit team discussions](/communities/moderating-comments-and-conversations/managing-disruptive-comments#editing-a-comment)
|
|
||||||
* [Delete team discussions](/communities/moderating-comments-and-conversations/managing-disruptive-comments#deleting-a-comment){% endif %}
|
|
||||||
* [Add organization members to the team](/organizations/organizing-members-into-teams/adding-organization-members-to-a-team)
|
* [Add organization members to the team](/organizations/organizing-members-into-teams/adding-organization-members-to-a-team)
|
||||||
* [Remove organization members from the team](/organizations/organizing-members-into-teams/removing-organization-members-from-a-team)
|
* [Remove organization members from the team](/organizations/organizing-members-into-teams/removing-organization-members-from-a-team)
|
||||||
* Remove the team's access to repositories
|
* Remove the team's access to repositories
|
||||||
|
|||||||
@@ -1,23 +0,0 @@
|
|||||||
---
|
|
||||||
title: Disabling team discussions for your organization
|
|
||||||
intro: Organization owners can choose to disable or enable team discussions across the organization.
|
|
||||||
redirect_from:
|
|
||||||
- /articles/disabling-team-discussions-for-your-organization
|
|
||||||
- /github/setting-up-and-managing-organizations-and-teams/disabling-team-discussions-for-your-organization
|
|
||||||
versions:
|
|
||||||
feature: team-discussions
|
|
||||||
topics:
|
|
||||||
- Organizations
|
|
||||||
- Teams
|
|
||||||
shortTitle: Disable team discussions
|
|
||||||
---
|
|
||||||
|
|
||||||
{% data reusables.organizations.team-discussions-migration %}
|
|
||||||
|
|
||||||
{% data reusables.organizations.team-discussions-default %} For more information on team discussions, see [AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions).
|
|
||||||
|
|
||||||
{% data reusables.profile.access_org %}
|
|
||||||
{% data reusables.profile.org_settings %}
|
|
||||||
{% data reusables.organizations.teams_sidebar %}
|
|
||||||
1. Under "Team discussions", deselect **Enable team discussions for this organization**.
|
|
||||||
1. Click **Save**.
|
|
||||||
@@ -34,8 +34,8 @@ children:
|
|||||||
- /requesting-to-add-a-child-team
|
- /requesting-to-add-a-child-team
|
||||||
- /requesting-to-add-or-change-a-parent-team
|
- /requesting-to-add-or-change-a-parent-team
|
||||||
- /removing-organization-members-from-a-team
|
- /removing-organization-members-from-a-team
|
||||||
- /disabling-team-discussions-for-your-organization
|
|
||||||
- /managing-scheduled-reminders-for-your-team
|
- /managing-scheduled-reminders-for-your-team
|
||||||
- /deleting-a-team
|
- /deleting-a-team
|
||||||
shortTitle: Organize members into teams
|
shortTitle: Organize members into teams
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -38,16 +38,10 @@ You can create a branch in different ways on {% data variables.product.github %}
|
|||||||
### Creating a branch using the branch dropdown
|
### Creating a branch using the branch dropdown
|
||||||
|
|
||||||
{% data reusables.repositories.navigate-to-repo %}
|
{% data reusables.repositories.navigate-to-repo %}
|
||||||
{% ifversion code-view-ui %}
|
|
||||||
1. Select the {% octicon "git-branch" aria-hidden="true" %} branch dropdown menu, in the file tree view or at the top of the integrated file editor.
|
1. Select the {% octicon "git-branch" aria-hidden="true" %} branch dropdown menu, in the file tree view or at the top of the integrated file editor.
|
||||||
|
|
||||||

|

|
||||||
{% else %}
|
|
||||||
1. Select the branch selector dropdown menu.
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
1. Optionally, if you want to create the new branch from a branch other than the default branch of the repository, click another branch, then select the branch dropdown menu again.
|
1. Optionally, if you want to create the new branch from a branch other than the default branch of the repository, click another branch, then select the branch dropdown menu again.
|
||||||
1. In the "Find or create a branch..." text field, type a unique name for your new branch, then click **Create branch**.
|
1. In the "Find or create a branch..." text field, type a unique name for your new branch, then click **Create branch**.
|
||||||
|
|
||||||
|
|||||||
@@ -19,13 +19,6 @@ shortTitle: Change the default branch
|
|||||||
|
|
||||||
You can choose the default branch for a repository. The default branch is the base branch for pull requests and code commits. For more information about the default branch, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches#about-the-default-branch).
|
You can choose the default branch for a repository. The default branch is the base branch for pull requests and code commits. For more information about the default branch, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches#about-the-default-branch).
|
||||||
|
|
||||||
{% ifversion ghes < 3.13 %}
|
|
||||||
|
|
||||||
> [!NOTE]
|
|
||||||
> If you use the Git-Subversion bridge, changing the default branch will affect your `trunk` branch contents and the `HEAD` you see when you list references for the remote repository. For more information, see [AUTOTITLE](/get-started/working-with-subversion-on-github/support-for-subversion-clients) and [git-ls-remote](https://git-scm.com/docs/git-ls-remote.html) in the Git documentation.
|
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
You can also rename the default branch. For more information, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch).
|
You can also rename the default branch. For more information, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch).
|
||||||
|
|
||||||
{% data reusables.branches.set-default-branch %}
|
{% data reusables.branches.set-default-branch %}
|
||||||
|
|||||||
@@ -12,8 +12,6 @@ When you add a tag protection rule, all tags that match the pattern provided wil
|
|||||||
|
|
||||||
Additionally, you can create custom repository roles to allow other groups of users to create or delete tags that match tag protection rules. For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization).
|
Additionally, you can create custom repository roles to allow other groups of users to create or delete tags that match tag protection rules. For more information, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/managing-custom-repository-roles-for-an-organization).
|
||||||
|
|
||||||
{% ifversion tag-protection-rules-import %}
|
|
||||||
|
|
||||||
### About importing tag protection rules to repository rulesets
|
### About importing tag protection rules to repository rulesets
|
||||||
|
|
||||||
You can import existing tag protection rules into repository rulesets. This will implement the same tag protections you currently have in place for your repository. For more information, see [Importing tag protection rules to repository rulesets](#importing-tag-protection-rules-to-repository-rulesets).
|
You can import existing tag protection rules into repository rulesets. This will implement the same tag protections you currently have in place for your repository. For more information, see [Importing tag protection rules to repository rulesets](#importing-tag-protection-rules-to-repository-rulesets).
|
||||||
@@ -25,8 +23,6 @@ Rulesets have the following advantages over tag protection rules.
|
|||||||
* Anyone with read access to a repository can view the active rulesets for the repository. This means a developer can understand why they have hit a rule, or an auditor can check the security constraints for the repository, without requiring admin access to the repository.
|
* Anyone with read access to a repository can view the active rulesets for the repository. This means a developer can understand why they have hit a rule, or an auditor can check the security constraints for the repository, without requiring admin access to the repository.
|
||||||
* With rulesets, you can restrict tag names on an organization-wide basis.
|
* With rulesets, you can restrict tag names on an organization-wide basis.
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## Adding tag protection rules
|
## Adding tag protection rules
|
||||||
|
|
||||||
{% data reusables.repositories.navigate-to-repo %}
|
{% data reusables.repositories.navigate-to-repo %}
|
||||||
@@ -39,8 +35,6 @@ Rulesets have the following advantages over tag protection rules.
|
|||||||
|
|
||||||
1. Click **Add rule**.
|
1. Click **Add rule**.
|
||||||
|
|
||||||
{% ifversion tag-protection-rules-import %}
|
|
||||||
|
|
||||||
## Importing tag protection rules to repository rulesets
|
## Importing tag protection rules to repository rulesets
|
||||||
|
|
||||||
{% data reusables.repositories.navigate-to-repo %}
|
{% data reusables.repositories.navigate-to-repo %}
|
||||||
@@ -49,5 +43,3 @@ Rulesets have the following advantages over tag protection rules.
|
|||||||
1. Click **Import to rulesets** in the upper right corner.
|
1. Click **Import to rulesets** in the upper right corner.
|
||||||
1. Select **Create separate rulesets for creating and deleting protected tags** or **Create one ruleset for all protected tag operations**. Once created, the rulesets can be edited to further refine their behavior.
|
1. Select **Create separate rulesets for creating and deleting protected tags** or **Create one ruleset for all protected tag operations**. Once created, the rulesets can be edited to further refine their behavior.
|
||||||
1. Click **Import**.
|
1. Click **Import**.
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|||||||
@@ -28,11 +28,8 @@ When creating a file on {% data variables.product.github %}, consider the follow
|
|||||||
1. In the file name field, type the name and extension for the file. To create subdirectories, type the `/` directory separator.
|
1. In the file name field, type the name and extension for the file. To create subdirectories, type the `/` directory separator.
|
||||||
1. In the file contents text box, type content for the file.
|
1. In the file contents text box, type content for the file.
|
||||||
1. To review the new content, above the file contents, click **Preview**.
|
1. To review the new content, above the file contents, click **Preview**.
|
||||||
{% ifversion code-view-ui %}
|
|
||||||

|

|
||||||
{% else %}
|
|
||||||

|
|
||||||
{% endif %}
|
|
||||||
{% data reusables.files.write_commit_message %}
|
{% data reusables.files.write_commit_message %}
|
||||||
{% data reusables.files.choose-commit-email %}
|
{% data reusables.files.choose-commit-email %}
|
||||||
{% data reusables.files.choose_commit_branch %}
|
{% data reusables.files.choose_commit_branch %}
|
||||||
|
|||||||
@@ -27,13 +27,10 @@ If the file or directory you deleted contains sensitive data, the data will stil
|
|||||||
## Deleting a file
|
## Deleting a file
|
||||||
|
|
||||||
1. Browse to the file in your repository that you want to delete.
|
1. Browse to the file in your repository that you want to delete.
|
||||||
{% ifversion code-view-ui %}
|
|
||||||
1. In the top-right corner, select the {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} dropdown menu, then click **Delete file**.
|
1. In the top-right corner, select the {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} dropdown menu, then click **Delete file**.
|
||||||
|
|
||||||

|

|
||||||
{% else %}
|
|
||||||
1. At the top of the file, click {% octicon "trash" aria-label="The trash icon" %}.
|
|
||||||
{% endif %}
|
|
||||||
{% data reusables.files.commit-message %}
|
{% data reusables.files.commit-message %}
|
||||||
{% data reusables.files.choose-commit-email %}
|
{% data reusables.files.choose-commit-email %}
|
||||||
{% data reusables.files.choose_commit_branch %}
|
{% data reusables.files.choose_commit_branch %}
|
||||||
|
|||||||
@@ -27,7 +27,7 @@ You do not need to configure anything in your repository to enable code navigati
|
|||||||
|
|
||||||
{% data variables.product.prodname_dotcom %} has developed a code navigation approach based on the open source [`tree-sitter`](https://github.com/tree-sitter/tree-sitter) library that searches all definitions and references across a repository to find entities with a given name.
|
{% data variables.product.prodname_dotcom %} has developed a code navigation approach based on the open source [`tree-sitter`](https://github.com/tree-sitter/tree-sitter) library that searches all definitions and references across a repository to find entities with a given name.
|
||||||
|
|
||||||
{% ifversion code-view-ui %}You can use keyboard shortcuts to navigate within a code file. For more information, see [AUTOTITLE](/get-started/accessibility/keyboard-shortcuts#navigating-within-code-files).{% endif %}
|
You can use keyboard shortcuts to navigate within a code file. For more information, see [AUTOTITLE](/get-started/accessibility/keyboard-shortcuts#navigating-within-code-files).
|
||||||
|
|
||||||
{% ifversion code-search-upgrade %}
|
{% ifversion code-search-upgrade %}
|
||||||
|
|
||||||
|
|||||||
@@ -27,14 +27,10 @@ With the raw view, you can view or copy the raw content of a file without any st
|
|||||||
{% data reusables.repositories.navigate-to-repo %}
|
{% data reusables.repositories.navigate-to-repo %}
|
||||||
1. Click the file that you want to view.
|
1. Click the file that you want to view.
|
||||||
1. In the upper-right corner of the file view, click **Raw**.
|
1. In the upper-right corner of the file view, click **Raw**.
|
||||||
{% ifversion code-view-ui %}
|
|
||||||
|
|
||||||

|

|
||||||
{% else %}
|
|
||||||
|
|
||||||

|
1. Optionally, to copy the raw file content, in the upper-right corner of the file view, click **{% octicon "copy" aria-label="Copy raw content" %}**. To download the raw file, click **{% octicon "download" aria-label="Download raw file" %}**.
|
||||||
{% endif %}
|
|
||||||
1. Optionally, to copy the raw file content, in the upper-right corner of the file view, click **{% octicon "copy" aria-label="Copy raw content" %}**. {% ifversion code-view-ui %} To download the raw file, click **{% octicon "download" aria-label="Download raw file" %}**.{% endif %}
|
|
||||||
|
|
||||||
## Viewing the line-by-line revision history for a file
|
## Viewing the line-by-line revision history for a file
|
||||||
|
|
||||||
@@ -45,7 +41,6 @@ Within the blame view, you can view the line-by-line revision history for an ent
|
|||||||
|
|
||||||
{% data reusables.repositories.navigate-to-repo %}
|
{% data reusables.repositories.navigate-to-repo %}
|
||||||
1. Click to open the file whose line history you want to view.
|
1. Click to open the file whose line history you want to view.
|
||||||
{% ifversion code-view-ui %}
|
|
||||||
1. Above the file content, click **Blame**. This view gives you a line-by-line revision history, with the code in a file separated by commit. Each commit lists the author, commit description, and commit date.
|
1. Above the file content, click **Blame**. This view gives you a line-by-line revision history, with the code in a file separated by commit. Each commit lists the author, commit description, and commit date.
|
||||||
1. To see versions of a file before a particular commit, click {% octicon "versions" aria-label="View blame prior to this change" %}. Alternatively, to see more detail about a particular commit, click the commit message.
|
1. To see versions of a file before a particular commit, click {% octicon "versions" aria-label="View blame prior to this change" %}. Alternatively, to see more detail about a particular commit, click the commit message.
|
||||||
|
|
||||||
@@ -53,14 +48,6 @@ Within the blame view, you can view the line-by-line revision history for an ent
|
|||||||
|
|
||||||
1. To return to the raw code view, above the file content, click **Code**.
|
1. To return to the raw code view, above the file content, click **Code**.
|
||||||
* If you are viewing a Markdown file, above the file content, you can also click **Preview** to return to the view with Markdown formatting applied.
|
* If you are viewing a Markdown file, above the file content, you can also click **Preview** to return to the view with Markdown formatting applied.
|
||||||
{% else %}
|
|
||||||
1. In the upper-right corner of the file view, click **Blame** to open the blame view.
|
|
||||||
|
|
||||||

|
|
||||||
1. To see earlier revisions of a specific line, or reblame, click {% octicon "versions" aria-label="View blame prior to this change" %} until you've found the changes you're interested in viewing.
|
|
||||||
|
|
||||||

|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## Ignore commits in the blame view
|
## Ignore commits in the blame view
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ intro: Use the REST API to create and manage custom properties for an organizati
|
|||||||
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
|
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
|
||||||
fpt: '*'
|
fpt: '*'
|
||||||
ghec: '*'
|
ghec: '*'
|
||||||
ghes: '>=3.13'
|
ghes: '*'
|
||||||
topics:
|
topics:
|
||||||
- API
|
- API
|
||||||
autogenerated: rest
|
autogenerated: rest
|
||||||
|
|||||||
@@ -1,13 +1,11 @@
|
|||||||
---
|
---
|
||||||
title: REST API endpoints for custom properties
|
title: REST API endpoints for custom properties
|
||||||
shortTitle: Custom properties
|
shortTitle: Custom properties
|
||||||
intro: >-
|
intro: Use the REST API to list the custom properties assigned to a repository by the organization.
|
||||||
Use the REST API to list the custom properties assigned to a repository by the
|
|
||||||
organization.
|
|
||||||
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
|
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
|
||||||
fpt: '*'
|
fpt: '*'
|
||||||
ghec: '*'
|
ghec: '*'
|
||||||
ghes: '>=3.13'
|
ghes: '*'
|
||||||
topics:
|
topics:
|
||||||
- API
|
- API
|
||||||
autogenerated: rest
|
autogenerated: rest
|
||||||
|
|||||||
@@ -16,13 +16,4 @@ autogenerated: rest
|
|||||||
|
|
||||||
{% data reusables.organizations.team-discussions-api-deprecation %}
|
{% data reusables.organizations.team-discussions-api-deprecation %}
|
||||||
|
|
||||||
{% ifversion team-discussions %}
|
|
||||||
|
|
||||||
## About team discussion comments
|
|
||||||
|
|
||||||
Any member of the team's [organization](/rest/orgs) can create and read comments on a public discussion. For more details, see [AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions).
|
|
||||||
|
|
||||||
{% data reusables.organizations.team-api %}
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
<!-- Content after this section is automatically generated -->
|
<!-- Content after this section is automatically generated -->
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user