Ran script/content-migrations/convert-if-to-ifversion.js
This commit is contained in:
@@ -41,7 +41,7 @@ You can also find a list of your recently visited repositories, teams, and proje
|
|||||||
|
|
||||||
## Staying updated with activity from the community
|
## Staying updated with activity from the community
|
||||||
|
|
||||||
{% if for-you-feed %}
|
{% ifversion for-you-feed %}
|
||||||
The main section of your dashboard has two activity feeds:
|
The main section of your dashboard has two activity feeds:
|
||||||
|
|
||||||
- Following: Activity by people you follow and from repositories you watch.
|
- Following: Activity by people you follow and from repositories you watch.
|
||||||
@@ -68,7 +68,7 @@ You'll see updates in your news feed when a user you follow:
|
|||||||
|
|
||||||
For more information about following people and watching repositories, see "[Following people](/get-started/exploring-projects-on-github/following-people)" and "[Be social](/get-started/quickstart/be-social)."
|
For more information about following people and watching repositories, see "[Following people](/get-started/exploring-projects-on-github/following-people)" and "[Be social](/get-started/quickstart/be-social)."
|
||||||
|
|
||||||
{% if for-you-feed %}
|
{% ifversion for-you-feed %}
|
||||||
### For you feed
|
### For you feed
|
||||||
|
|
||||||
{% note %}
|
{% note %}
|
||||||
|
|||||||
@@ -39,7 +39,7 @@ You may want to use a dark theme to reduce power consumption on certain devices,
|
|||||||
{% ifversion fpt or ghec %}
|
{% ifversion fpt or ghec %}
|
||||||
- If you would like to choose a theme which is currently in public beta, you will first need to enable it with feature preview. For more information, see "[Exploring early access releases with feature preview](/get-started/using-github/exploring-early-access-releases-with-feature-preview)."{% endif %}
|
- If you would like to choose a theme which is currently in public beta, you will first need to enable it with feature preview. For more information, see "[Exploring early access releases with feature preview](/get-started/using-github/exploring-early-access-releases-with-feature-preview)."{% endif %}
|
||||||
|
|
||||||
{% if command-palette %}
|
{% ifversion command-palette %}
|
||||||
|
|
||||||
{% note %}
|
{% note %}
|
||||||
|
|
||||||
|
|||||||
@@ -32,7 +32,7 @@ If your organization uses {% data variables.product.prodname_ghe_cloud %}, you c
|
|||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if enterprise-owners-visible-for-org-members %}
|
{% ifversion enterprise-owners-visible-for-org-members %}
|
||||||
## View enterprise owners and their roles in an organization
|
## View enterprise owners and their roles in an organization
|
||||||
|
|
||||||
If your organization is managed by an enterprise account, then you can view the enterprise owners who manage billing settings and policies for all of your enterprise's organizations. For more information about enterprise accounts, see "[Types of {% data variables.product.prodname_dotcom %} accounts](/get-started/learning-about-github/types-of-github-accounts)."
|
If your organization is managed by an enterprise account, then you can view the enterprise owners who manage billing settings and policies for all of your enterprise's organizations. For more information about enterprise accounts, see "[Types of {% data variables.product.prodname_dotcom %} accounts](/get-started/learning-about-github/types-of-github-accounts)."
|
||||||
@@ -51,7 +51,7 @@ You can also view whether an enterprise owner has a specific role in the organiz
|
|||||||
| Enterprise owner | Organization owner | Able to configure organization settings and manage access to the organization's resources through teams, etc. |
|
| Enterprise owner | Organization owner | Able to configure organization settings and manage access to the organization's resources through teams, etc. |
|
||||||
| Enterprise owner | Organization member | Able to access organization resources and content, such as repositories, without access to the organization's settings. |
|
| Enterprise owner | Organization member | Able to access organization resources and content, such as repositories, without access to the organization's settings. |
|
||||||
|
|
||||||
To review all roles in an organization, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." {% if custom-repository-roles %} An organization member can also have a custom role for a specific repository. For more information, see "[Managing custom repository roles for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)."{% endif %}
|
To review all roles in an organization, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)." {% ifversion custom-repository-roles %} An organization member can also have a custom role for a specific repository. For more information, see "[Managing custom repository roles for an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)."{% endif %}
|
||||||
|
|
||||||
For more information about the enterprise owner role, see "[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owner)."
|
For more information about the enterprise owner role, see "[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise#enterprise-owner)."
|
||||||
|
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ shortTitle: Build & test Java & Gradle
|
|||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
This guide shows you how to create a workflow that performs continuous integration (CI) for your Java project using the Gradle build system. The workflow you create will allow you to see when commits to a pull request cause build or test failures against your default branch; this approach can help ensure that your code is always healthy. You can extend your CI workflow to {% if actions-caching %}cache files and{% endif %} upload artifacts from a workflow run.
|
This guide shows you how to create a workflow that performs continuous integration (CI) for your Java project using the Gradle build system. The workflow you create will allow you to see when commits to a pull request cause build or test failures against your default branch; this approach can help ensure that your code is always healthy. You can extend your CI workflow to {% ifversion actions-caching %}cache files and{% endif %} upload artifacts from a workflow run.
|
||||||
|
|
||||||
{% ifversion ghae %}
|
{% ifversion ghae %}
|
||||||
{% data reusables.actions.self-hosted-runners-software %}
|
{% data reusables.actions.self-hosted-runners-software %}
|
||||||
@@ -110,7 +110,7 @@ steps:
|
|||||||
arguments: -b ci.gradle package
|
arguments: -b ci.gradle package
|
||||||
```
|
```
|
||||||
|
|
||||||
{% if actions-caching %}
|
{% ifversion actions-caching %}
|
||||||
|
|
||||||
## Caching dependencies
|
## Caching dependencies
|
||||||
|
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ shortTitle: Build & test Java with Maven
|
|||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
This guide shows you how to create a workflow that performs continuous integration (CI) for your Java project using the Maven software project management tool. The workflow you create will allow you to see when commits to a pull request cause build or test failures against your default branch; this approach can help ensure that your code is always healthy. You can extend your CI workflow to {% if actions-caching %}cache files and{% endif %} upload artifacts from a workflow run.
|
This guide shows you how to create a workflow that performs continuous integration (CI) for your Java project using the Maven software project management tool. The workflow you create will allow you to see when commits to a pull request cause build or test failures against your default branch; this approach can help ensure that your code is always healthy. You can extend your CI workflow to {% ifversion actions-caching %}cache files and{% endif %} upload artifacts from a workflow run.
|
||||||
|
|
||||||
{% ifversion ghae %}
|
{% ifversion ghae %}
|
||||||
{% data reusables.actions.self-hosted-runners-software %}
|
{% data reusables.actions.self-hosted-runners-software %}
|
||||||
@@ -99,7 +99,7 @@ steps:
|
|||||||
run: mvn --batch-mode --update-snapshots verify
|
run: mvn --batch-mode --update-snapshots verify
|
||||||
```
|
```
|
||||||
|
|
||||||
{% if actions-caching %}
|
{% ifversion actions-caching %}
|
||||||
|
|
||||||
## Caching dependencies
|
## Caching dependencies
|
||||||
|
|
||||||
|
|||||||
@@ -120,7 +120,7 @@ steps:
|
|||||||
run: dotnet add package Newtonsoft.Json --version 12.0.1
|
run: dotnet add package Newtonsoft.Json --version 12.0.1
|
||||||
```
|
```
|
||||||
|
|
||||||
{% if actions-caching %}
|
{% ifversion actions-caching %}
|
||||||
|
|
||||||
### Caching dependencies
|
### Caching dependencies
|
||||||
|
|
||||||
|
|||||||
@@ -134,7 +134,7 @@ If you don't specify a Node.js version, {% data variables.product.prodname_dotco
|
|||||||
|
|
||||||
{% data variables.product.prodname_dotcom %}-hosted runners have npm and Yarn dependency managers installed. You can use npm and Yarn to install dependencies in your workflow before building and testing your code. The Windows and Linux {% data variables.product.prodname_dotcom %}-hosted runners also have Grunt, Gulp, and Bower installed.
|
{% data variables.product.prodname_dotcom %}-hosted runners have npm and Yarn dependency managers installed. You can use npm and Yarn to install dependencies in your workflow before building and testing your code. The Windows and Linux {% data variables.product.prodname_dotcom %}-hosted runners also have Grunt, Gulp, and Bower installed.
|
||||||
|
|
||||||
{% if actions-caching %}You can also cache dependencies to speed up your workflow. For more information, see "[Caching dependencies to speed up workflows](/actions/using-workflows/caching-dependencies-to-speed-up-workflows)."{% endif %}
|
{% ifversion actions-caching %}You can also cache dependencies to speed up your workflow. For more information, see "[Caching dependencies to speed up workflows](/actions/using-workflows/caching-dependencies-to-speed-up-workflows)."{% endif %}
|
||||||
|
|
||||||
### Example using npm
|
### Example using npm
|
||||||
|
|
||||||
@@ -226,7 +226,7 @@ The example above creates an *.npmrc* file with the following contents:
|
|||||||
always-auth=true
|
always-auth=true
|
||||||
```
|
```
|
||||||
|
|
||||||
{% if actions-caching %}
|
{% ifversion actions-caching %}
|
||||||
|
|
||||||
### Example caching dependencies
|
### Example caching dependencies
|
||||||
|
|
||||||
|
|||||||
@@ -104,7 +104,7 @@ The table below describes the locations for various PowerShell modules in each {
|
|||||||
|
|
||||||
{% endnote %}
|
{% endnote %}
|
||||||
|
|
||||||
{% if actions-caching %}You can also cache dependencies to speed up your workflow. For more information, see "[Caching dependencies to speed up workflows](/actions/using-workflows/caching-dependencies-to-speed-up-workflows)."{% endif %}
|
{% ifversion actions-caching %}You can also cache dependencies to speed up your workflow. For more information, see "[Caching dependencies to speed up workflows](/actions/using-workflows/caching-dependencies-to-speed-up-workflows)."{% endif %}
|
||||||
|
|
||||||
For example, the following job installs the `SqlServer` and `PSScriptAnalyzer` modules:
|
For example, the following job installs the `SqlServer` and `PSScriptAnalyzer` modules:
|
||||||
|
|
||||||
@@ -128,7 +128,7 @@ jobs:
|
|||||||
|
|
||||||
{% endnote %}
|
{% endnote %}
|
||||||
|
|
||||||
{% if actions-caching %}
|
{% ifversion actions-caching %}
|
||||||
|
|
||||||
### Caching dependencies
|
### Caching dependencies
|
||||||
|
|
||||||
|
|||||||
@@ -112,7 +112,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
strategy:
|
strategy:
|
||||||
# You can use PyPy versions in python-version.
|
# You can use PyPy versions in python-version.
|
||||||
# For example, {% if actions-node16-action %}pypy-2.7 and pypy-3.8{% else %}pypy2 and pypy3{% endif %}
|
# For example, {% ifversion actions-node16-action %}pypy-2.7 and pypy-3.8{% else %}pypy2 and pypy3{% endif %}
|
||||||
matrix:
|
matrix:
|
||||||
python-version: ["2.7", "3.6", "3.7", "3.8", "3.9"]
|
python-version: ["2.7", "3.6", "3.7", "3.8", "3.9"]
|
||||||
|
|
||||||
@@ -173,7 +173,7 @@ jobs:
|
|||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
os: [ubuntu-latest, macos-latest, windows-latest]
|
os: [ubuntu-latest, macos-latest, windows-latest]
|
||||||
python-version: ["3.6", "3.7", "3.8", "3.9", {% if actions-node16-action %}pypy-2.7, pypy-3.8{% else %}pypy2, pypy3{% endif %}]
|
python-version: ["3.6", "3.7", "3.8", "3.9", {% ifversion actions-node16-action %}pypy-2.7, pypy-3.8{% else %}pypy2, pypy3{% endif %}]
|
||||||
exclude:
|
exclude:
|
||||||
- os: macos-latest
|
- os: macos-latest
|
||||||
python-version: "3.6"
|
python-version: "3.6"
|
||||||
@@ -195,7 +195,7 @@ We recommend using `setup-python` to configure the version of Python used in you
|
|||||||
|
|
||||||
{% data variables.product.prodname_dotcom %}-hosted runners have the pip package manager installed. You can use pip to install dependencies from the PyPI package registry before building and testing your code. For example, the YAML below installs or upgrades the `pip` package installer and the `setuptools` and `wheel` packages.
|
{% data variables.product.prodname_dotcom %}-hosted runners have the pip package manager installed. You can use pip to install dependencies from the PyPI package registry before building and testing your code. For example, the YAML below installs or upgrades the `pip` package installer and the `setuptools` and `wheel` packages.
|
||||||
|
|
||||||
{% if actions-caching %}You can also cache dependencies to speed up your workflow. For more information, see "[Caching dependencies to speed up workflows](/actions/using-workflows/caching-dependencies-to-speed-up-workflows)."{% endif %}
|
{% ifversion actions-caching %}You can also cache dependencies to speed up your workflow. For more information, see "[Caching dependencies to speed up workflows](/actions/using-workflows/caching-dependencies-to-speed-up-workflows)."{% endif %}
|
||||||
|
|
||||||
```yaml{:copy}
|
```yaml{:copy}
|
||||||
steps:
|
steps:
|
||||||
@@ -225,7 +225,7 @@ steps:
|
|||||||
pip install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
{% if actions-caching %}
|
{% ifversion actions-caching %}
|
||||||
|
|
||||||
### Caching Dependencies
|
### Caching Dependencies
|
||||||
|
|
||||||
|
|||||||
@@ -144,7 +144,7 @@ steps:
|
|||||||
- run: bundle install
|
- run: bundle install
|
||||||
```
|
```
|
||||||
|
|
||||||
{% if actions-caching %}
|
{% ifversion actions-caching %}
|
||||||
|
|
||||||
### Caching dependencies
|
### Caching dependencies
|
||||||
|
|
||||||
|
|||||||
@@ -26,7 +26,7 @@ topics:
|
|||||||
You can create actions by writing custom code that interacts with your repository in any way you'd like, including integrating with {% data variables.product.prodname_dotcom %}'s APIs and any publicly available third-party API. For example, an action can publish npm modules, send SMS alerts when urgent issues are created, or deploy production-ready code.
|
You can create actions by writing custom code that interacts with your repository in any way you'd like, including integrating with {% data variables.product.prodname_dotcom %}'s APIs and any publicly available third-party API. For example, an action can publish npm modules, send SMS alerts when urgent issues are created, or deploy production-ready code.
|
||||||
|
|
||||||
{% ifversion fpt or ghec %}
|
{% ifversion fpt or ghec %}
|
||||||
You can write your own actions to use in your workflow or share the actions you build with the {% data variables.product.prodname_dotcom %} community. To share actions you've built with everyone, your repository must be public. {% if internal-actions %}To share actions only within your enterprise, your repository must be internal.{% endif %}
|
You can write your own actions to use in your workflow or share the actions you build with the {% data variables.product.prodname_dotcom %} community. To share actions you've built with everyone, your repository must be public. {% ifversion internal-actions %}To share actions only within your enterprise, your repository must be internal.{% endif %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
Actions can run directly on a machine or in a Docker container. You can define an action's inputs, outputs, and environment variables.
|
Actions can run directly on a machine or in a Docker container. You can define an action's inputs, outputs, and environment variables.
|
||||||
|
|||||||
@@ -58,7 +58,7 @@ For more information about installing and using self-hosted runners, see "[Addin
|
|||||||
- Are customizable to your hardware, operating system, software, and security requirements.
|
- Are customizable to your hardware, operating system, software, and security requirements.
|
||||||
- Don't need to have a clean instance for every job execution.
|
- Don't need to have a clean instance for every job execution.
|
||||||
- Are free to use with {% data variables.product.prodname_actions %}, but you are responsible for the cost of maintaining your runner machines.{% ifversion ghec or ghes or ghae %}
|
- Are free to use with {% data variables.product.prodname_actions %}, but you are responsible for the cost of maintaining your runner machines.{% ifversion ghec or ghes or ghae %}
|
||||||
- Can be organized into groups to restrict access to specific {% if restrict-groups-to-workflows %}workflows, {% endif %}organizations and repositories. For more information, see "[Managing access to self-hosted runners using groups](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups)."{% endif %}
|
- Can be organized into groups to restrict access to specific {% ifversion restrict-groups-to-workflows %}workflows, {% endif %}organizations and repositories. For more information, see "[Managing access to self-hosted runners using groups](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups)."{% endif %}
|
||||||
|
|
||||||
## Requirements for self-hosted runner machines
|
## Requirements for self-hosted runner machines
|
||||||
|
|
||||||
|
|||||||
@@ -30,9 +30,9 @@ If you use {% data variables.product.prodname_ghe_cloud %}, you can create addit
|
|||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% ifversion ghec or ghes or ghae %}
|
{% ifversion ghec or ghes or ghae %}
|
||||||
Self-hosted runner groups are used to control access to self-hosted runners at the organization and enterprise level. Enterprise owners can configure access policies that control which organizations {% if restrict-groups-to-workflows %}and workflows {% endif %}in an enterprise have access to the runner group. Organization owners can configure access policies that control which repositories{% if restrict-groups-to-workflows %} and workflows{% endif %} in an organization have access to the runner group.
|
Self-hosted runner groups are used to control access to self-hosted runners at the organization and enterprise level. Enterprise owners can configure access policies that control which organizations {% ifversion restrict-groups-to-workflows %}and workflows {% endif %}in an enterprise have access to the runner group. Organization owners can configure access policies that control which repositories{% ifversion restrict-groups-to-workflows %} and workflows{% endif %} in an organization have access to the runner group.
|
||||||
|
|
||||||
When an enterprise owner grants an organization access to a runner group, organization owners can see the runner group listed in the organization's self-hosted runner settings. The organization owners can then assign additional granular repository{% if restrict-groups-to-workflows %} and workflow{% endif %} access policies to the enterprise runner group.
|
When an enterprise owner grants an organization access to a runner group, organization owners can see the runner group listed in the organization's self-hosted runner settings. The organization owners can then assign additional granular repository{% ifversion restrict-groups-to-workflows %} and workflow{% endif %} access policies to the enterprise runner group.
|
||||||
|
|
||||||
When new runners are created, they are automatically assigned to the default group. Runners can only be in one group at a time. You can move runners from the default group to another group. For more information, see "[Moving a self-hosted runner to a group](#moving-a-self-hosted-runner-to-a-group)."
|
When new runners are created, they are automatically assigned to the default group. Runners can only be in one group at a time. You can move runners from the default group to another group. For more information, see "[Moving a self-hosted runner to a group](#moving-a-self-hosted-runner-to-a-group)."
|
||||||
|
|
||||||
@@ -42,7 +42,7 @@ All organizations have a single default self-hosted runner group. Organizations
|
|||||||
|
|
||||||
Self-hosted runners are automatically assigned to the default group when created, and can only be members of one group at a time. You can move a runner from the default group to any group you create.
|
Self-hosted runners are automatically assigned to the default group when created, and can only be members of one group at a time. You can move a runner from the default group to any group you create.
|
||||||
|
|
||||||
When creating a group, you must choose a policy that defines which repositories{% if restrict-groups-to-workflows %} and workflows{% endif %} have access to the runner group.
|
When creating a group, you must choose a policy that defines which repositories{% ifversion restrict-groups-to-workflows %} and workflows{% endif %} have access to the runner group.
|
||||||
|
|
||||||
{% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %}
|
{% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %}
|
||||||
{% data reusables.organizations.navigate-to-org %}
|
{% data reusables.organizations.navigate-to-org %}
|
||||||
@@ -59,7 +59,7 @@ When creating a group, you must choose a policy that defines which repositories{
|
|||||||
For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)."
|
For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)."
|
||||||
|
|
||||||
{% endwarning %}
|
{% endwarning %}
|
||||||
{% data reusables.actions.runner-group-assign-policy-workflow %}{%- if restrict-groups-to-workflows %} Organization-owned runner groups cannot access workflows from a different organization in the enterprise; instead, you must create an enterprise-owned runner group.{% endif %}
|
{% data reusables.actions.runner-group-assign-policy-workflow %}{%- ifversion restrict-groups-to-workflows %} Organization-owned runner groups cannot access workflows from a different organization in the enterprise; instead, you must create an enterprise-owned runner group.{% endif %}
|
||||||
{% data reusables.actions.self-hosted-runner-create-group %}
|
{% data reusables.actions.self-hosted-runner-create-group %}
|
||||||
{% elsif ghae or ghes < 3.4 %}
|
{% elsif ghae or ghes < 3.4 %}
|
||||||
{% data reusables.organizations.navigate-to-org %}
|
{% data reusables.organizations.navigate-to-org %}
|
||||||
@@ -90,7 +90,7 @@ When creating a group, you must choose a policy that defines which repositories{
|
|||||||
|
|
||||||
## Creating a self-hosted runner group for an enterprise
|
## Creating a self-hosted runner group for an enterprise
|
||||||
|
|
||||||
Enterprises can add their self-hosted runners to groups for access management. Enterprises can create groups of self-hosted runners that are accessible to specific organizations in the enterprise account{% if restrict-groups-to-workflows %} or to specific workflows{% endif %}. Organization owners can then assign additional granular repository{% if restrict-groups-to-workflows %} or workflow{% endif %} access policies to the enterprise runner groups. For information about how to create a self-hosted runner group with the REST API, see the enterprise endpoints in the [{% data variables.product.prodname_actions %} REST API](/rest/reference/actions#self-hosted-runner-groups).
|
Enterprises can add their self-hosted runners to groups for access management. Enterprises can create groups of self-hosted runners that are accessible to specific organizations in the enterprise account{% ifversion restrict-groups-to-workflows %} or to specific workflows{% endif %}. Organization owners can then assign additional granular repository{% ifversion restrict-groups-to-workflows %} or workflow{% endif %} access policies to the enterprise runner groups. For information about how to create a self-hosted runner group with the REST API, see the enterprise endpoints in the [{% data variables.product.prodname_actions %} REST API](/rest/reference/actions#self-hosted-runner-groups).
|
||||||
|
|
||||||
Self-hosted runners are automatically assigned to the default group when created, and can only be members of one group at a time. You can assign the runner to a specific group during the registration process, or you can later move the runner from the default group to a custom group.
|
Self-hosted runners are automatically assigned to the default group when created, and can only be members of one group at a time. You can assign the runner to a specific group during the registration process, or you can later move the runner from the default group to a custom group.
|
||||||
|
|
||||||
@@ -124,7 +124,7 @@ When creating a group, you must choose a policy that defines which organizations
|
|||||||
|
|
||||||
## Changing the access policy of a self-hosted runner group
|
## Changing the access policy of a self-hosted runner group
|
||||||
|
|
||||||
For runner groups in an enterprise, you can change what organizations in the enterprise can access a runner group{% if restrict-groups-to-workflows %} or restrict what workflows a runner group can run{% endif %}. For runner groups in an organization, you can change what repositories in the organization can access a runner group{% if restrict-groups-to-workflows %} or restrict what workflows a runner group can run{% endif %}.
|
For runner groups in an enterprise, you can change what organizations in the enterprise can access a runner group{% ifversion restrict-groups-to-workflows %} or restrict what workflows a runner group can run{% endif %}. For runner groups in an organization, you can change what repositories in the organization can access a runner group{% ifversion restrict-groups-to-workflows %} or restrict what workflows a runner group can run{% endif %}.
|
||||||
|
|
||||||
### Changing what organizations or repositories can access a runner group
|
### Changing what organizations or repositories can access a runner group
|
||||||
|
|
||||||
@@ -148,7 +148,7 @@ For runner groups in an enterprise, you can change what organizations in the ent
|
|||||||
{% data reusables.actions.self-hosted-runner-configure-runner-group-access %}
|
{% data reusables.actions.self-hosted-runner-configure-runner-group-access %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if restrict-groups-to-workflows %}
|
{% ifversion restrict-groups-to-workflows %}
|
||||||
### Changing what workflows can access a runner group
|
### Changing what workflows can access a runner group
|
||||||
You can configure a self-hosted runner group to run either selected workflows or all workflows. For example, you might use this setting to protect secrets that are stored on self-hosted runners or to standardize deployment workflows by restricting a runner group to run only a specific reusable workflow. This setting cannot be overridden if you are configuring an organization's runner group that was shared by an enterprise.
|
You can configure a self-hosted runner group to run either selected workflows or all workflows. For example, you might use this setting to protect secrets that are stored on self-hosted runners or to standardize deployment workflows by restricting a runner group to run only a specific reusable workflow. This setting cannot be overridden if you are configuring an organization's runner group that was shared by an enterprise.
|
||||||
{% data reusables.actions.self-hosted-runner-groups-navigate-to-repo-org-enterprise %}
|
{% data reusables.actions.self-hosted-runner-groups-navigate-to-repo-org-enterprise %}
|
||||||
|
|||||||
@@ -465,7 +465,7 @@ The `runner` context contains information about the runner that is executing the
|
|||||||
|---------------|------|-------------|
|
|---------------|------|-------------|
|
||||||
| `runner` | `object` | This context changes for each job in a workflow run. This object contains all the properties listed below. |
|
| `runner` | `object` | This context changes for each job in a workflow run. This object contains all the properties listed below. |
|
||||||
| `runner.name` | `string` | {% data reusables.actions.runner-name-description %} |
|
| `runner.name` | `string` | {% data reusables.actions.runner-name-description %} |
|
||||||
| `runner.os` | `string` | {% data reusables.actions.runner-os-description %} |{% if actions-runner-arch-envvars %}
|
| `runner.os` | `string` | {% data reusables.actions.runner-os-description %} |{% ifversion actions-runner-arch-envvars %}
|
||||||
| `runner.arch` | `string` | {% data reusables.actions.runner-arch-description %} |{% endif %}
|
| `runner.arch` | `string` | {% data reusables.actions.runner-arch-description %} |{% endif %}
|
||||||
| `runner.temp` | `string` | {% data reusables.actions.runner-temp-directory-description %} |
|
| `runner.temp` | `string` | {% data reusables.actions.runner-temp-directory-description %} |
|
||||||
| `runner.tool_cache` | `string` | {% ifversion ghae %}{% data reusables.actions.self-hosted-runners-software %} {% else %} {% data reusables.actions.runner-tool-cache-description %} {% endif %}|
|
| `runner.tool_cache` | `string` | {% ifversion ghae %}{% data reusables.actions.self-hosted-runners-software %} {% else %} {% data reusables.actions.runner-tool-cache-description %} {% endif %}|
|
||||||
|
|||||||
@@ -157,12 +157,12 @@ We strongly recommend that actions use environment variables to access the files
|
|||||||
| `GITHUB_RUN_NUMBER` | {% data reusables.actions.run_number_description %} For example, `3`. |
|
| `GITHUB_RUN_NUMBER` | {% data reusables.actions.run_number_description %} For example, `3`. |
|
||||||
| `GITHUB_SERVER_URL`| The URL of the {% data variables.product.product_name %} server. For example: `https://{% data variables.product.product_url %}`.
|
| `GITHUB_SERVER_URL`| The URL of the {% data variables.product.product_name %} server. For example: `https://{% data variables.product.product_url %}`.
|
||||||
| `GITHUB_SHA` | The commit SHA that triggered the workflow. The value of this commit SHA depends on the event that triggered the workflow. For more information, see [Events that trigger workflows](/actions/using-workflows/events-that-trigger-workflows). For example, `ffac537e6cbbf934b08745a378932722df287a53`. |
|
| `GITHUB_SHA` | The commit SHA that triggered the workflow. The value of this commit SHA depends on the event that triggered the workflow. For more information, see [Events that trigger workflows](/actions/using-workflows/events-that-trigger-workflows). For example, `ffac537e6cbbf934b08745a378932722df287a53`. |
|
||||||
{%- if actions-job-summaries %}
|
{%- ifversion actions-job-summaries %}
|
||||||
| `GITHUB_STEP_SUMMARY` | The path on the runner to the file that contains job summaries from workflow commands. This file is unique to the current step and changes for each step in a job. For example, `/home/rob/runner/_layout/_work/_temp/_runner_file_commands/step_summary_1cb22d7f-5663-41a8-9ffc-13472605c76c`. For more information, see "[Workflow commands for {% data variables.product.prodname_actions %}](/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary)." |
|
| `GITHUB_STEP_SUMMARY` | The path on the runner to the file that contains job summaries from workflow commands. This file is unique to the current step and changes for each step in a job. For example, `/home/rob/runner/_layout/_work/_temp/_runner_file_commands/step_summary_1cb22d7f-5663-41a8-9ffc-13472605c76c`. For more information, see "[Workflow commands for {% data variables.product.prodname_actions %}](/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary)." |
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
| `GITHUB_WORKFLOW` | The name of the workflow. For example, `My test workflow`. If the workflow file doesn't specify a `name`, the value of this variable is the full path of the workflow file in the repository. |
|
| `GITHUB_WORKFLOW` | The name of the workflow. For example, `My test workflow`. If the workflow file doesn't specify a `name`, the value of this variable is the full path of the workflow file in the repository. |
|
||||||
| `GITHUB_WORKSPACE` | The default working directory on the runner for steps, and the default location of your repository when using the [`checkout`](https://github.com/actions/checkout) action. For example, `/home/runner/work/my-repo-name/my-repo-name`. |
|
| `GITHUB_WORKSPACE` | The default working directory on the runner for steps, and the default location of your repository when using the [`checkout`](https://github.com/actions/checkout) action. For example, `/home/runner/work/my-repo-name/my-repo-name`. |
|
||||||
{%- if actions-runner-arch-envvars %}
|
{%- ifversion actions-runner-arch-envvars %}
|
||||||
| `RUNNER_ARCH` | {% data reusables.actions.runner-arch-description %}
|
| `RUNNER_ARCH` | {% data reusables.actions.runner-arch-description %}
|
||||||
{%- endif %} |
|
{%- endif %} |
|
||||||
| `RUNNER_NAME` | {% data reusables.actions.runner-name-description %} For example, `Hosted Agent` |
|
| `RUNNER_NAME` | {% data reusables.actions.runner-name-description %} For example, `Hosted Agent` |
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ topics:
|
|||||||
|
|
||||||
The actions you use in your workflow can be defined in:
|
The actions you use in your workflow can be defined in:
|
||||||
|
|
||||||
- The same repository as your workflow file{% if internal-actions %}
|
- The same repository as your workflow file{% ifversion internal-actions %}
|
||||||
- An internal repository within the same enterprise account that is configured to allow access to workflows{% endif %}
|
- An internal repository within the same enterprise account that is configured to allow access to workflows{% endif %}
|
||||||
- Any public repository
|
- Any public repository
|
||||||
- A published Docker container image on Docker Hub
|
- A published Docker container image on Docker Hub
|
||||||
@@ -110,7 +110,7 @@ The `action.yml` file is used to provide metadata for the action. Learn about th
|
|||||||
|
|
||||||
If an action is defined in a different repository than your workflow file, you can reference the action with the `{owner}/{repo}@{ref}` syntax in your workflow file.
|
If an action is defined in a different repository than your workflow file, you can reference the action with the `{owner}/{repo}@{ref}` syntax in your workflow file.
|
||||||
|
|
||||||
The action must be stored in a public repository{% if internal-actions %} or an internal repository that is configured to allow access to workflows. For more information, see "[Sharing actions and workflows with your enterprise](/actions/creating-actions/sharing-actions-and-workflows-with-your-enterprise)."{% else %}.{% endif %}
|
The action must be stored in a public repository{% ifversion internal-actions %} or an internal repository that is configured to allow access to workflows. For more information, see "[Sharing actions and workflows with your enterprise](/actions/creating-actions/sharing-actions-and-workflows-with-your-enterprise)."{% else %}.{% endif %}
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
jobs:
|
jobs:
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Re-running workflows and jobs
|
title: Re-running workflows and jobs
|
||||||
intro: You can re-run a workflow run{% if re-run-jobs %}, all failed jobs in a workflow run, or specific jobs in a workflow run{% endif %} up to 30 days after its initial run.
|
intro: You can re-run a workflow run{% ifversion re-run-jobs %}, all failed jobs in a workflow run, or specific jobs in a workflow run{% endif %} up to 30 days after its initial run.
|
||||||
permissions: People with write permissions to a repository can re-run workflows in the repository.
|
permissions: People with write permissions to a repository can re-run workflows in the repository.
|
||||||
miniTocMaxHeadingLevel: 3
|
miniTocMaxHeadingLevel: 3
|
||||||
redirect_from:
|
redirect_from:
|
||||||
@@ -17,7 +17,7 @@ versions:
|
|||||||
|
|
||||||
## About re-running workflows and jobs
|
## About re-running workflows and jobs
|
||||||
|
|
||||||
Re-running a workflow{% if re-run-jobs %} or jobs in a workflow{% endif %} uses the same `GITHUB_SHA` (commit SHA) and `GITHUB_REF` (Git ref) of the original event that triggered the workflow run. You can re-run a workflow{% if re-run-jobs %} or jobs in a workflow{% endif %} for up to 30 days after the initial run.{% if debug-reruns %} When you re-run a workflow or jobs in a workflow, you can enable debug logging for the re-run. This will enable runner diagnostic logging and step debug logging for the re-run. For more information about debug logging, see "[Enabling debug logging](/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging)."{% endif %}
|
Re-running a workflow{% ifversion re-run-jobs %} or jobs in a workflow{% endif %} uses the same `GITHUB_SHA` (commit SHA) and `GITHUB_REF` (Git ref) of the original event that triggered the workflow run. You can re-run a workflow{% ifversion re-run-jobs %} or jobs in a workflow{% endif %} for up to 30 days after the initial run.{% ifversion debug-reruns %} When you re-run a workflow or jobs in a workflow, you can enable debug logging for the re-run. This will enable runner diagnostic logging and step debug logging for the re-run. For more information about debug logging, see "[Enabling debug logging](/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging)."{% endif %}
|
||||||
|
|
||||||
## Re-running all the jobs in a workflow
|
## Re-running all the jobs in a workflow
|
||||||
|
|
||||||
@@ -51,7 +51,7 @@ To re-run a failed workflow run, use the `run rerun` subcommand. Replace `run-id
|
|||||||
gh run rerun <em>run-id</em>
|
gh run rerun <em>run-id</em>
|
||||||
```
|
```
|
||||||
|
|
||||||
{% if debug-reruns %}
|
{% ifversion debug-reruns %}
|
||||||
{% data reusables.actions.enable-debug-logging-cli %}
|
{% data reusables.actions.enable-debug-logging-cli %}
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
@@ -68,7 +68,7 @@ gh run watch
|
|||||||
|
|
||||||
{% endcli %}
|
{% endcli %}
|
||||||
|
|
||||||
{% if re-run-jobs %}
|
{% ifversion re-run-jobs %}
|
||||||
## Re-running failed jobs in a workflow
|
## Re-running failed jobs in a workflow
|
||||||
|
|
||||||
If any jobs in a workflow run failed, you can re-run just the jobs that failed. When you re-run failed jobs in a workflow, a new workflow run will start for all failed jobs and their dependents. Any outputs for any successful jobs in the previous workflow run will be used for the re-run. Any artifacts that were created in the initial run will be available in the re-run. Any environment protection rules that passed in the previous run will automatically pass in the re-run.
|
If any jobs in a workflow run failed, you can re-run just the jobs that failed. When you re-run failed jobs in a workflow, a new workflow run will start for all failed jobs and their dependents. Any outputs for any successful jobs in the previous workflow run will be used for the re-run. Any artifacts that were created in the initial run will be available in the re-run. Any environment protection rules that passed in the previous run will automatically pass in the re-run.
|
||||||
@@ -93,7 +93,7 @@ To re-run failed jobs in a workflow run, use the `run rerun` subcommand with the
|
|||||||
gh run rerun <em>run-id</em> --failed
|
gh run rerun <em>run-id</em> --failed
|
||||||
```
|
```
|
||||||
|
|
||||||
{% if debug-reruns %}
|
{% ifversion debug-reruns %}
|
||||||
{% data reusables.actions.enable-debug-logging-cli %}
|
{% data reusables.actions.enable-debug-logging-cli %}
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
@@ -130,7 +130,7 @@ To re-run a specific job in a workflow run, use the `run rerun` subcommand with
|
|||||||
gh run rerun --job <em>job-id</em>
|
gh run rerun --job <em>job-id</em>
|
||||||
```
|
```
|
||||||
|
|
||||||
{% if debug-reruns %}
|
{% ifversion debug-reruns %}
|
||||||
{% data reusables.actions.enable-debug-logging-cli %}
|
{% data reusables.actions.enable-debug-logging-cli %}
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
@@ -151,7 +151,7 @@ You can view the results from your previous attempts at running a workflow. You
|
|||||||
{% data reusables.repositories.actions-tab %}
|
{% data reusables.repositories.actions-tab %}
|
||||||
{% data reusables.repositories.navigate-to-workflow %}
|
{% data reusables.repositories.navigate-to-workflow %}
|
||||||
{% data reusables.repositories.view-run %}
|
{% data reusables.repositories.view-run %}
|
||||||
{%- if re-run-jobs %}
|
{%- ifversion re-run-jobs %}
|
||||||
1. Any previous run attempts are shown in the **Latest** drop-down menu.
|
1. Any previous run attempts are shown in the **Latest** drop-down menu.
|
||||||

|

|
||||||
{%- else %}
|
{%- else %}
|
||||||
|
|||||||
@@ -81,7 +81,7 @@ For more information, see "[Using environment variables](/actions/configuring-an
|
|||||||
|
|
||||||
CircleCI and {% data variables.product.prodname_actions %} provide a method to manually cache files in the configuration file.
|
CircleCI and {% data variables.product.prodname_actions %} provide a method to manually cache files in the configuration file.
|
||||||
|
|
||||||
{% if actions-caching %}
|
{% ifversion actions-caching %}
|
||||||
|
|
||||||
Below is an example of the syntax for each system.
|
Below is an example of the syntax for each system.
|
||||||
|
|
||||||
|
|||||||
@@ -309,7 +309,7 @@ For more information, see "[Environment variables](/actions/reference/environmen
|
|||||||
|
|
||||||
GitLab CI/CD and {% data variables.product.prodname_actions %} provide a method in the configuration file to manually cache workflow files.
|
GitLab CI/CD and {% data variables.product.prodname_actions %} provide a method in the configuration file to manually cache workflow files.
|
||||||
|
|
||||||
{% if actions-caching %}
|
{% ifversion actions-caching %}
|
||||||
|
|
||||||
Below is an example of the syntax for each system:
|
Below is an example of the syntax for each system:
|
||||||
|
|
||||||
|
|||||||
@@ -306,7 +306,7 @@ jobs:
|
|||||||
|
|
||||||
Travis CI and {% data variables.product.prodname_actions %} let you manually cache dependencies for later reuse.
|
Travis CI and {% data variables.product.prodname_actions %} let you manually cache dependencies for later reuse.
|
||||||
|
|
||||||
{% if actions-caching %}
|
{% ifversion actions-caching %}
|
||||||
|
|
||||||
This example demonstrates the cache syntax for each system.
|
This example demonstrates the cache syntax for each system.
|
||||||
|
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ miniTocMaxHeadingLevel: 3
|
|||||||
|
|
||||||
## Monitoring your workflows
|
## Monitoring your workflows
|
||||||
|
|
||||||
{% if github-runner-dashboard %}
|
{% ifversion github-runner-dashboard %}
|
||||||
### Monitoring your current jobs in your organization or enterprise
|
### Monitoring your current jobs in your organization or enterprise
|
||||||
|
|
||||||
{% data reusables.actions.github-hosted-runners-check-concurrency %}
|
{% data reusables.actions.github-hosted-runners-check-concurrency %}
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ These extra logs are enabled by setting secrets in the repository containing the
|
|||||||
|
|
||||||
For more information on setting secrets, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)."
|
For more information on setting secrets, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)."
|
||||||
|
|
||||||
{% if debug-reruns %}
|
{% ifversion debug-reruns %}
|
||||||
|
|
||||||
Additionally, anyone who has access to run a workflow can enable runner diagnostic logging and step debug logging for a workflow re-run. For more information, see "[Re-running workflows and jobs](/actions/managing-workflow-runs/re-running-workflows-and-jobs)."
|
Additionally, anyone who has access to run a workflow can enable runner diagnostic logging and step debug logging for a workflow re-run. For more information, see "[Re-running workflows and jobs](/actions/managing-workflow-runs/re-running-workflows-and-jobs)."
|
||||||
|
|
||||||
|
|||||||
@@ -63,7 +63,7 @@ You can download the log files from your workflow run. You can also download a w
|
|||||||

|

|
||||||
|
|
||||||
|
|
||||||
{% if re-run-jobs %}
|
{% ifversion re-run-jobs %}
|
||||||
|
|
||||||
{% note %}
|
{% note %}
|
||||||
|
|
||||||
|
|||||||
@@ -195,18 +195,18 @@ You can help mitigate this risk by following these good practices:
|
|||||||
The same principles described above for using third-party actions also apply to using third-party workflows. You can help mitigate the risks associated with reusing workflows by following the same good practices outlined above. For more information, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)."
|
The same principles described above for using third-party actions also apply to using third-party workflows. You can help mitigate the risks associated with reusing workflows by following the same good practices outlined above. For more information, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)."
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if internal-actions %}
|
{% ifversion internal-actions %}
|
||||||
## Allowing workflows to access internal repositories
|
## Allowing workflows to access internal repositories
|
||||||
|
|
||||||
{% data reusables.actions.outside-collaborators-internal-actions %} For more information, see "[Sharing actions and workflows with your enterprise](/actions/creating-actions/sharing-actions-and-workflows-with-your-enterprise)."
|
{% data reusables.actions.outside-collaborators-internal-actions %} For more information, see "[Sharing actions and workflows with your enterprise](/actions/creating-actions/sharing-actions-and-workflows-with-your-enterprise)."
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if allow-actions-to-approve-pr %}
|
{% ifversion allow-actions-to-approve-pr %}
|
||||||
## Preventing {% data variables.product.prodname_actions %} from {% if allow-actions-to-approve-pr-with-ent-repo %}creating or {% endif %}approving pull requests
|
## Preventing {% data variables.product.prodname_actions %} from {% ifversion allow-actions-to-approve-pr-with-ent-repo %}creating or {% endif %}approving pull requests
|
||||||
|
|
||||||
{% data reusables.actions.workflow-pr-approval-permissions-intro %} Allowing workflows, or any other automation, to {% if allow-actions-to-approve-pr-with-ent-repo %}create or {% endif %}approve pull requests could be a security risk if the pull request is merged without proper oversight.
|
{% data reusables.actions.workflow-pr-approval-permissions-intro %} Allowing workflows, or any other automation, to {% ifversion allow-actions-to-approve-pr-with-ent-repo %}create or {% endif %}approve pull requests could be a security risk if the pull request is merged without proper oversight.
|
||||||
|
|
||||||
For more information on how to configure this setting, see {% if allow-actions-to-approve-pr-with-ent-repo %}{% ifversion ghes or ghec or ghae %}"[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#preventing-github-actions-from-creating-or-approving-pull-requests)",{% endif %}{% endif %} "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization#preventing-github-actions-from-{% if allow-actions-to-approve-pr-with-ent-repo %}creating-or-{% endif %}approving-pull-requests)"{% if allow-actions-to-approve-pr-with-ent-repo %}, and "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#preventing-github-actions-from-creating-or-approving-pull-requests)"{% endif %}.
|
For more information on how to configure this setting, see {% ifversion allow-actions-to-approve-pr-with-ent-repo %}{% ifversion ghes or ghec or ghae %}"[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#preventing-github-actions-from-creating-or-approving-pull-requests)",{% endif %}{% endif %} "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization#preventing-github-actions-from-{% ifversion allow-actions-to-approve-pr-with-ent-repo %}creating-or-{% endif %}approving-pull-requests)"{% ifversion allow-actions-to-approve-pr-with-ent-repo %}, and "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#preventing-github-actions-from-creating-or-approving-pull-requests)"{% endif %}.
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
## Using OpenSSF Scorecards to secure workflows
|
## Using OpenSSF Scorecards to secure workflows
|
||||||
@@ -279,7 +279,7 @@ This list describes the recommended approaches for accessing repository data wit
|
|||||||
|
|
||||||
{% ifversion fpt or ghec %}As a result, self-hosted runners should almost [never be used for public repositories](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories) on {% data variables.product.product_name %}, because any user can open pull requests against the repository and compromise the environment. Similarly, be{% elsif ghes or ghae %}Be{% endif %} cautious when using self-hosted runners on private or internal repositories, as anyone who can fork the repository and open a pull request (generally those with read access to the repository) are able to compromise the self-hosted runner environment, including gaining access to secrets and the `GITHUB_TOKEN` which{% ifversion fpt or ghes > 3.1 or ghae or ghec %}, depending on its settings, can grant {% else %} grants {% endif %}write access to the repository. Although workflows can control access to environment secrets by using environments and required reviews, these workflows are not run in an isolated environment and are still susceptible to the same risks when run on a self-hosted runner.
|
{% ifversion fpt or ghec %}As a result, self-hosted runners should almost [never be used for public repositories](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories) on {% data variables.product.product_name %}, because any user can open pull requests against the repository and compromise the environment. Similarly, be{% elsif ghes or ghae %}Be{% endif %} cautious when using self-hosted runners on private or internal repositories, as anyone who can fork the repository and open a pull request (generally those with read access to the repository) are able to compromise the self-hosted runner environment, including gaining access to secrets and the `GITHUB_TOKEN` which{% ifversion fpt or ghes > 3.1 or ghae or ghec %}, depending on its settings, can grant {% else %} grants {% endif %}write access to the repository. Although workflows can control access to environment secrets by using environments and required reviews, these workflows are not run in an isolated environment and are still susceptible to the same risks when run on a self-hosted runner.
|
||||||
|
|
||||||
When a self-hosted runner is defined at the organization or enterprise level, {% data variables.product.product_name %} can schedule workflows from multiple repositories onto the same runner. Consequently, a security compromise of these environments can result in a wide impact. To help reduce the scope of a compromise, you can create boundaries by organizing your self-hosted runners into separate groups. You can restrict what {% if restrict-groups-to-workflows %}workflows, {% endif %}organizations and repositories can access runner groups. For more information, see "[Managing access to self-hosted runners using groups](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups)."
|
When a self-hosted runner is defined at the organization or enterprise level, {% data variables.product.product_name %} can schedule workflows from multiple repositories onto the same runner. Consequently, a security compromise of these environments can result in a wide impact. To help reduce the scope of a compromise, you can create boundaries by organizing your self-hosted runners into separate groups. You can restrict what {% ifversion restrict-groups-to-workflows %}workflows, {% endif %}organizations and repositories can access runner groups. For more information, see "[Managing access to self-hosted runners using groups](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups)."
|
||||||
|
|
||||||
You should also consider the environment of the self-hosted runner machines:
|
You should also consider the environment of the self-hosted runner machines:
|
||||||
- What sensitive information resides on the machine configured as a self-hosted runner? For example, private SSH keys, API access tokens, among others.
|
- What sensitive information resides on the machine configured as a self-hosted runner? For example, private SSH keys, API access tokens, among others.
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ miniTocMaxHeadingLevel: 4
|
|||||||
|
|
||||||
{% data reusables.actions.jobs.section-using-concurrency-jobs %}
|
{% data reusables.actions.jobs.section-using-concurrency-jobs %}
|
||||||
|
|
||||||
{% if github-runner-dashboard %}
|
{% ifversion github-runner-dashboard %}
|
||||||
## Monitoring your current jobs in your organization or enterprise
|
## Monitoring your current jobs in your organization or enterprise
|
||||||
|
|
||||||
{% data reusables.actions.github-hosted-runners-check-concurrency %}
|
{% data reusables.actions.github-hosted-runners-check-concurrency %}
|
||||||
|
|||||||
@@ -124,7 +124,7 @@ jobs:
|
|||||||
|
|
||||||
For more information, see "[Using a matrix for your jobs](/actions/using-jobs/using-a-matrix-for-your-jobs)."
|
For more information, see "[Using a matrix for your jobs](/actions/using-jobs/using-a-matrix-for-your-jobs)."
|
||||||
|
|
||||||
{% if actions-caching %}
|
{% ifversion actions-caching %}
|
||||||
### Caching dependencies
|
### Caching dependencies
|
||||||
|
|
||||||
If your jobs regularly reuse dependencies, you can consider caching these files to help improve performance. Once the cache is created, it is available to all workflows in the same repository.
|
If your jobs regularly reuse dependencies, you can consider caching these files to help improve performance. Once the cache is created, it is available to all workflows in the same repository.
|
||||||
|
|||||||
@@ -257,15 +257,15 @@ For example, if a pull request contains a `feature` branch and targets the defau
|
|||||||
|
|
||||||
## Usage limits and eviction policy
|
## Usage limits and eviction policy
|
||||||
|
|
||||||
{% data variables.product.prodname_dotcom %} will remove any cache entries that have not been accessed in over 7 days. There is no limit on the number of caches you can store, but the total size of all caches in a repository is limited{% if actions-cache-policy-apis %}. By default, the limit is 10 GB per repository, but this limit might be different depending on policies set by your enterprise owners or repository administrators.{% else %} to 10 GB.{% endif %}
|
{% data variables.product.prodname_dotcom %} will remove any cache entries that have not been accessed in over 7 days. There is no limit on the number of caches you can store, but the total size of all caches in a repository is limited{% ifversion actions-cache-policy-apis %}. By default, the limit is 10 GB per repository, but this limit might be different depending on policies set by your enterprise owners or repository administrators.{% else %} to 10 GB.{% endif %}
|
||||||
|
|
||||||
{% data reusables.actions.cache-eviction-process %}
|
{% data reusables.actions.cache-eviction-process %}
|
||||||
|
|
||||||
{% if actions-cache-policy-apis %}
|
{% ifversion actions-cache-policy-apis %}
|
||||||
For information on changing the policies for the repository cache size limit, see "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-cache-storage-in-your-enterprise)" and "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-cache-storage-for-a-repository)."
|
For information on changing the policies for the repository cache size limit, see "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-cache-storage-in-your-enterprise)" and "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-cache-storage-for-a-repository)."
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if actions-cache-management %}
|
{% ifversion actions-cache-management %}
|
||||||
|
|
||||||
## Managing caches
|
## Managing caches
|
||||||
|
|
||||||
|
|||||||
@@ -48,8 +48,8 @@ For more information, see "[Creating starter workflows for your organization](/a
|
|||||||
A reusable workflow can be used by another workflow if {% ifversion ghes or ghec or ghae %}any{% else %}either{% endif %} of the following is true:
|
A reusable workflow can be used by another workflow if {% ifversion ghes or ghec or ghae %}any{% else %}either{% endif %} of the following is true:
|
||||||
|
|
||||||
* Both workflows are in the same repository.
|
* Both workflows are in the same repository.
|
||||||
* The called workflow is stored in a public repository{% if actions-workflow-policy %}, and your {% ifversion ghec %}enterprise{% else %}organization{% endif %} allows you to use public reusable workflows{% endif %}.{% ifversion ghes or ghec or ghae %}
|
* The called workflow is stored in a public repository{% ifversion actions-workflow-policy %}, and your {% ifversion ghec %}enterprise{% else %}organization{% endif %} allows you to use public reusable workflows{% endif %}.{% ifversion ghes or ghec or ghae %}
|
||||||
* The called workflow is stored in an internal repository and the settings for that repository allow it to be accessed. For more information, see {% if internal-actions %}"[Sharing actions and workflows with your enterprise](/actions/creating-actions/sharing-actions-and-workflows-with-your-enterprise){% else %}"[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository){% endif %}."{% endif %}
|
* The called workflow is stored in an internal repository and the settings for that repository allow it to be accessed. For more information, see {% ifversion internal-actions %}"[Sharing actions and workflows with your enterprise](/actions/creating-actions/sharing-actions-and-workflows-with-your-enterprise){% else %}"[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository){% endif %}."{% endif %}
|
||||||
|
|
||||||
## Using runners
|
## Using runners
|
||||||
|
|
||||||
@@ -104,7 +104,7 @@ You can define inputs and secrets, which can be passed from the caller workflow
|
|||||||
```
|
```
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
For details of the syntax for defining inputs and secrets, see [`on.workflow_call.inputs`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callinputs) and [`on.workflow_call.secrets`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callsecrets).
|
For details of the syntax for defining inputs and secrets, see [`on.workflow_call.inputs`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callinputs) and [`on.workflow_call.secrets`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callsecrets).
|
||||||
{% if actions-inherit-secrets-reusable-workflows %}
|
{% ifversion actions-inherit-secrets-reusable-workflows %}
|
||||||
1. In the reusable workflow, reference the input or secret that you defined in the `on` key in the previous step. If the secrets are inherited using `secrets: inherit`, you can reference them even if they are not defined in the `on` key.
|
1. In the reusable workflow, reference the input or secret that you defined in the `on` key in the previous step. If the secrets are inherited using `secrets: inherit`, you can reference them even if they are not defined in the `on` key.
|
||||||
{%- else %}
|
{%- else %}
|
||||||
1. In the reusable workflow, reference the input or secret that you defined in the `on` key in the previous step.
|
1. In the reusable workflow, reference the input or secret that you defined in the `on` key in the previous step.
|
||||||
@@ -193,7 +193,7 @@ When you call a reusable workflow, you can only use the following keywords in th
|
|||||||
* [`jobs.<job_id>.with.<input_id>`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idwithinput_id)
|
* [`jobs.<job_id>.with.<input_id>`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idwithinput_id)
|
||||||
* [`jobs.<job_id>.secrets`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idsecrets)
|
* [`jobs.<job_id>.secrets`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idsecrets)
|
||||||
* [`jobs.<job_id>.secrets.<secret_id>`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idsecretssecret_id)
|
* [`jobs.<job_id>.secrets.<secret_id>`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idsecretssecret_id)
|
||||||
{% if actions-inherit-secrets-reusable-workflows %}* [`jobs.<job_id>.secrets.inherit`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idsecretsinherit){% endif %}
|
{% ifversion actions-inherit-secrets-reusable-workflows %}* [`jobs.<job_id>.secrets.inherit`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idsecretsinherit){% endif %}
|
||||||
* [`jobs.<job_id>.needs`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idneeds)
|
* [`jobs.<job_id>.needs`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idneeds)
|
||||||
* [`jobs.<job_id>.if`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idif)
|
* [`jobs.<job_id>.if`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idif)
|
||||||
* [`jobs.<job_id>.permissions`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idpermissions)
|
* [`jobs.<job_id>.permissions`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idpermissions)
|
||||||
@@ -314,4 +314,4 @@ For information about using the REST API to query the audit log for an organizat
|
|||||||
|
|
||||||
To continue learning about {% data variables.product.prodname_actions %}, see "[Events that trigger workflows](/actions/learn-github-actions/events-that-trigger-workflows)."
|
To continue learning about {% data variables.product.prodname_actions %}, see "[Events that trigger workflows](/actions/learn-github-actions/events-that-trigger-workflows)."
|
||||||
|
|
||||||
{% if restrict-groups-to-workflows %}You can standardize deployments by creating a self-hosted runner group that can only execute a specific reusable workflow. For more information, see "[Managing access to self-hosted runners using groups](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups)."{% endif %}
|
{% ifversion restrict-groups-to-workflows %}You can standardize deployments by creating a self-hosted runner group that can only execute a specific reusable workflow. For more information, see "[Managing access to self-hosted runners using groups](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups)."{% endif %}
|
||||||
|
|||||||
@@ -20,15 +20,15 @@ type: how_to
|
|||||||
|
|
||||||
If you need to share workflows and other {% data variables.product.prodname_actions %} features with your team, then consider collaborating within a {% data variables.product.prodname_dotcom %} organization. An organization allows you to centrally store and manage secrets, artifacts, and self-hosted runners. You can also create starter workflows in the `.github` repository and share them with other users in your organization.
|
If you need to share workflows and other {% data variables.product.prodname_actions %} features with your team, then consider collaborating within a {% data variables.product.prodname_dotcom %} organization. An organization allows you to centrally store and manage secrets, artifacts, and self-hosted runners. You can also create starter workflows in the `.github` repository and share them with other users in your organization.
|
||||||
|
|
||||||
## Sharing {% if internal-actions %}actions and {% endif %}workflows
|
## Sharing {% ifversion internal-actions %}actions and {% endif %}workflows
|
||||||
|
|
||||||
{% if internal-actions %}
|
{% ifversion internal-actions %}
|
||||||
You can share both individual actions and entire workflows with your organization, with or without publishing the actions or workflows publicly. You can reuse actions and workflows exactly by referencing them in your workflow file, and you can create starter workflows that provide templates for new workflows.
|
You can share both individual actions and entire workflows with your organization, with or without publishing the actions or workflows publicly. You can reuse actions and workflows exactly by referencing them in your workflow file, and you can create starter workflows that provide templates for new workflows.
|
||||||
{% else %}
|
{% else %}
|
||||||
Your organization can share workflows by reusing the workflows exactly or by creating starter workflows that provide templates for new workflows.
|
Your organization can share workflows by reusing the workflows exactly or by creating starter workflows that provide templates for new workflows.
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if internal-actions %}
|
{% ifversion internal-actions %}
|
||||||
### Sharing actions with your enterprise
|
### Sharing actions with your enterprise
|
||||||
|
|
||||||
{% data reusables.actions.internal-actions-summary %}
|
{% data reusables.actions.internal-actions-summary %}
|
||||||
|
|||||||
@@ -56,7 +56,7 @@ To share data between jobs:
|
|||||||
|
|
||||||
The steps of a job share the same environment on the runner machine, but run in their own individual processes. To pass data between steps in a job, you can use inputs and outputs. For more information about inputs and outputs, see "[Metadata syntax for {% data variables.product.prodname_actions %}](/articles/metadata-syntax-for-github-actions)."
|
The steps of a job share the same environment on the runner machine, but run in their own individual processes. To pass data between steps in a job, you can use inputs and outputs. For more information about inputs and outputs, see "[Metadata syntax for {% data variables.product.prodname_actions %}](/articles/metadata-syntax-for-github-actions)."
|
||||||
|
|
||||||
{% if actions-caching %}
|
{% ifversion actions-caching %}
|
||||||
|
|
||||||
{% data reusables.actions.comparing-artifacts-caching %}
|
{% data reusables.actions.comparing-artifacts-caching %}
|
||||||
|
|
||||||
|
|||||||
@@ -26,7 +26,7 @@ topics:
|
|||||||
|
|
||||||
## About starter workflows
|
## About starter workflows
|
||||||
|
|
||||||
{% data variables.product.product_name %} offers starter workflows for a variety of languages and tooling. When you set up workflows in your repository, {% data variables.product.product_name %} analyzes the code in your repository and recommends workflows based on the language and framework in your repository. For example, if you use [Node.js](https://nodejs.org/en/), {% data variables.product.product_name %} will suggest a starter workflow file that installs your Node.js packages and runs your tests.{% if actions-starter-template-ui %} You can search and filter to find relevant starter workflows.{% endif %}
|
{% data variables.product.product_name %} offers starter workflows for a variety of languages and tooling. When you set up workflows in your repository, {% data variables.product.product_name %} analyzes the code in your repository and recommends workflows based on the language and framework in your repository. For example, if you use [Node.js](https://nodejs.org/en/), {% data variables.product.product_name %} will suggest a starter workflow file that installs your Node.js packages and runs your tests.{% ifversion actions-starter-template-ui %} You can search and filter to find relevant starter workflows.{% endif %}
|
||||||
|
|
||||||
{% data reusables.actions.starter-workflow-categories %}
|
{% data reusables.actions.starter-workflow-categories %}
|
||||||
|
|
||||||
@@ -39,9 +39,9 @@ Anyone with write permission to a repository can set up {% data variables.produc
|
|||||||
{% data reusables.repositories.navigate-to-repo %}
|
{% data reusables.repositories.navigate-to-repo %}
|
||||||
{% data reusables.repositories.actions-tab %}
|
{% data reusables.repositories.actions-tab %}
|
||||||
1. If you already have a workflow in your repository, click **New workflow**.
|
1. If you already have a workflow in your repository, click **New workflow**.
|
||||||
1. The "{% if actions-starter-template-ui %}Choose a workflow{% else %}Choose a workflow template{% endif %}" page shows a selection of recommended starter workflows. Find the starter workflow that you want to use, then click {% if actions-starter-template-ui %}**Configure**{% else %}**Set up this workflow**{% endif %}.{% if actions-starter-template-ui %} To help you find the starter workflow that you want, you can search for keywords or filter by category.{% endif %}
|
1. The "{% ifversion actions-starter-template-ui %}Choose a workflow{% else %}Choose a workflow template{% endif %}" page shows a selection of recommended starter workflows. Find the starter workflow that you want to use, then click {% ifversion actions-starter-template-ui %}**Configure**{% else %}**Set up this workflow**{% endif %}.{% ifversion actions-starter-template-ui %} To help you find the starter workflow that you want, you can search for keywords or filter by category.{% endif %}
|
||||||
|
|
||||||
{% if actions-starter-template-ui %}{% else %}{% endif %}
|
{% ifversion actions-starter-template-ui %}{% else %}{% endif %}
|
||||||
1. If the starter workflow contains comments detailing additional setup steps, follow these steps. Many of the starter workflow have corresponding guides. For more information, see the [{% data variables.product.prodname_actions %} guides](/actions/guides).
|
1. If the starter workflow contains comments detailing additional setup steps, follow these steps. Many of the starter workflow have corresponding guides. For more information, see the [{% data variables.product.prodname_actions %} guides](/actions/guides).
|
||||||
1. Some starter workflows use secrets. For example, {% raw %}`${{ secrets.npm_token }}`{% endraw %}. If the starter workflow uses a secret, store the value described in the secret name as a secret in your repository. For more information, see "[Encrypted secrets](/actions/reference/encrypted-secrets)."
|
1. Some starter workflows use secrets. For example, {% raw %}`${{ secrets.npm_token }}`{% endraw %}. If the starter workflow uses a secret, store the value described in the secret name as a secret in your repository. For more information, see "[Encrypted secrets](/actions/reference/encrypted-secrets)."
|
||||||
1. Optionally, make additional changes. For example, you might want to change the value of `on` to change when the workflow runs.
|
1. Optionally, make additional changes. For example, you might want to change the value of `on` to change when the workflow runs.
|
||||||
|
|||||||
@@ -110,7 +110,7 @@ The following table shows which toolkit functions are available within a workflo
|
|||||||
| `core.getInput` | Accessible using environment variable `INPUT_{NAME}` |
|
| `core.getInput` | Accessible using environment variable `INPUT_{NAME}` |
|
||||||
| `core.getState` | Accessible using environment variable `STATE_{NAME}` |
|
| `core.getState` | Accessible using environment variable `STATE_{NAME}` |
|
||||||
| `core.isDebug` | Accessible using environment variable `RUNNER_DEBUG` |
|
| `core.isDebug` | Accessible using environment variable `RUNNER_DEBUG` |
|
||||||
{%- if actions-job-summaries %}
|
{%- ifversion actions-job-summaries %}
|
||||||
| `core.summary` | Accessible using environment variable `GITHUB_STEP_SUMMARY` |
|
| `core.summary` | Accessible using environment variable `GITHUB_STEP_SUMMARY` |
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
| `core.saveState` | `save-state` |
|
| `core.saveState` | `save-state` |
|
||||||
@@ -661,7 +661,7 @@ steps:
|
|||||||
|
|
||||||
{% endpowershell %}
|
{% endpowershell %}
|
||||||
|
|
||||||
{% if actions-job-summaries %}
|
{% ifversion actions-job-summaries %}
|
||||||
|
|
||||||
## Adding a job summary
|
## Adding a job summary
|
||||||
|
|
||||||
|
|||||||
@@ -992,7 +992,7 @@ jobs:
|
|||||||
```
|
```
|
||||||
{% endraw %}
|
{% endraw %}
|
||||||
|
|
||||||
{% if actions-inherit-secrets-reusable-workflows %}
|
{% ifversion actions-inherit-secrets-reusable-workflows %}
|
||||||
|
|
||||||
### `jobs.<job_id>.secrets.inherit`
|
### `jobs.<job_id>.secrets.inherit`
|
||||||
|
|
||||||
|
|||||||
@@ -76,7 +76,7 @@ If you don't want to use {% data variables.product.prodname_actions %}, you shou
|
|||||||
|
|
||||||
The {% data variables.product.prodname_codeql_cli %} is a command-line tool that you use to analyze codebases on any machine, including a third-party CI/CD system. For more information, see "[Installing CodeQL CLI in your CI system](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)."
|
The {% data variables.product.prodname_codeql_cli %} is a command-line tool that you use to analyze codebases on any machine, including a third-party CI/CD system. For more information, see "[Installing CodeQL CLI in your CI system](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)."
|
||||||
|
|
||||||
{% if codeql-runner-supported %}
|
{% ifversion codeql-runner-supported %}
|
||||||
|
|
||||||
## Running {% data variables.product.prodname_code_scanning %} using the {% data variables.product.prodname_codeql_runner %}
|
## Running {% data variables.product.prodname_code_scanning %} using the {% data variables.product.prodname_codeql_runner %}
|
||||||
|
|
||||||
|
|||||||
@@ -253,7 +253,7 @@ When code scanning identifies a problem in a pull request, you can review the hi
|
|||||||
code and resolve the alert. For more information, see "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests)."
|
code and resolve the alert. For more information, see "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests)."
|
||||||
|
|
||||||
If you have write permission to a repository you can manage code scanning alerts for that
|
If you have write permission to a repository you can manage code scanning alerts for that
|
||||||
repository. With write permission to a repository, {% if delete-code-scanning-alerts %}you can view, fix, dismiss, or delete alerts {% else %}you can view, fix, or dismiss alerts{% endif %} for potential vulnerabilities or errors in your repository's code. For more information, see "[Managing code scanning alerts for your repository](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository)."
|
repository. With write permission to a repository, {% ifversion delete-code-scanning-alerts %}you can view, fix, dismiss, or delete alerts {% else %}you can view, fix, or dismiss alerts{% endif %} for potential vulnerabilities or errors in your repository's code. For more information, see "[Managing code scanning alerts for your repository](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository)."
|
||||||
|
|
||||||
#### Generate reports of {% data variables.product.prodname_code_scanning %} alerts
|
#### Generate reports of {% data variables.product.prodname_code_scanning %} alerts
|
||||||
|
|
||||||
|
|||||||
@@ -30,7 +30,7 @@ Feature | Description | More information |
|
|||||||
------- | ----------- | ---------------- |{% ifversion ghes %}
|
------- | ----------- | ---------------- |{% ifversion ghes %}
|
||||||
Automatic user license sync | Manage license usage across your {% data variables.product.prodname_enterprise %} deployments by automatically syncing user licenses from {% data variables.product.product_location %} to {% data variables.product.prodname_ghe_cloud %}. | "[Enabling automatic user license sync for your enterprise](/admin/configuration/configuring-github-connect/enabling-automatic-user-license-sync-for-your-enterprise)"{% endif %}{% ifversion ghes or ghae %}
|
Automatic user license sync | Manage license usage across your {% data variables.product.prodname_enterprise %} deployments by automatically syncing user licenses from {% data variables.product.product_location %} to {% data variables.product.prodname_ghe_cloud %}. | "[Enabling automatic user license sync for your enterprise](/admin/configuration/configuring-github-connect/enabling-automatic-user-license-sync-for-your-enterprise)"{% endif %}{% ifversion ghes or ghae %}
|
||||||
{% data variables.product.prodname_dependabot %} | Allow users to find and fix vulnerabilities in code dependencies. | "[Enabling {% data variables.product.prodname_dependabot %} for your enterprise](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)"{% endif %}
|
{% data variables.product.prodname_dependabot %} | Allow users to find and fix vulnerabilities in code dependencies. | "[Enabling {% data variables.product.prodname_dependabot %} for your enterprise](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)"{% endif %}
|
||||||
{% data variables.product.prodname_dotcom_the_website %} actions | Allow users to use actions from {% data variables.product.prodname_dotcom_the_website %} in workflow files. | "[Enabling automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect)"{% if server-statistics %}
|
{% data variables.product.prodname_dotcom_the_website %} actions | Allow users to use actions from {% data variables.product.prodname_dotcom_the_website %} in workflow files. | "[Enabling automatic access to {% data variables.product.prodname_dotcom_the_website %} actions using {% data variables.product.prodname_github_connect %}](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect)"{% ifversion server-statistics %}
|
||||||
{% data variables.product.prodname_server_statistics %} | Analyze your own aggregate data from GitHub Enterprise Server, and help us improve GitHub products. | "[Enabling {% data variables.product.prodname_server_statistics %} for your enterprise](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)"{% endif %}
|
{% data variables.product.prodname_server_statistics %} | Analyze your own aggregate data from GitHub Enterprise Server, and help us improve GitHub products. | "[Enabling {% data variables.product.prodname_server_statistics %} for your enterprise](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)"{% endif %}
|
||||||
Unified search | Allow users to include repositories on {% data variables.product.prodname_dotcom_the_website %} in their search results when searching from {% data variables.product.product_location %}. | "[Enabling {% data variables.product.prodname_unified_search %} for your enterprise](/admin/configuration/configuring-github-connect/enabling-unified-search-for-your-enterprise)"
|
Unified search | Allow users to include repositories on {% data variables.product.prodname_dotcom_the_website %} in their search results when searching from {% data variables.product.product_location %}. | "[Enabling {% data variables.product.prodname_unified_search %} for your enterprise](/admin/configuration/configuring-github-connect/enabling-unified-search-for-your-enterprise)"
|
||||||
Unified contributions | Allow users to include anonymized contribution counts for their work on {% data variables.product.product_location %} in their contribution graphs on {% data variables.product.prodname_dotcom_the_website %}. | "[Enabling {% data variables.product.prodname_unified_contributions %} for your enterprise](/admin/configuration/configuring-github-connect/enabling-unified-contributions-for-your-enterprise)"
|
Unified contributions | Allow users to include anonymized contribution counts for their work on {% data variables.product.product_location %} in their contribution graphs on {% data variables.product.prodname_dotcom_the_website %}. | "[Enabling {% data variables.product.prodname_unified_contributions %} for your enterprise](/admin/configuration/configuring-github-connect/enabling-unified-contributions-for-your-enterprise)"
|
||||||
@@ -65,9 +65,9 @@ Additional data is transmitted if you enable individual features of {% data vari
|
|||||||
Feature | Data | Which way does the data flow? | Where is the data used? |
|
Feature | Data | Which way does the data flow? | Where is the data used? |
|
||||||
------- | ---- | --------- | ------ |{% ifversion ghes %}
|
------- | ---- | --------- | ------ |{% ifversion ghes %}
|
||||||
Automatic user license sync | Each {% data variables.product.product_name %} user's user ID and email addresses | From {% data variables.product.product_name %} to {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %} |{% endif %}{% ifversion ghes or ghae %}
|
Automatic user license sync | Each {% data variables.product.product_name %} user's user ID and email addresses | From {% data variables.product.product_name %} to {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %} |{% endif %}{% ifversion ghes or ghae %}
|
||||||
{% data variables.product.prodname_dependabot_alerts %} | Vulnerability alerts | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %} | {% data variables.product.product_name %} |{% endif %}{% if dependabot-updates-github-connect %}
|
{% data variables.product.prodname_dependabot_alerts %} | Vulnerability alerts | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %} | {% data variables.product.product_name %} |{% endif %}{% ifversion dependabot-updates-github-connect %}
|
||||||
{% data variables.product.prodname_dependabot_updates %} | Dependencies and the metadata for each dependency's repository<br><br>If a dependency is stored in a private repository on {% data variables.product.prodname_dotcom_the_website %}, data will only be transmitted if {% data variables.product.prodname_dependabot %} is configured and authorized to access that repository. | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %} | {% data variables.product.product_name %} {% endif %}
|
{% data variables.product.prodname_dependabot_updates %} | Dependencies and the metadata for each dependency's repository<br><br>If a dependency is stored in a private repository on {% data variables.product.prodname_dotcom_the_website %}, data will only be transmitted if {% data variables.product.prodname_dependabot %} is configured and authorized to access that repository. | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %} | {% data variables.product.product_name %} {% endif %}
|
||||||
{% data variables.product.prodname_dotcom_the_website %} actions | Name of action, action (YAML file from {% data variables.product.prodname_marketplace %}) | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %}<br><br>From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %}{% if server-statistics %}
|
{% data variables.product.prodname_dotcom_the_website %} actions | Name of action, action (YAML file from {% data variables.product.prodname_marketplace %}) | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %}<br><br>From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %}{% ifversion server-statistics %}
|
||||||
{% data variables.product.prodname_server_statistics %} | Aggregate {% data variables.product.prodname_ghe_server %} usage metrics<br>For the list of aggregate metrics collected, see "[{% data variables.product.prodname_server_statistics %} data collected](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics#server-statistics-data-collected)." | From {% data variables.product.product_name %} to {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %}{% endif %}
|
{% data variables.product.prodname_server_statistics %} | Aggregate {% data variables.product.prodname_ghe_server %} usage metrics<br>For the list of aggregate metrics collected, see "[{% data variables.product.prodname_server_statistics %} data collected](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics#server-statistics-data-collected)." | From {% data variables.product.product_name %} to {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %}{% endif %}
|
||||||
Unified search | Search terms, search results | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %}<br><br>From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %} |
|
Unified search | Search terms, search results | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %}<br><br>From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %} |
|
||||||
Unified contributions | Contribution counts | From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.prodname_dotcom_the_website %} |
|
Unified contributions | Contribution counts | From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.prodname_dotcom_the_website %} |
|
||||||
|
|||||||
@@ -80,7 +80,7 @@ Before you can enable {% data variables.product.prodname_dependabot_alerts %}:
|
|||||||
|
|
||||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||||
{% data reusables.enterprise-accounts.github-connect-tab %}
|
{% data reusables.enterprise-accounts.github-connect-tab %}
|
||||||
{%- if dependabot-updates-github-connect %}
|
{%- ifversion dependabot-updates-github-connect %}
|
||||||
1. Under "{% data variables.product.prodname_dependabot %}", to the right of "Users can receive vulnerability alerts for open source code dependencies", select the dropdown menu and click **Enabled without notifications**. Optionally, to enable alerts with notifications, click **Enabled with notifications**.
|
1. Under "{% data variables.product.prodname_dependabot %}", to the right of "Users can receive vulnerability alerts for open source code dependencies", select the dropdown menu and click **Enabled without notifications**. Optionally, to enable alerts with notifications, click **Enabled with notifications**.
|
||||||
|
|
||||||

|

|
||||||
@@ -95,7 +95,7 @@ Before you can enable {% data variables.product.prodname_dependabot_alerts %}:
|
|||||||
|
|
||||||
{% endtip %}
|
{% endtip %}
|
||||||
|
|
||||||
{% if dependabot-updates-github-connect %}
|
{% ifversion dependabot-updates-github-connect %}
|
||||||
## Enabling {% data variables.product.prodname_dependabot_updates %}
|
## Enabling {% data variables.product.prodname_dependabot_updates %}
|
||||||
|
|
||||||
After you enable {% data variables.product.prodname_dependabot_alerts %} for your enterprise, you can enable {% data variables.product.prodname_dependabot_updates %}.
|
After you enable {% data variables.product.prodname_dependabot_alerts %} for your enterprise, you can enable {% data variables.product.prodname_dependabot_updates %}.
|
||||||
|
|||||||
@@ -129,7 +129,7 @@ $ ghe-restore -c 169.154.1.1
|
|||||||
> Visit https://169.154.1.1/setup/settings to review appliance configuration.
|
> Visit https://169.154.1.1/setup/settings to review appliance configuration.
|
||||||
```
|
```
|
||||||
|
|
||||||
{% if ip-exception-list %}
|
{% ifversion ip-exception-list %}
|
||||||
Optionally, to validate the restore, configure an IP exception list to allow access to a specified list of IP addresses. For more information, see "[Validating changes in maintenance mode using the IP exception list](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode#validating-changes-in-maintenance-mode-using-the-ip-exception-list)."
|
Optionally, to validate the restore, configure an IP exception list to allow access to a specified list of IP addresses. For more information, see "[Validating changes in maintenance mode using the IP exception list](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode#validating-changes-in-maintenance-mode-using-the-ip-exception-list)."
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
|
|||||||
@@ -40,7 +40,7 @@ When the instance is in maintenance mode, all normal HTTP and Git access is refu
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
{% if ip-exception-list %}
|
{% ifversion ip-exception-list %}
|
||||||
|
|
||||||
You can perform initial validation of your maintenance operation by configuring an IP exception list to allow access to {% data variables.product.product_location %} from only the IP addresses and ranges provided. Attempts to access {% data variables.product.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.product.product_location %} from only the IP addresses and ranges provided. Attempts to access {% data variables.product.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.
|
||||||
|
|
||||||
@@ -61,7 +61,7 @@ You can perform initial validation of your maintenance operation by configuring
|
|||||||

|

|
||||||
{% data reusables.enterprise_management_console.save-settings %}
|
{% data reusables.enterprise_management_console.save-settings %}
|
||||||
|
|
||||||
{% if ip-exception-list %}
|
{% ifversion ip-exception-list %}
|
||||||
|
|
||||||
## Validating changes in maintenance mode using the IP exception list
|
## Validating changes in maintenance mode using the IP exception list
|
||||||
|
|
||||||
|
|||||||
@@ -186,7 +186,7 @@ For example, the following words are reserved, among others:
|
|||||||
|
|
||||||
For the full list or reserved words, navigate to "Reserved logins" in the site admin dashboard.
|
For the full list or reserved words, navigate to "Reserved logins" in the site admin dashboard.
|
||||||
|
|
||||||
{% if ghas-committers-calculator %}
|
{% ifversion ghas-committers-calculator %}
|
||||||
## {% data variables.product.prodname_advanced_security %} Committers
|
## {% data variables.product.prodname_advanced_security %} Committers
|
||||||
|
|
||||||
You can see the number of active committers that are currently using seats for {% data variables.product.prodname_GH_advanced_security %}, and you can calculate how many additional seats would be used if you enabled {% data variables.product.prodname_GH_advanced_security %} for more organizations and repositories.
|
You can see the number of active committers that are currently using seats for {% data variables.product.prodname_GH_advanced_security %}, and you can calculate how many additional seats would be used if you enabled {% data variables.product.prodname_GH_advanced_security %} for more organizations and repositories.
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ shortTitle: Increase CPU or memory
|
|||||||
|
|
||||||
{% note %}
|
{% note %}
|
||||||
|
|
||||||
**Note:** Before increasing CPU or memory resources, put your instance in maintenance mode.{% if ip-exception-list %} You can validate changes by configuring an IP exception list to allow access from specified IP addresses. {% endif %} For more information, see "[Enabling and scheduling maintenance mode](/enterprise/{{ currentVersion }}/admin/guides/installation/enabling-and-scheduling-maintenance-mode)."
|
**Note:** Before increasing CPU or memory resources, put your instance in maintenance mode.{% ifversion ip-exception-list %} You can validate changes by configuring an IP exception list to allow access from specified IP addresses. {% endif %} For more information, see "[Enabling and scheduling maintenance mode](/enterprise/{{ currentVersion }}/admin/guides/installation/enabling-and-scheduling-maintenance-mode)."
|
||||||
|
|
||||||
{% endnote %}
|
{% endnote %}
|
||||||
|
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ As more users join {% data variables.product.product_location %}, you may need t
|
|||||||
|
|
||||||
{% note %}
|
{% note %}
|
||||||
|
|
||||||
**Note:** Before resizing any storage volume, put your instance in maintenance mode.{% if ip-exception-list %} You can validate changes by configuring an IP exception list to allow access from specified IP addresses. {% endif %} For more information, see "[Enabling and scheduling maintenance mode](/enterprise/{{ currentVersion }}/admin/guides/installation/enabling-and-scheduling-maintenance-mode)."
|
**Note:** Before resizing any storage volume, put your instance in maintenance mode.{% ifversion ip-exception-list %} You can validate changes by configuring an IP exception list to allow access from specified IP addresses. {% endif %} For more information, see "[Enabling and scheduling maintenance mode](/enterprise/{{ currentVersion }}/admin/guides/installation/enabling-and-scheduling-maintenance-mode)."
|
||||||
|
|
||||||
{% endnote %}
|
{% endnote %}
|
||||||
|
|
||||||
|
|||||||
@@ -176,7 +176,7 @@ While you can use a hotpatch to upgrade to the latest patch release within a fea
|
|||||||
Target root partition: /dev/xvda2
|
Target root partition: /dev/xvda2
|
||||||
Proceed with installation? [y/N]
|
Proceed with installation? [y/N]
|
||||||
```
|
```
|
||||||
{% if ip-exception-list %}
|
{% ifversion ip-exception-list %}
|
||||||
1. Optionally, to validate the upgrade, configure an IP exception list to allow access to a specified list of IP addresses. For more information, see "[Validating changes in maintenance mode using the IP exception list](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode#validating-changes-in-maintenance-mode-using-the-ip-exception-list)."
|
1. Optionally, to validate the upgrade, configure an IP exception list to allow access to a specified list of IP addresses. For more information, see "[Validating changes in maintenance mode using the IP exception list](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode#validating-changes-in-maintenance-mode-using-the-ip-exception-list)."
|
||||||
{% endif %}
|
{% endif %}
|
||||||
7. For single appliance upgrades, disable maintenance mode so users can use {% data variables.product.product_location %}.
|
7. For single appliance upgrades, disable maintenance mode so users can use {% data variables.product.product_location %}.
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ To use {% data variables.product.prodname_dependabot_updates %} on {% data varia
|
|||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
{% if dependabot-updates-github-connect %}
|
{% ifversion dependabot-updates-github-connect %}
|
||||||
Configuring self-hosted runners is only one step in the middle of the process for enabling {% data variables.product.prodname_dependabot_updates %}. There are several steps you must follow before these steps, including configuring {% data variables.product.product_location %} to use {% data variables.product.prodname_actions %} with self-hosted runners. For more information, see "[Enabling {% data variables.product.prodname_dependabot %} for your enterprise](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)."
|
Configuring self-hosted runners is only one step in the middle of the process for enabling {% data variables.product.prodname_dependabot_updates %}. There are several steps you must follow before these steps, including configuring {% data variables.product.product_location %} to use {% data variables.product.prodname_actions %} with self-hosted runners. For more information, see "[Enabling {% data variables.product.prodname_dependabot %} for your enterprise](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)."
|
||||||
{% else %}
|
{% else %}
|
||||||
Before you configure self-hosted runners for {% data variables.product.prodname_dependabot_updates %}, you must:
|
Before you configure self-hosted runners for {% data variables.product.prodname_dependabot_updates %}, you must:
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ This article explains how site administrators can configure {% data variables.pr
|
|||||||
|
|
||||||
{% data reusables.enterprise.upgrade-ghes-for-actions %}
|
{% data reusables.enterprise.upgrade-ghes-for-actions %}
|
||||||
|
|
||||||
{% data reusables.actions.ghes-actions-not-enabled-by-default %} You'll need to determine whether your instance has adequate CPU and memory resources to handle the load from {% data variables.product.prodname_actions %} without causing performance loss, and possibly increase those resources. You'll also need to decide which storage provider you'll use for the blob storage required to store artifacts{% if actions-caching %} and caches{% endif %} generated by workflow runs. Then, you'll enable {% data variables.product.prodname_actions %} for your enterprise, manage access permissions, and add self-hosted runners to run workflows.
|
{% data reusables.actions.ghes-actions-not-enabled-by-default %} You'll need to determine whether your instance has adequate CPU and memory resources to handle the load from {% data variables.product.prodname_actions %} without causing performance loss, and possibly increase those resources. You'll also need to decide which storage provider you'll use for the blob storage required to store artifacts{% ifversion actions-caching %} and caches{% endif %} generated by workflow runs. Then, you'll enable {% data variables.product.prodname_actions %} for your enterprise, manage access permissions, and add self-hosted runners to run workflows.
|
||||||
|
|
||||||
{% data reusables.actions.introducing-enterprise %}
|
{% data reusables.actions.introducing-enterprise %}
|
||||||
|
|
||||||
@@ -118,7 +118,7 @@ Optionally, you can limit resource consumption on {% data variables.product.prod
|
|||||||
|
|
||||||
To enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}, you must have access to external blob storage.
|
To enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}, you must have access to external blob storage.
|
||||||
|
|
||||||
{% data variables.product.prodname_actions %} uses blob storage to store data generated by workflow runs, such as workflow logs{% if actions-caching %}, caches,{% endif %} and user-uploaded build artifacts. The amount of storage required depends on your usage of {% data variables.product.prodname_actions %}. Only a single external storage configuration is supported, and you can't use multiple storage providers at the same time.
|
{% data variables.product.prodname_actions %} uses blob storage to store data generated by workflow runs, such as workflow logs{% ifversion actions-caching %}, caches,{% endif %} and user-uploaded build artifacts. The amount of storage required depends on your usage of {% data variables.product.prodname_actions %}. Only a single external storage configuration is supported, and you can't use multiple storage providers at the same time.
|
||||||
|
|
||||||
{% data variables.product.prodname_actions %} supports these storage providers:
|
{% data variables.product.prodname_actions %} supports these storage providers:
|
||||||
|
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ Alternatively, you can use runner machines that {% data variables.product.compan
|
|||||||
|
|
||||||
This guide shows you how to apply a centralized management approach to self-hosted runners for {% data variables.product.prodname_actions %} in your enterprise. In the guide, you'll complete the following tasks.
|
This guide shows you how to apply a centralized management approach to self-hosted runners for {% data variables.product.prodname_actions %} in your enterprise. In the guide, you'll complete the following tasks.
|
||||||
|
|
||||||
1. Configure a limited policy to restrict the actions{% if actions-workflow-policy %} and reusable workflows{% endif %} that can run within your enterprise
|
1. Configure a limited policy to restrict the actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} that can run within your enterprise
|
||||||
1. Deploy a self-hosted runner for your enterprise
|
1. Deploy a self-hosted runner for your enterprise
|
||||||
1. Create a group to manage access to the runners available to your enterprise
|
1. Create a group to manage access to the runners available to your enterprise
|
||||||
1. Optionally, further restrict the repositories that can use the runner
|
1. Optionally, further restrict the repositories that can use the runner
|
||||||
@@ -48,7 +48,7 @@ After you finish the guide, {% ifversion ghec or ghae %}members of your enterpri
|
|||||||
|
|
||||||
## 1. Configure policies for {% data variables.product.prodname_actions %}
|
## 1. Configure policies for {% data variables.product.prodname_actions %}
|
||||||
|
|
||||||
First, enable {% data variables.product.prodname_actions %} for all organizations, and configure a policy to restrict the actions{% if actions-workflow-policy %} and reusable workflows{% endif %} that can run {% ifversion ghec or ghae%}within your enterprise on {% data variables.product.product_name %}{% elsif ghes %}on {% data variables.product.product_location %}{% endif %}. Optionally, organization owners can further restrict these policies for each organization.
|
First, enable {% data variables.product.prodname_actions %} for all organizations, and configure a policy to restrict the actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} that can run {% ifversion ghec or ghae%}within your enterprise on {% data variables.product.product_name %}{% elsif ghes %}on {% data variables.product.product_location %}{% endif %}. Optionally, organization owners can further restrict these policies for each organization.
|
||||||
|
|
||||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||||
{% data reusables.enterprise-accounts.policies-tab %}
|
{% data reusables.enterprise-accounts.policies-tab %}
|
||||||
@@ -56,9 +56,9 @@ First, enable {% data variables.product.prodname_actions %} for all organization
|
|||||||
1. Under "Policies", select **Enable for all organizations**.
|
1. Under "Policies", select **Enable for all organizations**.
|
||||||
|
|
||||||

|

|
||||||
1. Select {% data reusables.actions.policy-label-for-select-actions-workflows %} and **Allow actions created by GitHub** to allow local actions{% if actions-workflow-policy %} and reusable workflows{% endif %}, and actions created by {% data variables.product.company_short %}.
|
1. Select {% data reusables.actions.policy-label-for-select-actions-workflows %} and **Allow actions created by GitHub** to allow local actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %}, and actions created by {% data variables.product.company_short %}.
|
||||||
|
|
||||||
{% if actions-workflow-policy %}
|
{% ifversion actions-workflow-policy %}
|
||||||

|

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

|

|
||||||
|
|||||||
@@ -26,11 +26,11 @@ Before you introduce {% data variables.product.prodname_actions %} to a large en
|
|||||||
|
|
||||||
You should create a plan to govern your enterprise's use of {% data variables.product.prodname_actions %} and meet your compliance obligations.
|
You should create a plan to govern your enterprise's use of {% data variables.product.prodname_actions %} and meet your compliance obligations.
|
||||||
|
|
||||||
Determine which actions {% if actions-workflow-policy %}and reusable workflows{% endif %} your developers will be allowed to use. {% ifversion ghes %}First, decide whether you'll enable access to actions {% if actions-workflow-policy %}and reusable workflows{% endif %} from outside your instance. {% data reusables.actions.access-actions-on-dotcom %} For more information, see "[About using actions in your enterprise](/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise)."
|
Determine which actions {% ifversion actions-workflow-policy %}and reusable workflows{% endif %} your developers will be allowed to use. {% ifversion ghes %}First, decide whether you'll enable access to actions {% ifversion actions-workflow-policy %}and reusable workflows{% endif %} from outside your instance. {% data reusables.actions.access-actions-on-dotcom %} For more information, see "[About using actions in your enterprise](/admin/github-actions/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise)."
|
||||||
|
|
||||||
Then,{% else %}First,{% endif %} decide whether you'll allow third-party actions {% if actions-workflow-policy %}and reusable workflows{% endif %} that were not created by {% data variables.product.company_short %}. You can configure the actions {% if actions-workflow-policy %}and reusable workflows{% endif %} that are allowed to run at the repository, organization, and enterprise levels and can choose to only allow actions that are created by {% data variables.product.company_short %}. If you do allow third-party actions{% if actions-workflow-policy %} and reusable workflows{% endif %}, you can limit allowed actions to those created by verified creators or a list of specific actions{% if actions-workflow-policy %} and reusable workflows{% endif %}. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#managing-github-actions-permissions-for-your-repository)", "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#managing-github-actions-permissions-for-your-organization)", and "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-to-restrict-the-use-of-github-actions-in-your-enterprise)."
|
Then,{% else %}First,{% endif %} decide whether you'll allow third-party actions {% ifversion actions-workflow-policy %}and reusable workflows{% endif %} that were not created by {% data variables.product.company_short %}. You can configure the actions {% ifversion actions-workflow-policy %}and reusable workflows{% endif %} that are allowed to run at the repository, organization, and enterprise levels and can choose to only allow actions that are created by {% data variables.product.company_short %}. If you do allow third-party actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %}, you can limit allowed actions to those created by verified creators or a list of specific actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %}. For more information, see "[Managing {% data variables.product.prodname_actions %} settings for a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#managing-github-actions-permissions-for-your-repository)", "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#managing-github-actions-permissions-for-your-organization)", and "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-to-restrict-the-use-of-github-actions-in-your-enterprise)."
|
||||||
|
|
||||||
{% if actions-workflow-policy %}
|
{% ifversion actions-workflow-policy %}
|
||||||

|

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

|

|
||||||
@@ -80,7 +80,7 @@ With reusable workflows, your team can call one workflow from another workflow,
|
|||||||
|
|
||||||
To provide a starting place for developers building new workflows, you can use starter workflows. This not only saves time for your developers, but promotes consistency and best practice across your enterprise. For more information, see "[Creating starter workflows for your organization](/actions/learn-github-actions/creating-starter-workflows-for-your-organization)."
|
To provide a starting place for developers building new workflows, you can use starter workflows. This not only saves time for your developers, but promotes consistency and best practice across your enterprise. For more information, see "[Creating starter workflows for your organization](/actions/learn-github-actions/creating-starter-workflows-for-your-organization)."
|
||||||
|
|
||||||
{% if not internal-actions %}
|
{% ifversion not internal-actions %}
|
||||||
Whenever your workflow developers want to use an action that's stored in a private repository, they must configure the workflow to clone the repository first. To reduce the number of repositories that must be cloned, consider grouping commonly used actions in a single repository. For more information, see "[About custom actions](/actions/creating-actions/about-custom-actions#choosing-a-location-for-your-action)."
|
Whenever your workflow developers want to use an action that's stored in a private repository, they must configure the workflow to clone the repository first. To reduce the number of repositories that must be cloned, consider grouping commonly used actions in a single repository. For more information, see "[About custom actions](/actions/creating-actions/about-custom-actions#choosing-a-location-for-your-action)."
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
@@ -112,15 +112,15 @@ Finally, you should consider security hardening for self-hosted runners. For mor
|
|||||||
|
|
||||||
{% data reusables.actions.about-artifacts %} For more information, see "[Storing workflow data as artifacts](/actions/advanced-guides/storing-workflow-data-as-artifacts)."
|
{% data reusables.actions.about-artifacts %} For more information, see "[Storing workflow data as artifacts](/actions/advanced-guides/storing-workflow-data-as-artifacts)."
|
||||||
|
|
||||||
{% if actions-caching %}{% data variables.product.prodname_actions %} also has a caching system that you can use to cache dependencies to speed up workflow runs. For more information, see "[Caching dependencies to speed up workflows](/actions/using-workflows/caching-dependencies-to-speed-up-workflows)."{% endif %}
|
{% ifversion actions-caching %}{% data variables.product.prodname_actions %} also has a caching system that you can use to cache dependencies to speed up workflow runs. For more information, see "[Caching dependencies to speed up workflows](/actions/using-workflows/caching-dependencies-to-speed-up-workflows)."{% endif %}
|
||||||
|
|
||||||
{% ifversion ghes %}
|
{% ifversion ghes %}
|
||||||
You must configure external blob storage for workflow artifacts{% if actions-caching %}, caches,{% endif %} and other workflow logs. Decide which supported storage provider your enterprise will use. For more information, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.product_name %}](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server#external-storage-requirements)."
|
You must configure external blob storage for workflow artifacts{% ifversion actions-caching %}, caches,{% endif %} and other workflow logs. Decide which supported storage provider your enterprise will use. For more information, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.product_name %}](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server#external-storage-requirements)."
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% ifversion ghec or ghes %}
|
{% ifversion ghec or ghes %}
|
||||||
|
|
||||||
You can use policy settings for {% data variables.product.prodname_actions %} to customize the storage of workflow artifacts{% if actions-caching %}, caches,{% endif %} and log retention. For more information, see "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise)."
|
You can use policy settings for {% data variables.product.prodname_actions %} to customize the storage of workflow artifacts{% ifversion actions-caching %}, caches,{% endif %} and log retention. For more information, see "[Enforcing policies for {% data variables.product.prodname_actions %} in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise)."
|
||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ If you did not save your recovery codes when you configured SSO, you can still a
|
|||||||
{% data reusables.enterprise-accounts.settings-tab %}
|
{% data reusables.enterprise-accounts.settings-tab %}
|
||||||
{% data reusables.enterprise-accounts.security-tab %}
|
{% data reusables.enterprise-accounts.security-tab %}
|
||||||
|
|
||||||
1. Under{% if oidc-for-emu %} either{% endif %} "Require SAML authentication"{% if oidc-for-emu %} or "Require OIDC authentication"{% endif %}, click **Save your recovery codes**.{% if oidc-for-emu %}
|
1. Under{% ifversion oidc-for-emu %} either{% endif %} "Require SAML authentication"{% ifversion oidc-for-emu %} or "Require OIDC authentication"{% endif %}, click **Save your recovery codes**.{% ifversion oidc-for-emu %}
|
||||||
{% note %}
|
{% note %}
|
||||||
|
|
||||||
**Note:** OIDC SSO is only available for {% data variables.product.prodname_emus %}. For more information, see "[About Enterprise Managed Users](/admin/identity-and-access-management/using-enterprise-managed-users-and-saml-for-iam/about-enterprise-managed-users)."
|
**Note:** OIDC SSO is only available for {% data variables.product.prodname_emus %}. For more information, see "[About Enterprise Managed Users](/admin/identity-and-access-management/using-enterprise-managed-users-and-saml-for-iam/about-enterprise-managed-users)."
|
||||||
|
|||||||
@@ -26,7 +26,7 @@ In your IdP, you can give each {% data variables.product.prodname_managed_user %
|
|||||||
|
|
||||||
Organization membership can be managed manually, or you can update membership automatically as {% data variables.product.prodname_managed_users %} are added to IdP groups that are connected to teams within the organization. When a {% data variables.product.prodname_managed_user %} is manually added to an organization, unassigning them from the {% data variables.product.prodname_emu_idp_application %} application on your IdP will suspend the user but not remove them from the organization. For more information about managing organization and team membership automatically, see "[Managing team memberships with identity provider groups](/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/managing-team-memberships-with-identity-provider-groups)."
|
Organization membership can be managed manually, or you can update membership automatically as {% data variables.product.prodname_managed_users %} are added to IdP groups that are connected to teams within the organization. When a {% data variables.product.prodname_managed_user %} is manually added to an organization, unassigning them from the {% data variables.product.prodname_emu_idp_application %} application on your IdP will suspend the user but not remove them from the organization. For more information about managing organization and team membership automatically, see "[Managing team memberships with identity provider groups](/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/managing-team-memberships-with-identity-provider-groups)."
|
||||||
|
|
||||||
{% if oidc-for-emu %}
|
{% ifversion oidc-for-emu %}
|
||||||
|
|
||||||
{% data reusables.enterprise-accounts.emu-cap-validates %} For more information, see "[About support for your IdP's Conditional Access Policy](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy)."
|
{% data reusables.enterprise-accounts.emu-cap-validates %} For more information, see "[About support for your IdP's Conditional Access Policy](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy)."
|
||||||
|
|
||||||
@@ -50,7 +50,7 @@ To use {% data variables.product.prodname_emus %}, you need a separate type of e
|
|||||||
|
|
||||||
## Identity provider support
|
## Identity provider support
|
||||||
|
|
||||||
{% data variables.product.prodname_emus %} supports the following IdPs{% if oidc-for-emu %} and authentication methods:
|
{% data variables.product.prodname_emus %} supports the following IdPs{% ifversion oidc-for-emu %} and authentication methods:
|
||||||
|
|
||||||
| | SAML | OIDC (beta) |
|
| | SAML | OIDC (beta) |
|
||||||
|----------------------------------|-----------------------------------------------|-----------------------------------------------|
|
|----------------------------------|-----------------------------------------------|-----------------------------------------------|
|
||||||
@@ -96,9 +96,9 @@ Before your developers can use {% data variables.product.prodname_ghe_cloud %} w
|
|||||||
|
|
||||||
{% endnote %}
|
{% endnote %}
|
||||||
|
|
||||||
3. After you log in to your setup user, get started by configuring {% if oidc-for-emu %}how your members will authenticate. If you are using Azure Active Directory as your identity provider, you can choose between OpenID Connect (OIDC) and Security Assertion Markup Language (SAML). Both options provide a seamless sign-in experience for your members, but only OIDC includes support for Conditional Access Policies (CAP). If you are using Okta as your identity provider, you can use SAML to authenticate your members.{% else %}SAML SSO for your enterprise. For more information, see "[Configuring SAML single sign-on for Enterprise Managed Users](/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/configuring-saml-single-sign-on-for-enterprise-managed-users)."{% endif %}
|
3. After you log in to your setup user, get started by configuring {% ifversion oidc-for-emu %}how your members will authenticate. If you are using Azure Active Directory as your identity provider, you can choose between OpenID Connect (OIDC) and Security Assertion Markup Language (SAML). Both options provide a seamless sign-in experience for your members, but only OIDC includes support for Conditional Access Policies (CAP). If you are using Okta as your identity provider, you can use SAML to authenticate your members.{% else %}SAML SSO for your enterprise. For more information, see "[Configuring SAML single sign-on for Enterprise Managed Users](/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/configuring-saml-single-sign-on-for-enterprise-managed-users)."{% endif %}
|
||||||
|
|
||||||
{% if oidc-for-emu %}
|
{% ifversion oidc-for-emu %}
|
||||||
|
|
||||||
To get started, read the guide for your chosen authentication method.
|
To get started, read the guide for your chosen authentication method.
|
||||||
|
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ Groups in your IdP can be used to manage team membership within your enterprise'
|
|||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
Before you can configure provisioning for {% data variables.product.prodname_emus %}, you must configure SAML{% if oidc-for-emu %} or OIDC{% endif %} single-sign on. {% if oidc-for-emu %}
|
Before you can configure provisioning for {% data variables.product.prodname_emus %}, you must configure SAML{% ifversion oidc-for-emu %} or OIDC{% endif %} single-sign on. {% ifversion oidc-for-emu %}
|
||||||
|
|
||||||
- For more information on configuring OIDC, see "[Configuring OIDC for Enterprise Managed Users](/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/configuring-oidc-for-enterprise-managed-users)"
|
- For more information on configuring OIDC, see "[Configuring OIDC for Enterprise Managed Users](/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/configuring-oidc-for-enterprise-managed-users)"
|
||||||
- {% endif %}For information on configuring SAML, see "[Configuring SAML single sign-on for Enterprise Managed Users](/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/configuring-saml-single-sign-on-for-enterprise-managed-users)."
|
- {% endif %}For information on configuring SAML, see "[Configuring SAML single sign-on for Enterprise Managed Users](/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/configuring-saml-single-sign-on-for-enterprise-managed-users)."
|
||||||
@@ -66,7 +66,7 @@ After creating your personal access token and storing it securely, you can confi
|
|||||||
To configure provisioning, follow the appropriate link from the table below.
|
To configure provisioning, follow the appropriate link from the table below.
|
||||||
|
|
||||||
| Identity provider | SSO method | More information |
|
| Identity provider | SSO method | More information |
|
||||||
|---|---|---|{% if oidc-for-emu %}
|
|---|---|---|{% ifversion oidc-for-emu %}
|
||||||
| Azure AD | OIDC | [Tutorial: Configure GitHub Enterprise Managed User (OIDC) for automatic user provisioning](https://docs.microsoft.com/azure/active-directory/saas-apps/github-enterprise-managed-user-oidc-provisioning-tutorial) in the Azure AD documentation |{% endif %}
|
| Azure AD | OIDC | [Tutorial: Configure GitHub Enterprise Managed User (OIDC) for automatic user provisioning](https://docs.microsoft.com/azure/active-directory/saas-apps/github-enterprise-managed-user-oidc-provisioning-tutorial) in the Azure AD documentation |{% endif %}
|
||||||
| Azure AD | SAML | [Tutorial: Configure GitHub Enterprise Managed User for automatic user provisioning](https://docs.microsoft.com/en-us/azure/active-directory/saas-apps/github-enterprise-managed-user-provisioning-tutorial) in the Azure AD documentation |
|
| Azure AD | SAML | [Tutorial: Configure GitHub Enterprise Managed User for automatic user provisioning](https://docs.microsoft.com/en-us/azure/active-directory/saas-apps/github-enterprise-managed-user-provisioning-tutorial) in the Azure AD documentation |
|
||||||
| Okta | SAML | [Configuring SCIM provisioning for Enterprise Managed Users with Okta](/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/configuring-scim-provisioning-for-enterprise-managed-users-with-okta) |
|
| Okta | SAML | [Configuring SCIM provisioning for Enterprise Managed Users with Okta](/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/configuring-scim-provisioning-for-enterprise-managed-users-with-okta) |
|
||||||
|
|||||||
@@ -36,7 +36,7 @@ In addition to viewing your audit log, you can monitor activity in your enterpri
|
|||||||
As an enterprise owner{% ifversion ghes %} or site administrator{% endif %}, you can interact with the audit log data for your enterprise in several ways:
|
As an enterprise owner{% ifversion ghes %} or site administrator{% endif %}, you can interact with the audit log data for your enterprise in several ways:
|
||||||
- You can view the audit log for your enterprise. For more information, see "[Accessing the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)."
|
- You can view the audit log for your enterprise. For more information, see "[Accessing the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)."
|
||||||
- You can search the audit log for specific events{% ifversion ghec %} and export audit log data{% endif %}. For more information, see "[Searching the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise)"{% ifversion ghec %} and "[Exporting the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/exporting-audit-log-activity-for-your-enterprise)"{% endif %}.
|
- You can search the audit log for specific events{% ifversion ghec %} and export audit log data{% endif %}. For more information, see "[Searching the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise)"{% ifversion ghec %} and "[Exporting the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/exporting-audit-log-activity-for-your-enterprise)"{% endif %}.
|
||||||
{%- if enterprise-audit-log-ip-addresses %}
|
{%- ifversion enterprise-audit-log-ip-addresses %}
|
||||||
- You can display the IP address associated with events in the audit log. For more information, see "[Displaying IP addresses in the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/displaying-ip-addresses-in-the-audit-log-for-your-enterprise)."
|
- You can display the IP address associated with events in the audit log. For more information, see "[Displaying IP addresses in the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/displaying-ip-addresses-in-the-audit-log-for-your-enterprise)."
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
{%- ifversion ghec %}
|
{%- ifversion ghec %}
|
||||||
|
|||||||
@@ -157,7 +157,7 @@ The scope of the events that appear in your enterprise's audit log depend on whe
|
|||||||
| `business.update_saml_provider_settings` | The SAML single sign-on provider settings for an enterprise were updated.
|
| `business.update_saml_provider_settings` | The SAML single sign-on provider settings for an enterprise were updated.
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
|
|
||||||
{%- if secret-scanning-audit-log-custom-patterns %}
|
{%- ifversion secret-scanning-audit-log-custom-patterns %}
|
||||||
## `business_secret_scanning_custom_pattern` category actions
|
## `business_secret_scanning_custom_pattern` category actions
|
||||||
|
|
||||||
Action | Description
|
Action | Description
|
||||||
@@ -713,7 +713,7 @@ Action | Description
|
|||||||
{%- ifversion fpt or ghec %}
|
{%- ifversion fpt or ghec %}
|
||||||
| `org.runner_group_visiblity_updated` | The visibility of a self-hosted runner group was updated via the REST API. For more information, see "[Update a self-hosted runner group for an organization](/rest/reference/actions#update-a-self-hosted-runner-group-for-an-organization)."
|
| `org.runner_group_visiblity_updated` | The visibility of a self-hosted runner group was updated via the REST API. For more information, see "[Update a self-hosted runner group for an organization](/rest/reference/actions#update-a-self-hosted-runner-group-for-an-organization)."
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
{%- if secret-scanning-audit-log-custom-patterns %}
|
{%- ifversion secret-scanning-audit-log-custom-patterns %}
|
||||||
| `org.secret_scanning_push_protection_disable` | An organization owner or administrator disabled push protection for secret scanning. For more information, see "[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning)."
|
| `org.secret_scanning_push_protection_disable` | An organization owner or administrator disabled push protection for secret scanning. For more information, see "[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning)."
|
||||||
| `org.secret_scanning_push_protection_enable` | An organization owner or administrator enabled push protection for secret scanning.
|
| `org.secret_scanning_push_protection_enable` | An organization owner or administrator enabled push protection for secret scanning.
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
@@ -762,7 +762,7 @@ Action | Description
|
|||||||
| `org_credential_authorization.revoke` | An owner revoked authorized credentials. {% ifversion ghec %}For more information, see "[Viewing and managing your active SAML sessions](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization)."{% endif %}
|
| `org_credential_authorization.revoke` | An owner revoked authorized credentials. {% ifversion ghec %}For more information, see "[Viewing and managing your active SAML sessions](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization)."{% endif %}
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
|
|
||||||
{%- if secret-scanning-audit-log-custom-patterns %}
|
{%- ifversion secret-scanning-audit-log-custom-patterns %}
|
||||||
## `org_secret_scanning_custom_pattern` category actions
|
## `org_secret_scanning_custom_pattern` category actions
|
||||||
|
|
||||||
| Action | Description
|
| Action | Description
|
||||||
@@ -1130,7 +1130,7 @@ Action | Description
|
|||||||
| `repository_secret_scanning.enable` | A repository owner or administrator enabled secret scanning for a {% ifversion ghec %}private or internal {% endif %}repository.
|
| `repository_secret_scanning.enable` | A repository owner or administrator enabled secret scanning for a {% ifversion ghec %}private or internal {% endif %}repository.
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
|
|
||||||
{%- if secret-scanning-audit-log-custom-patterns %}
|
{%- ifversion secret-scanning-audit-log-custom-patterns %}
|
||||||
|
|
||||||
## `repository_secret_scanning_custom_pattern` category actions
|
## `repository_secret_scanning_custom_pattern` category actions
|
||||||
|
|
||||||
@@ -1191,7 +1191,7 @@ Action | Description
|
|||||||
| `restrict_notification_delivery.disable` | Email notification restrictions for an organization or enterprise were disabled. For more information, see "[Restricting email notifications for your organization](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization)" and "[Restricting email notifications for your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/restricting-email-notifications-for-your-enterprise)."
|
| `restrict_notification_delivery.disable` | Email notification restrictions for an organization or enterprise were disabled. For more information, see "[Restricting email notifications for your organization](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/restricting-email-notifications-for-your-organization)" and "[Restricting email notifications for your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/restricting-email-notifications-for-your-enterprise)."
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
|
|
||||||
{%- if custom-repository-roles %}
|
{%- ifversion custom-repository-roles %}
|
||||||
## `role` category actions
|
## `role` category actions
|
||||||
|
|
||||||
| Action | Description
|
| Action | Description
|
||||||
@@ -1209,7 +1209,7 @@ Action | Description
|
|||||||
| `secret_scanning.disable` | An organization owner disabled secret scanning for all existing{% ifversion ghec %} private or internal{% endif %} repositories. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)."
|
| `secret_scanning.disable` | An organization owner disabled secret scanning for all existing{% ifversion ghec %} private or internal{% endif %} repositories. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)."
|
||||||
| `secret_scanning.enable` | An organization owner enabled secret scanning for all existing{% ifversion ghec %} private or internal{% endif %} repositories.
|
| `secret_scanning.enable` | An organization owner enabled secret scanning for all existing{% ifversion ghec %} private or internal{% endif %} repositories.
|
||||||
|
|
||||||
{% if secret-scanning-alert-audit-log %}
|
{% ifversion secret-scanning-alert-audit-log %}
|
||||||
## `secret_scanning_alert` category actions
|
## `secret_scanning_alert` category actions
|
||||||
|
|
||||||
| Action | Description
|
| Action | Description
|
||||||
|
|||||||
@@ -50,7 +50,7 @@ Your enterprise account allows you to manage and enforce policies for all the or
|
|||||||
|
|
||||||
{% ifversion ghes or ghae %}
|
{% ifversion ghes or ghae %}
|
||||||
|
|
||||||
From your enterprise account on {% ifversion ghae %}{% data variables.product.product_name %}{% elsif ghes %}a {% data variables.product.prodname_ghe_server %} instance{% endif %}, administrators can view{% if remove-enterprise-members %} and manage{% endif %} enterprise membership{% if enterprise-owner-join-org %}, manage their own membership in organizations owned by the enterprise,{% endif %} and manage the following for the {% ifversion ghes %}{% data variables.product.prodname_ghe_server %} instance{% elsif ghae %}enterprise on {% data variables.product.prodname_ghe_managed %}{% endif %}.
|
From your enterprise account on {% ifversion ghae %}{% data variables.product.product_name %}{% elsif ghes %}a {% data variables.product.prodname_ghe_server %} instance{% endif %}, administrators can view{% ifversion remove-enterprise-members %} and manage{% endif %} enterprise membership{% ifversion enterprise-owner-join-org %}, manage their own membership in organizations owned by the enterprise,{% endif %} and manage the following for the {% ifversion ghes %}{% data variables.product.prodname_ghe_server %} instance{% elsif ghae %}enterprise on {% data variables.product.prodname_ghe_managed %}{% endif %}.
|
||||||
|
|
||||||
{% ifversion ghes %}
|
{% ifversion ghes %}
|
||||||
- License usage{% endif %}
|
- License usage{% endif %}
|
||||||
@@ -65,7 +65,7 @@ From your enterprise account on {% ifversion ghae %}{% data variables.product.pr
|
|||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% ifversion ghec or ghes %}When you try or purchase {% data variables.product.prodname_enterprise %}, you can{% ifversion ghes %} also{% endif %} create an enterprise account for {% data variables.product.prodname_ghe_cloud %} on {% data variables.product.prodname_dotcom_the_website %}. Administrators for the enterprise account on {% data variables.product.prodname_dotcom_the_website %} can view {% if remove-enterprise-members %} and manage{% endif %} enterprise membership{% if enterprise-owner-join-org %}, manage their own membership in organizations owned by the enterprise,{% endif %} and manage the following for the enterprise account{% ifversion ghes %} on {% data variables.product.prodname_dotcom_the_website %}{% endif %}.
|
{% ifversion ghec or ghes %}When you try or purchase {% data variables.product.prodname_enterprise %}, you can{% ifversion ghes %} also{% endif %} create an enterprise account for {% data variables.product.prodname_ghe_cloud %} on {% data variables.product.prodname_dotcom_the_website %}. Administrators for the enterprise account on {% data variables.product.prodname_dotcom_the_website %} can view {% ifversion remove-enterprise-members %} and manage{% endif %} enterprise membership{% ifversion enterprise-owner-join-org %}, manage their own membership in organizations owned by the enterprise,{% endif %} and manage the following for the enterprise account{% ifversion ghes %} on {% data variables.product.prodname_dotcom_the_website %}{% endif %}.
|
||||||
|
|
||||||
- Billing and usage (services on {% data variables.product.prodname_dotcom_the_website %}, {% data variables.product.prodname_GH_advanced_security %}, user licenses)
|
- Billing and usage (services on {% data variables.product.prodname_dotcom_the_website %}, {% data variables.product.prodname_GH_advanced_security %}, user licenses)
|
||||||
- Security (single sign-on, IP allow lists, SSH certificate authorities, two-factor authentication)
|
- Security (single sign-on, IP allow lists, SSH certificate authorities, two-factor authentication)
|
||||||
|
|||||||
@@ -35,7 +35,7 @@ shortTitle: GitHub Actions policies
|
|||||||
|
|
||||||
## Enforcing a policy to restrict the use of {% data variables.product.prodname_actions %} in your enterprise
|
## Enforcing a policy to restrict the use of {% data variables.product.prodname_actions %} in your enterprise
|
||||||
|
|
||||||
You can choose to disable {% data variables.product.prodname_actions %} for all organizations in your enterprise, or only allow specific organizations. You can also limit the use of public actions {% if actions-workflow-policy %}and reusable workflows{% endif %}, so that people can only use local actions {% if actions-workflow-policy %}and reusable workflows{% endif %} that exist in your enterprise.
|
You can choose to disable {% data variables.product.prodname_actions %} for all organizations in your enterprise, or only allow specific organizations. You can also limit the use of public actions {% ifversion actions-workflow-policy %}and reusable workflows{% endif %}, so that people can only use local actions {% ifversion actions-workflow-policy %}and reusable workflows{% endif %} that exist in your enterprise.
|
||||||
|
|
||||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||||
{% data reusables.enterprise-accounts.policies-tab %}
|
{% data reusables.enterprise-accounts.policies-tab %}
|
||||||
@@ -47,11 +47,11 @@ You can choose to disable {% data variables.product.prodname_actions %} for all
|
|||||||
{%- ifversion ghes or ghae %}
|
{%- ifversion ghes or ghae %}
|
||||||
{% note %}
|
{% note %}
|
||||||
|
|
||||||
**Note:** To enable access to public actions{% if actions-workflow-policy %} and reusable workflows{% endif %}, you must first configure {% data variables.product.product_location %} to connect to {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Enabling automatic access to GitHub.com actions using GitHub Connect](/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)."
|
**Note:** To enable access to public actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %}, you must first configure {% data variables.product.product_location %} to connect to {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Enabling automatic access to GitHub.com actions using GitHub Connect](/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect)."
|
||||||
|
|
||||||
{% endnote %}
|
{% endnote %}
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
{% if actions-workflow-policy %}
|
{% ifversion actions-workflow-policy %}
|
||||||

|

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

|

|
||||||
@@ -63,8 +63,8 @@ You can choose to disable {% data variables.product.prodname_actions %} for all
|
|||||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||||
{% data reusables.enterprise-accounts.policies-tab %}
|
{% data reusables.enterprise-accounts.policies-tab %}
|
||||||
{% data reusables.enterprise-accounts.actions-tab %}
|
{% data reusables.enterprise-accounts.actions-tab %}
|
||||||
1. Under "Policies", select {% data reusables.actions.policy-label-for-select-actions-workflows %} and add your required actions{% if actions-workflow-policy %} and reusable workflows{% endif %} to the list.
|
1. Under "Policies", select {% data reusables.actions.policy-label-for-select-actions-workflows %} and add your required actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} to the list.
|
||||||
{% if actions-workflow-policy %}
|
{% ifversion actions-workflow-policy %}
|
||||||

|

|
||||||
{%- elsif ghes or ghae %}
|
{%- elsif ghes or ghae %}
|
||||||

|

|
||||||
@@ -127,7 +127,7 @@ You can set the default permissions for the `GITHUB_TOKEN` in the settings for y
|
|||||||
|
|
||||||
### Configuring the default `GITHUB_TOKEN` permissions
|
### Configuring the default `GITHUB_TOKEN` permissions
|
||||||
|
|
||||||
{% if allow-actions-to-approve-pr-with-ent-repo %}
|
{% ifversion allow-actions-to-approve-pr-with-ent-repo %}
|
||||||
By default, when you create a new enterprise, `GITHUB_TOKEN` only has read access for the `contents` scope.
|
By default, when you create a new enterprise, `GITHUB_TOKEN` only has read access for the `contents` scope.
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
@@ -136,10 +136,10 @@ By default, when you create a new enterprise, `GITHUB_TOKEN` only has read acces
|
|||||||
{% data reusables.enterprise-accounts.actions-tab %}
|
{% data reusables.enterprise-accounts.actions-tab %}
|
||||||
1. Under "Workflow permissions", choose whether you want the `GITHUB_TOKEN` to have read and write access for all scopes, or just read access for the `contents` scope.
|
1. Under "Workflow permissions", choose whether you want the `GITHUB_TOKEN` to have read and write access for all scopes, or just read access for the `contents` scope.
|
||||||
|
|
||||||

|

|
||||||
1. Click **Save** to apply the settings.
|
1. Click **Save** to apply the settings.
|
||||||
|
|
||||||
{% if allow-actions-to-approve-pr-with-ent-repo %}
|
{% ifversion allow-actions-to-approve-pr-with-ent-repo %}
|
||||||
### Preventing {% data variables.product.prodname_actions %} from creating or approving pull requests
|
### Preventing {% data variables.product.prodname_actions %} from creating or approving pull requests
|
||||||
|
|
||||||
{% data reusables.actions.workflow-pr-approval-permissions-intro %}
|
{% data reusables.actions.workflow-pr-approval-permissions-intro %}
|
||||||
@@ -157,7 +157,7 @@ By default, when you create a new enterprise, workflows are not allowed to creat
|
|||||||
{% endif %}
|
{% endif %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if actions-cache-policy-apis %}
|
{% ifversion actions-cache-policy-apis %}
|
||||||
|
|
||||||
## Enforcing a policy for cache storage in your enterprise
|
## Enforcing a policy for cache storage in your enterprise
|
||||||
|
|
||||||
|
|||||||
@@ -118,7 +118,7 @@ Across all organizations owned by your enterprise, you can allow people with acc
|
|||||||
|
|
||||||
## Enforcing a policy for inviting{% ifversion ghec %} outside{% endif %} collaborators to repositories
|
## Enforcing a policy for inviting{% ifversion ghec %} outside{% endif %} collaborators to repositories
|
||||||
|
|
||||||
Across all organizations owned by your enterprise, you can allow members to invite{% ifversion ghec %} outside{% endif %} collaborators to repositories, restrict {% ifversion ghec %}outside collaborator {% endif %}invitations to organization owners, {% if prevent-org-admin-add-outside-collaborator %}restrict {% ifversion ghec %}outside collaborator {% endif %}invitations to enterprise owners, {% endif %}or allow organization owners to administer the setting on the organization level.
|
Across all organizations owned by your enterprise, you can allow members to invite{% ifversion ghec %} outside{% endif %} collaborators to repositories, restrict {% ifversion ghec %}outside collaborator {% endif %}invitations to organization owners, {% ifversion prevent-org-admin-add-outside-collaborator %}restrict {% ifversion ghec %}outside collaborator {% endif %}invitations to enterprise owners, {% endif %}or allow organization owners to administer the setting on the organization level.
|
||||||
|
|
||||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||||
{% data reusables.enterprise-accounts.policies-tab %}
|
{% data reusables.enterprise-accounts.policies-tab %}
|
||||||
|
|||||||
@@ -45,7 +45,7 @@ If your enterprise uses {% data variables.product.prodname_emus %}, enterprise o
|
|||||||
|
|
||||||
{% ifversion ghec %}After you invite someone to join the enterprise account, they must accept the emailed invitation before they can access the enterprise account. Pending invitations will expire after 7 days.{% endif %}
|
{% ifversion ghec %}After you invite someone to join the enterprise account, they must accept the emailed invitation before they can access the enterprise account. Pending invitations will expire after 7 days.{% endif %}
|
||||||
|
|
||||||
{% if enterprise-membership-view-improvements %}
|
{% ifversion enterprise-membership-view-improvements %}
|
||||||
You can see all pending invitations to become an administrator of your enterprise account. For more information, see "[Viewing people in your enterprise](/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise#viewing-pending-invitations)."
|
You can see all pending invitations to become an administrator of your enterprise account. For more information, see "[Viewing people in your enterprise](/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise#viewing-pending-invitations)."
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
|
|||||||
@@ -34,13 +34,13 @@ For more information about adding people to your enterprise, see "[Authenticatio
|
|||||||
|
|
||||||
Enterprise owners have complete control over the enterprise and can take every action, including:
|
Enterprise owners have complete control over the enterprise and can take every action, including:
|
||||||
- Managing administrators
|
- Managing administrators
|
||||||
- {% ifversion ghec %}Adding and removing {% elsif ghae or ghes %}Managing{% endif %} organizations {% ifversion ghec %}to and from {% elsif ghae or ghes %} in{% endif %} the enterprise{% if remove-enterprise-members %}
|
- {% ifversion ghec %}Adding and removing {% elsif ghae or ghes %}Managing{% endif %} organizations {% ifversion ghec %}to and from {% elsif ghae or ghes %} in{% endif %} the enterprise{% ifversion remove-enterprise-members %}
|
||||||
- Removing enterprise members from all organizations owned by the enterprise{% endif %}
|
- Removing enterprise members from all organizations owned by the enterprise{% endif %}
|
||||||
- Managing enterprise settings
|
- Managing enterprise settings
|
||||||
- Enforcing policy across organizations
|
- Enforcing policy across organizations
|
||||||
{% ifversion ghec %}- Managing billing settings{% endif %}
|
{% ifversion ghec %}- Managing billing settings{% endif %}
|
||||||
|
|
||||||
{% if enterprise-owner-join-org %}
|
{% ifversion enterprise-owner-join-org %}
|
||||||
Enterprise owners do not have access to organization settings or content by default. To gain access, enterprise owners can join any organization owned by their enterprise. For more information, see "[Managing your role in an organization owned by your enterprise](/admin/user-management/managing-organizations-in-your-enterprise/managing-your-role-in-an-organization-owned-by-your-enterprise)."
|
Enterprise owners do not have access to organization settings or content by default. To gain access, enterprise owners can join any organization owned by their enterprise. For more information, see "[Managing your role in an organization owned by your enterprise](/admin/user-management/managing-organizations-in-your-enterprise/managing-your-role-in-an-organization-owned-by-your-enterprise)."
|
||||||
|
|
||||||
Owners of organizations in your enterprise do not have access to the enterprise itself unless you make them enterprise owners.
|
Owners of organizations in your enterprise do not have access to the enterprise itself unless you make them enterprise owners.
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ You can see all current enterprise members and enterprise administrators{% ifver
|
|||||||
|
|
||||||
## Viewing enterprise administrators
|
## Viewing enterprise administrators
|
||||||
|
|
||||||
You can view all the current enterprise owners{% ifversion ghec %} and billing managers{% endif %} for your enterprise.{% if enterprise-membership-view-improvements %} You can see useful information about each administrator{% ifversion ghec %} and filter the list by role{% endif %}.{% endif %} You can find a specific person by searching for their username or display name.
|
You can view all the current enterprise owners{% ifversion ghec %} and billing managers{% endif %} for your enterprise.{% ifversion enterprise-membership-view-improvements %} You can see useful information about each administrator{% ifversion ghec %} and filter the list by role{% endif %}.{% endif %} You can find a specific person by searching for their username or display name.
|
||||||
|
|
||||||
{% ifversion not ghae %}
|
{% ifversion not ghae %}
|
||||||
You can also remove an administrator. For more information. see "[Inviting people to manage your enterprise](/admin/user-management/managing-users-in-your-enterprise/inviting-people-to-manage-your-enterprise#removing-an-enterprise-administrator-from-your-enterprise-account)."
|
You can also remove an administrator. For more information. see "[Inviting people to manage your enterprise](/admin/user-management/managing-users-in-your-enterprise/inviting-people-to-manage-your-enterprise#removing-an-enterprise-administrator-from-your-enterprise-account)."
|
||||||
@@ -33,23 +33,23 @@ You can also remove an administrator. For more information. see "[Inviting peopl
|
|||||||
{% data reusables.enterprise-accounts.people-tab %}
|
{% data reusables.enterprise-accounts.people-tab %}
|
||||||
{% data reusables.enterprise-accounts.administrators-tab %}
|
{% data reusables.enterprise-accounts.administrators-tab %}
|
||||||
|
|
||||||
## Viewing members {% if enterprise-membership-view-improvements %}{% else %}and outside collaborators{% endif %}
|
## Viewing members {% ifversion enterprise-membership-view-improvements %}{% else %}and outside collaborators{% endif %}
|
||||||
|
|
||||||
You can see all the current members {% if enterprise-membership-view-improvements %}{% else %}or outside collaborators{% endif %} for your enterprise. You can see useful information about each account and filter the list in useful ways, such as by role. You can find a specific person by searching for their username or display name.
|
You can see all the current members {% ifversion enterprise-membership-view-improvements %}{% else %}or outside collaborators{% endif %} for your enterprise. You can see useful information about each account and filter the list in useful ways, such as by role. You can find a specific person by searching for their username or display name.
|
||||||
|
|
||||||
You can view more information about the person's access to your enterprise, such as the organizations the person belongs to, by clicking on the person's name.
|
You can view more information about the person's access to your enterprise, such as the organizations the person belongs to, by clicking on the person's name.
|
||||||
|
|
||||||
{% if remove-enterprise-members %}
|
{% ifversion remove-enterprise-members %}
|
||||||
You can also remove any enterprise member from all organizations owned by the enterprise. For more information, see "[Removing a member from your enterprise](/admin/user-management/managing-users-in-your-enterprise/removing-a-member-from-your-enterprise)."
|
You can also remove any enterprise member from all organizations owned by the enterprise. For more information, see "[Removing a member from your enterprise](/admin/user-management/managing-users-in-your-enterprise/removing-a-member-from-your-enterprise)."
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||||
{% data reusables.enterprise-accounts.people-tab %}{% if enterprise-membership-view-improvements %}{% else %}
|
{% data reusables.enterprise-accounts.people-tab %}{% ifversion enterprise-membership-view-improvements %}{% else %}
|
||||||
1. Optionally, to view a list of outside collaborators rather than the list of members, click **Outside collaborators**.
|
1. Optionally, to view a list of outside collaborators rather than the list of members, click **Outside collaborators**.
|
||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if enterprise-membership-view-improvements %}
|
{% ifversion enterprise-membership-view-improvements %}
|
||||||
## Viewing outside collaborators
|
## Viewing outside collaborators
|
||||||
|
|
||||||
You can see all the current outside collaborators for your enterprise. You can see useful information about each collaborator and filter the list in useful ways, such as by organization. You can find a specific collaborator by searching for their username or display name.
|
You can see all the current outside collaborators for your enterprise. You can see useful information about each collaborator and filter the list in useful ways, such as by organization. You can find a specific collaborator by searching for their username or display name.
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ shortTitle: View Advanced Security usage
|
|||||||
|
|
||||||
{% data reusables.advanced-security.about-ghas-license-seats %} For more information, see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)."
|
{% data reusables.advanced-security.about-ghas-license-seats %} For more information, see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)."
|
||||||
|
|
||||||
{% if ghas-committers-calculator %}
|
{% ifversion ghas-committers-calculator %}
|
||||||
You can calculate how many additional seats will be used if you enable {% data variables.product.prodname_GH_advanced_security %} for more organizations and repositories with the site admin dashboard. For more information, see "[Site admin dashboard](/admin/configuration/configuring-your-enterprise/site-admin-dashboard#advanced-security-active-committers)."
|
You can calculate how many additional seats will be used if you enable {% data variables.product.prodname_GH_advanced_security %} for more organizations and repositories with the site admin dashboard. For more information, see "[Site admin dashboard](/admin/configuration/configuring-your-enterprise/site-admin-dashboard#advanced-security-active-committers)."
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
|
|||||||
@@ -91,7 +91,7 @@ On the alert page, you can see that the filepath is marked as library code (`Lib
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
{% if codeql-ml-queries %}
|
{% ifversion codeql-ml-queries %}
|
||||||
|
|
||||||
## About experimental alerts
|
## About experimental alerts
|
||||||
|
|
||||||
|
|||||||
@@ -47,7 +47,7 @@ There are two main ways to use {% data variables.product.prodname_codeql %} anal
|
|||||||
|
|
||||||
You can run additional queries as part of your code scanning analysis.
|
You can run additional queries as part of your code scanning analysis.
|
||||||
|
|
||||||
{%- if codeql-packs %}
|
{%- ifversion codeql-packs %}
|
||||||
These queries must belong to a published {% data variables.product.prodname_codeql %} query pack (beta) or a QL pack in a repository. {% data variables.product.prodname_codeql %} packs (beta) provide the following benefits over traditional QL packs:
|
These queries must belong to a published {% data variables.product.prodname_codeql %} query pack (beta) or a QL pack in a repository. {% data variables.product.prodname_codeql %} packs (beta) provide the following benefits over traditional QL packs:
|
||||||
|
|
||||||
- When a {% data variables.product.prodname_codeql %} query pack (beta) is published to the {% data variables.product.company_short %} {% data variables.product.prodname_container_registry %}, all the transitive dependencies required by the queries and a compilation cache are included in the package. This improves performance and ensures that running the queries in the pack gives identical results every time until you upgrade to a new version of the pack or the CLI.
|
- When a {% data variables.product.prodname_codeql %} query pack (beta) is published to the {% data variables.product.company_short %} {% data variables.product.prodname_container_registry %}, all the transitive dependencies required by the queries and a compilation cache are included in the package. This improves performance and ensures that running the queries in the pack gives identical results every time until you upgrade to a new version of the pack or the CLI.
|
||||||
|
|||||||
@@ -308,7 +308,7 @@ Your specified category will not overwrite the details of the `runAutomationDeta
|
|||||||
|
|
||||||
{% data reusables.code-scanning.run-additional-queries %}
|
{% data reusables.code-scanning.run-additional-queries %}
|
||||||
|
|
||||||
{% if codeql-packs %}
|
{% ifversion codeql-packs %}
|
||||||
### Using {% data variables.product.prodname_codeql %} query packs
|
### Using {% data variables.product.prodname_codeql %} query packs
|
||||||
|
|
||||||
{% data reusables.code-scanning.beta-codeql-packs-cli %}
|
{% data reusables.code-scanning.beta-codeql-packs-cli %}
|
||||||
@@ -346,27 +346,27 @@ You can also specify query suites in the value of `queries`. Query suites are co
|
|||||||
|
|
||||||
{% data reusables.code-scanning.codeql-query-suites-explanation %}
|
{% data reusables.code-scanning.codeql-query-suites-explanation %}
|
||||||
|
|
||||||
{% if codeql-packs %}
|
{% ifversion codeql-packs %}
|
||||||
### Working with custom configuration files
|
### Working with custom configuration files
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
If you also use a configuration file for custom settings, any additional {% if codeql-packs %}packs or {% endif %}queries specified in your workflow are used instead of those specified in the configuration file. If you want to run the combined set of additional {% if codeql-packs %}packs or {% endif %}queries, prefix the value of {% if codeql-packs %}`packs` or {% endif %}`queries` in the workflow with the `+` symbol. For more information, see "[Using a custom configuration file](#using-a-custom-configuration-file)."
|
If you also use a configuration file for custom settings, any additional {% ifversion codeql-packs %}packs or {% endif %}queries specified in your workflow are used instead of those specified in the configuration file. If you want to run the combined set of additional {% ifversion codeql-packs %}packs or {% endif %}queries, prefix the value of {% ifversion codeql-packs %}`packs` or {% endif %}`queries` in the workflow with the `+` symbol. For more information, see "[Using a custom configuration file](#using-a-custom-configuration-file)."
|
||||||
|
|
||||||
In the following example, the `+` symbol ensures that the specified additional {% if codeql-packs %}packs and {% endif %}queries are used together with any specified in the referenced configuration file.
|
In the following example, the `+` symbol ensures that the specified additional {% ifversion codeql-packs %}packs and {% endif %}queries are used together with any specified in the referenced configuration file.
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
- uses: {% data reusables.actions.action-codeql-action-init %}
|
- uses: {% data reusables.actions.action-codeql-action-init %}
|
||||||
with:
|
with:
|
||||||
config-file: ./.github/codeql/codeql-config.yml
|
config-file: ./.github/codeql/codeql-config.yml
|
||||||
queries: +security-and-quality,octo-org/python-qlpack/show_ifs.ql@main
|
queries: +security-and-quality,octo-org/python-qlpack/show_ifs.ql@main
|
||||||
{%- if codeql-packs %}
|
{%- ifversion codeql-packs %}
|
||||||
packs: +scope/pack1,scope/pack2@v1.2.3
|
packs: +scope/pack1,scope/pack2@v1.2.3
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
```
|
```
|
||||||
|
|
||||||
## Using a custom configuration file
|
## Using a custom configuration file
|
||||||
|
|
||||||
A custom configuration file is an alternative way to specify additional {% if codeql-packs %}packs and {% endif %}queries to run. You can also use the file to disable the default queries and to specify which directories to scan during analysis.
|
A custom configuration file is an alternative way to specify additional {% ifversion codeql-packs %}packs and {% endif %}queries to run. You can also use the file to disable the default queries and to specify which directories to scan during analysis.
|
||||||
|
|
||||||
In the workflow file, use the `config-file` parameter of the `init` action to specify the path to the configuration file you want to use. This example loads the configuration file _./.github/codeql/codeql-config.yml_.
|
In the workflow file, use the `config-file` parameter of the `init` action to specify the path to the configuration file you want to use. This example loads the configuration file _./.github/codeql/codeql-config.yml_.
|
||||||
|
|
||||||
@@ -388,7 +388,7 @@ If the configuration file is located in an external private repository, use the
|
|||||||
|
|
||||||
The settings in the configuration file are written in YAML format.
|
The settings in the configuration file are written in YAML format.
|
||||||
|
|
||||||
{% if codeql-packs %}
|
{% ifversion codeql-packs %}
|
||||||
### Specifying {% data variables.product.prodname_codeql %} query packs
|
### Specifying {% data variables.product.prodname_codeql %} query packs
|
||||||
|
|
||||||
{% data reusables.code-scanning.beta-codeql-packs-cli %}
|
{% data reusables.code-scanning.beta-codeql-packs-cli %}
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
title: Managing code scanning alerts for your repository
|
title: Managing code scanning alerts for your repository
|
||||||
shortTitle: Manage alerts
|
shortTitle: Manage alerts
|
||||||
intro: 'From the security view, {% if delete-code-scanning-alerts %}you can view, fix, dismiss, or delete alerts {% else %}you can view, fix, or dismiss alerts{% endif %} for potential vulnerabilities or errors in your project''s code.'
|
intro: 'From the security view, {% ifversion delete-code-scanning-alerts %}you can view, fix, dismiss, or delete alerts {% else %}you can view, fix, or dismiss alerts{% endif %} for potential vulnerabilities or errors in your project''s code.'
|
||||||
product: '{% data reusables.gated-features.code-scanning %}'
|
product: '{% data reusables.gated-features.code-scanning %}'
|
||||||
permissions: 'If you have write permission to a repository you can manage {% data variables.product.prodname_code_scanning %} alerts for that repository.'
|
permissions: 'If you have write permission to a repository you can manage {% data variables.product.prodname_code_scanning %} alerts for that repository.'
|
||||||
versions:
|
versions:
|
||||||
@@ -93,7 +93,7 @@ If you enter multiple filters, the view will show alerts matching _all_ these fi
|
|||||||
|
|
||||||
{% ifversion fpt or ghes > 3.3 or ghec %}
|
{% ifversion fpt or ghes > 3.3 or ghec %}
|
||||||
|
|
||||||
You can prefix the `tag` filter with `-` to exclude results with that tag. For example, `-tag:style` only shows alerts that do not have the `style` tag{% if codeql-ml-queries %} and `-tag:experimental` will omit all experimental alerts. For more information, see "[About {% data variables.product.prodname_code_scanning %} alerts](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts#about-experimental-alerts)."{% else %}.{% endif %}
|
You can prefix the `tag` filter with `-` to exclude results with that tag. For example, `-tag:style` only shows alerts that do not have the `style` tag{% ifversion codeql-ml-queries %} and `-tag:experimental` will omit all experimental alerts. For more information, see "[About {% data variables.product.prodname_code_scanning %} alerts](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts#about-experimental-alerts)."{% else %}.{% endif %}
|
||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
@@ -139,7 +139,7 @@ You can search the list of alerts. This is useful if there is a large number of
|
|||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if code-scanning-task-lists %}
|
{% ifversion code-scanning-task-lists %}
|
||||||
## Tracking {% data variables.product.prodname_code_scanning %} alerts in issues
|
## Tracking {% data variables.product.prodname_code_scanning %} alerts in issues
|
||||||
|
|
||||||
{% data reusables.code-scanning.beta-alert-tracking-in-issues %}
|
{% data reusables.code-scanning.beta-alert-tracking-in-issues %}
|
||||||
@@ -175,9 +175,9 @@ Alerts may be fixed in one branch but not in another. You can use the "Branch" f
|
|||||||
|
|
||||||
{% endnote %}
|
{% endnote %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
## Dismissing {% if delete-code-scanning-alerts %}or deleting{% endif %} alerts
|
## Dismissing {% ifversion delete-code-scanning-alerts %}or deleting{% endif %} alerts
|
||||||
|
|
||||||
There are two ways of closing an alert. You can fix the problem in the code, or you can dismiss the alert. {% if delete-code-scanning-alerts %}Alternatively, if you have admin permissions for the repository, you can delete alerts. Deleting alerts is useful in situations where you have set up a {% data variables.product.prodname_code_scanning %} tool and then decided to remove it, or where you have configured {% data variables.product.prodname_codeql %} analysis with a larger set of queries than you want to continue using, and you've then removed some queries from the tool. In both cases, deleting alerts allows you to clean up your {% data variables.product.prodname_code_scanning %} results. You can delete alerts from the summary list within the **Security** tab.{% endif %}
|
There are two ways of closing an alert. You can fix the problem in the code, or you can dismiss the alert. {% ifversion delete-code-scanning-alerts %}Alternatively, if you have admin permissions for the repository, you can delete alerts. Deleting alerts is useful in situations where you have set up a {% data variables.product.prodname_code_scanning %} tool and then decided to remove it, or where you have configured {% data variables.product.prodname_codeql %} analysis with a larger set of queries than you want to continue using, and you've then removed some queries from the tool. In both cases, deleting alerts allows you to clean up your {% data variables.product.prodname_code_scanning %} results. You can delete alerts from the summary list within the **Security** tab.{% endif %}
|
||||||
|
|
||||||
Dismissing an alert is a way of closing an alert that you don't think needs to be fixed. {% data reusables.code-scanning.close-alert-examples %} You can dismiss alerts from {% data variables.product.prodname_code_scanning %} annotations in code, or from the summary list within the **Security** tab.
|
Dismissing an alert is a way of closing an alert that you don't think needs to be fixed. {% data reusables.code-scanning.close-alert-examples %} You can dismiss alerts from {% data variables.product.prodname_code_scanning %} annotations in code, or from the summary list within the **Security** tab.
|
||||||
|
|
||||||
@@ -186,22 +186,22 @@ When you dismiss an alert:
|
|||||||
- It's dismissed in all branches.
|
- It's dismissed in all branches.
|
||||||
- The alert is removed from the number of current alerts for your project.
|
- The alert is removed from the number of current alerts for your project.
|
||||||
- The alert is moved to the "Closed" list in the summary of alerts, from where you can reopen it, if required.
|
- The alert is moved to the "Closed" list in the summary of alerts, from where you can reopen it, if required.
|
||||||
- The reason why you closed the alert is recorded.{% if comment-dismissed-code-scanning-alert %}
|
- The reason why you closed the alert is recorded.{% ifversion comment-dismissed-code-scanning-alert %}
|
||||||
- Optionally, you can comment on a dismissal to record the context of an alert dismissal.{% endif %}
|
- Optionally, you can comment on a dismissal to record the context of an alert dismissal.{% endif %}
|
||||||
- Next time {% data variables.product.prodname_code_scanning %} runs, the same code won't generate an alert.
|
- Next time {% data variables.product.prodname_code_scanning %} runs, the same code won't generate an alert.
|
||||||
|
|
||||||
{% if delete-code-scanning-alerts %}When you delete an alert:
|
{% ifversion delete-code-scanning-alerts %}When you delete an alert:
|
||||||
|
|
||||||
- It's deleted in all branches.
|
- It's deleted in all branches.
|
||||||
- The alert is removed from the number of current alerts for your project.
|
- The alert is removed from the number of current alerts for your project.
|
||||||
- It is _not_ added to the "Closed" list in the summary of alerts.
|
- It is _not_ added to the "Closed" list in the summary of alerts.
|
||||||
- If the code that generated the alert stays the same, and the same {% data variables.product.prodname_code_scanning %} tool runs again without any configuration changes, the alert will be shown again in your analysis results.{% endif %}
|
- If the code that generated the alert stays the same, and the same {% data variables.product.prodname_code_scanning %} tool runs again without any configuration changes, the alert will be shown again in your analysis results.{% endif %}
|
||||||
|
|
||||||
To dismiss {% if delete-code-scanning-alerts %}or delete{% endif %} alerts:
|
To dismiss {% ifversion delete-code-scanning-alerts %}or delete{% endif %} alerts:
|
||||||
|
|
||||||
{% data reusables.repositories.navigate-to-repo %}
|
{% data reusables.repositories.navigate-to-repo %}
|
||||||
{% data reusables.repositories.sidebar-security %}
|
{% data reusables.repositories.sidebar-security %}
|
||||||
{% data reusables.repositories.sidebar-code-scanning-alerts %}{% if delete-code-scanning-alerts %}
|
{% data reusables.repositories.sidebar-code-scanning-alerts %}{% ifversion delete-code-scanning-alerts %}
|
||||||
1. If you have admin permissions for the repository, and you want to delete alerts for this {% data variables.product.prodname_code_scanning %} tool, select some or all of the check boxes and click **Delete**.
|
1. If you have admin permissions for the repository, and you want to delete alerts for this {% data variables.product.prodname_code_scanning %} tool, select some or all of the check boxes and click **Delete**.
|
||||||
|
|
||||||

|

|
||||||
@@ -220,7 +220,7 @@ To dismiss {% if delete-code-scanning-alerts %}or delete{% endif %} alerts:
|
|||||||
{% else %}
|
{% else %}
|
||||||

|

|
||||||
{% endif %}
|
{% endif %}
|
||||||
1. Review the alert, then click {% if comment-dismissed-code-scanning-alert %}**Dismiss alert** and choose, or type, a reason for closing the alert.
|
1. Review the alert, then click {% ifversion comment-dismissed-code-scanning-alert %}**Dismiss alert** and choose, or type, a reason for closing the alert.
|
||||||

|

|
||||||
{% else %}**Dismiss** and choose a reason for closing the alert.
|
{% else %}**Dismiss** and choose a reason for closing the alert.
|
||||||

|

|
||||||
|
|||||||
@@ -30,7 +30,7 @@ topics:
|
|||||||
|
|
||||||
If you're setting up {% data variables.product.prodname_code_scanning %} for a compiled language, and you're building the code in a containerized environment, the analysis may fail with the error message "No source code was seen during the build." This indicates that {% data variables.product.prodname_codeql %} was unable to monitor your code as it was compiled.
|
If you're setting up {% data variables.product.prodname_code_scanning %} for a compiled language, and you're building the code in a containerized environment, the analysis may fail with the error message "No source code was seen during the build." This indicates that {% data variables.product.prodname_codeql %} was unable to monitor your code as it was compiled.
|
||||||
|
|
||||||
You must run {% data variables.product.prodname_codeql %} inside the container in which you build your code. This applies whether you are using the {% data variables.product.prodname_codeql_cli %}{% if codeql-runner-supported %}, the {% data variables.product.prodname_codeql_runner %},{% endif %} or {% data variables.product.prodname_actions %}. For the {% data variables.product.prodname_codeql_cli %} {% if codeql-runner-supported %}or the {% data variables.product.prodname_codeql_runner %}{% endif %}, see "[Installing {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)"{% if codeql-runner-supported %} or "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)"{% endif %} for more information. If you're using {% data variables.product.prodname_actions %}, configure your workflow to run all the actions in the same container. For more information, see "[Example workflow](#example-workflow)."
|
You must run {% data variables.product.prodname_codeql %} inside the container in which you build your code. This applies whether you are using the {% data variables.product.prodname_codeql_cli %}{% ifversion codeql-runner-supported %}, the {% data variables.product.prodname_codeql_runner %},{% endif %} or {% data variables.product.prodname_actions %}. For the {% data variables.product.prodname_codeql_cli %} {% ifversion codeql-runner-supported %}or the {% data variables.product.prodname_codeql_runner %}{% endif %}, see "[Installing {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)"{% ifversion codeql-runner-supported %} or "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)"{% endif %} for more information. If you're using {% data variables.product.prodname_actions %}, configure your workflow to run all the actions in the same container. For more information, see "[Example workflow](#example-workflow)."
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
|
|||||||
@@ -29,11 +29,11 @@ topics:
|
|||||||
|
|
||||||
In repositories where {% data variables.product.prodname_code_scanning %} is configured as a pull request check, {% data variables.product.prodname_code_scanning %} checks the code in the pull request. By default, this is limited to pull requests that target the default branch, but you can change this configuration within {% data variables.product.prodname_actions %} or in a third-party CI/CD system. If merging the changes would introduce new {% data variables.product.prodname_code_scanning %} alerts to the target branch, the alerts are reported in multiple places.
|
In repositories where {% data variables.product.prodname_code_scanning %} is configured as a pull request check, {% data variables.product.prodname_code_scanning %} checks the code in the pull request. By default, this is limited to pull requests that target the default branch, but you can change this configuration within {% data variables.product.prodname_actions %} or in a third-party CI/CD system. If merging the changes would introduce new {% data variables.product.prodname_code_scanning %} alerts to the target branch, the alerts are reported in multiple places.
|
||||||
|
|
||||||
- Check results in the pull request {% if code-scanning-pr-conversations-tab %}
|
- Check results in the pull request {% ifversion code-scanning-pr-conversations-tab %}
|
||||||
- The **Conversation** tab of the pull request, as part of a pull request review {% endif %}
|
- The **Conversation** tab of the pull request, as part of a pull request review {% endif %}
|
||||||
- The **Files changed** tab of the pull request
|
- The **Files changed** tab of the pull request
|
||||||
|
|
||||||
{% if code-scanning-pr-conversations-tab %} {% endif %}
|
{% ifversion code-scanning-pr-conversations-tab %} {% endif %}
|
||||||
|
|
||||||
If you have write permission for the repository, you can see any existing {% data variables.product.prodname_code_scanning %} alerts on the **Security** tab. For information about repository alerts, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)."
|
If you have write permission for the repository, you can see any existing {% data variables.product.prodname_code_scanning %} alerts on the **Security** tab. For information about repository alerts, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)."
|
||||||
|
|
||||||
@@ -75,7 +75,7 @@ As with other pull request checks, you can see full details of the check failure
|
|||||||
|
|
||||||
## Viewing an alert on your pull request
|
## Viewing an alert on your pull request
|
||||||
|
|
||||||
{% if code-scanning-pr-conversations-tab %}
|
{% ifversion code-scanning-pr-conversations-tab %}
|
||||||
You can see any {% data variables.product.prodname_code_scanning %} alerts introduced in a pull request by viewing the **Conversation** tab. {% data variables.product.prodname_code_scanning_capc %} posts a pull request review that shows each alert as an annotation on the lines of code that triggered the alert. You can comment on the alerts, dismiss the alerts, and view paths for the alerts, directly from the annotations. You can view the full details of an alert by clicking the "Show more details" link, which will take you to the alert details page.
|
You can see any {% data variables.product.prodname_code_scanning %} alerts introduced in a pull request by viewing the **Conversation** tab. {% data variables.product.prodname_code_scanning_capc %} posts a pull request review that shows each alert as an annotation on the lines of code that triggered the alert. You can comment on the alerts, dismiss the alerts, and view paths for the alerts, directly from the annotations. You can view the full details of an alert by clicking the "Show more details" link, which will take you to the alert details page.
|
||||||
|
|
||||||

|

|
||||||
@@ -104,7 +104,7 @@ In the detailed view for an alert, some {% data variables.product.prodname_code_
|
|||||||

|

|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if code-scanning-pr-conversations-tab %}
|
{% ifversion code-scanning-pr-conversations-tab %}
|
||||||
## Commenting on an alert in a pull request
|
## Commenting on an alert in a pull request
|
||||||
|
|
||||||
You can comment on any {% data variables.product.prodname_code_scanning %} alert introduced by the changes in a pull request. Alerts appear as annotations in the **Conversation** tab of a pull request, as part of a pull request review, and also are shown in the **Files changed** tab. You can only comment on alerts introduced by the changes in a pull request. Existing {% data variables.product.prodname_code_scanning %} alerts, on files that are outside the changes introduced in the pull request, will appear in the **Files changed** tab but cannot be commented on.
|
You can comment on any {% data variables.product.prodname_code_scanning %} alert introduced by the changes in a pull request. Alerts appear as annotations in the **Conversation** tab of a pull request, as part of a pull request review, and also are shown in the **Files changed** tab. You can only comment on alerts introduced by the changes in a pull request. Existing {% data variables.product.prodname_code_scanning %} alerts, on files that are outside the changes introduced in the pull request, will appear in the **Files changed** tab but cannot be commented on.
|
||||||
@@ -118,7 +118,7 @@ Anyone with push access to a pull request can fix a {% data variables.product.pr
|
|||||||
## Dismissing an alert on your pull request
|
## Dismissing an alert on your pull request
|
||||||
|
|
||||||
An alternative way of closing an alert is to dismiss it. You can dismiss an alert if you don't think it needs to be fixed. {% data reusables.code-scanning.close-alert-examples %} If you have write permission for the repository, the **Dismiss** button is available in code annotations and in the alerts summary. When you click **Dismiss** you will be prompted to choose a reason for closing the alert.
|
An alternative way of closing an alert is to dismiss it. You can dismiss an alert if you don't think it needs to be fixed. {% data reusables.code-scanning.close-alert-examples %} If you have write permission for the repository, the **Dismiss** button is available in code annotations and in the alerts summary. When you click **Dismiss** you will be prompted to choose a reason for closing the alert.
|
||||||
{% if comment-dismissed-code-scanning-alert %}
|
{% ifversion comment-dismissed-code-scanning-alert %}
|
||||||

|

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

|

|
||||||
@@ -127,4 +127,4 @@ An alternative way of closing an alert is to dismiss it. You can dismiss an aler
|
|||||||
|
|
||||||
{% data reusables.code-scanning.false-positive-fix-codeql %}
|
{% data reusables.code-scanning.false-positive-fix-codeql %}
|
||||||
|
|
||||||
For more information about dismissing alerts, see {% if delete-code-scanning-alerts %}"[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#dismissing-or-deleting-alerts)."{% else %} "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository#dismissing--alerts)."{% endif %}
|
For more information about dismissing alerts, see {% ifversion delete-code-scanning-alerts %}"[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#dismissing-or-deleting-alerts)."{% else %} "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository#dismissing--alerts)."{% endif %}
|
||||||
|
|||||||
@@ -212,7 +212,7 @@ By default, there are three main query suites available for each language. If yo
|
|||||||
|
|
||||||
You may be running extra queries or query suites in addition to the default queries. Check whether the workflow defines an additional query suite or additional queries to run using the `queries` element. You can experiment with disabling the additional query suite or queries. For more information, see "[Configuring {% data variables.product.prodname_code_scanning %}](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs)."
|
You may be running extra queries or query suites in addition to the default queries. Check whether the workflow defines an additional query suite or additional queries to run using the `queries` element. You can experiment with disabling the additional query suite or queries. For more information, see "[Configuring {% data variables.product.prodname_code_scanning %}](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs)."
|
||||||
|
|
||||||
{% if codeql-ml-queries %}
|
{% ifversion codeql-ml-queries %}
|
||||||
{% note %}
|
{% note %}
|
||||||
|
|
||||||
**Note:** If you run the `security-extended` or `security-and-quality` query suite for JavaScript, then some queries use experimental technology. For more information, see "[About code scanning alerts](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts#about-experimental-alerts)."
|
**Note:** If you run the `security-extended` or `security-and-quality` query suite for JavaScript, then some queries use experimental technology. For more information, see "[About code scanning alerts](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts#about-experimental-alerts)."
|
||||||
|
|||||||
@@ -31,7 +31,7 @@ SARIF (Static Analysis Results Interchange Format) is an [OASIS Standard](https:
|
|||||||
|
|
||||||
To upload a SARIF file from a third-party static code analysis engine, you'll need to ensure that uploaded files use the SARIF 2.1.0 version. {% data variables.product.prodname_dotcom %} will parse the SARIF file and show alerts using the results in your repository as a part of the {% data variables.product.prodname_code_scanning %} experience. For more information, see "[Uploading a SARIF file to {% data variables.product.prodname_dotcom %}](/code-security/secure-coding/uploading-a-sarif-file-to-github)." For more information about the SARIF 2.1.0 JSON schema, see [`sarif-schema-2.1.0.json`](https://github.com/oasis-tcs/sarif-spec/blob/master/Documents/CommitteeSpecifications/2.1.0/sarif-schema-2.1.0.json).
|
To upload a SARIF file from a third-party static code analysis engine, you'll need to ensure that uploaded files use the SARIF 2.1.0 version. {% data variables.product.prodname_dotcom %} will parse the SARIF file and show alerts using the results in your repository as a part of the {% data variables.product.prodname_code_scanning %} experience. For more information, see "[Uploading a SARIF file to {% data variables.product.prodname_dotcom %}](/code-security/secure-coding/uploading-a-sarif-file-to-github)." For more information about the SARIF 2.1.0 JSON schema, see [`sarif-schema-2.1.0.json`](https://github.com/oasis-tcs/sarif-spec/blob/master/Documents/CommitteeSpecifications/2.1.0/sarif-schema-2.1.0.json).
|
||||||
|
|
||||||
If you're using {% data variables.product.prodname_actions %} with the {% data variables.product.prodname_codeql_workflow %}{% if codeql-runner-supported %}, using the {% data variables.product.prodname_codeql_runner %},{% endif %} or using the {% data variables.product.prodname_codeql_cli %}, then the {% data variables.product.prodname_code_scanning %} results will automatically use the supported subset of SARIF 2.1.0. For more information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)"{% if codeql-runner-supported %}, "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)",{% endif %} or "[Installing CodeQL CLI in your CI system](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)."
|
If you're using {% data variables.product.prodname_actions %} with the {% data variables.product.prodname_codeql_workflow %}{% ifversion codeql-runner-supported %}, using the {% data variables.product.prodname_codeql_runner %},{% endif %} or using the {% data variables.product.prodname_codeql_cli %}, then the {% data variables.product.prodname_code_scanning %} results will automatically use the supported subset of SARIF 2.1.0. For more information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/code-security/secure-coding/setting-up-code-scanning-for-a-repository)"{% ifversion codeql-runner-supported %}, "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)",{% endif %} or "[Installing CodeQL CLI in your CI system](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)."
|
||||||
|
|
||||||
{% ifversion fpt or ghes > 3.1 or ghae or ghec %}
|
{% ifversion fpt or ghes > 3.1 or ghae or ghec %}
|
||||||
You can upload multiple SARIF files for the same commit, and display the data from each file as {% data variables.product.prodname_code_scanning %} results. When you upload multiple SARIF files for a commit, you must indicate a "category" for each analysis. The way to specify a category varies according to the analysis method:
|
You can upload multiple SARIF files for the same commit, and display the data from each file as {% data variables.product.prodname_code_scanning %} results. When you upload multiple SARIF files for a commit, you must indicate a "category" for each analysis. The way to specify a category varies according to the analysis method:
|
||||||
@@ -53,7 +53,7 @@ Each time the results of a new code scan are uploaded, the results are processed
|
|||||||
|
|
||||||
{% data variables.product.prodname_dotcom %} uses the `partialFingerprints` property in the OASIS standard to detect when two results are logically identical. For more information, see the "[partialFingerprints property](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012611)" entry in the OASIS documentation.
|
{% data variables.product.prodname_dotcom %} uses the `partialFingerprints` property in the OASIS standard to detect when two results are logically identical. For more information, see the "[partialFingerprints property](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012611)" entry in the OASIS documentation.
|
||||||
|
|
||||||
SARIF files created by the {% data variables.product.prodname_codeql_workflow %}, {% if codeql-runner-supported %}using the {% data variables.product.prodname_codeql_runner %}, {% endif %}or using the {% data variables.product.prodname_codeql_cli %} include fingerprint data. If you upload a SARIF file using the `upload-sarif` action and this data is missing, {% data variables.product.prodname_dotcom %} attempts to populate the `partialFingerprints` field from the source files. For more information about uploading results, see "[Uploading a SARIF file to {% data variables.product.prodname_dotcom %}](/code-security/secure-coding/uploading-a-sarif-file-to-github#uploading-a-code-scanning-analysis-with-github-actions)."
|
SARIF files created by the {% data variables.product.prodname_codeql_workflow %}, {% ifversion codeql-runner-supported %}using the {% data variables.product.prodname_codeql_runner %}, {% endif %}or using the {% data variables.product.prodname_codeql_cli %} include fingerprint data. If you upload a SARIF file using the `upload-sarif` action and this data is missing, {% data variables.product.prodname_dotcom %} attempts to populate the `partialFingerprints` field from the source files. For more information about uploading results, see "[Uploading a SARIF file to {% data variables.product.prodname_dotcom %}](/code-security/secure-coding/uploading-a-sarif-file-to-github#uploading-a-code-scanning-analysis-with-github-actions)."
|
||||||
|
|
||||||
If you upload a SARIF file without fingerprint data using the `/code-scanning/sarifs` API endpoint, the {% data variables.product.prodname_code_scanning %} alerts will be processed and displayed, but users may see duplicate alerts. To avoid seeing duplicate alerts, you should calculate fingerprint data and populate the `partialFingerprints` property before you upload the SARIF file. You may find the script that the `upload-sarif` action uses a helpful starting point: https://github.com/github/codeql-action/blob/main/src/fingerprints.ts. For more information about the API, see "[Upload an analysis as SARIF data](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)."
|
If you upload a SARIF file without fingerprint data using the `/code-scanning/sarifs` API endpoint, the {% data variables.product.prodname_code_scanning %} alerts will be processed and displayed, but users may see duplicate alerts. To avoid seeing duplicate alerts, you should calculate fingerprint data and populate the `partialFingerprints` property before you upload the SARIF file. You may find the script that the `upload-sarif` action uses a helpful starting point: https://github.com/github/codeql-action/blob/main/src/fingerprints.ts. For more information about the API, see "[Upload an analysis as SARIF data](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)."
|
||||||
|
|
||||||
|
|||||||
@@ -35,11 +35,11 @@ topics:
|
|||||||
|
|
||||||
You can generate SARIF files using many static analysis security testing tools, including {% data variables.product.prodname_codeql %}. The results must use SARIF version 2.1.0. For more information, see "[SARIF support for {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/sarif-support-for-code-scanning)."
|
You can generate SARIF files using many static analysis security testing tools, including {% data variables.product.prodname_codeql %}. The results must use SARIF version 2.1.0. For more information, see "[SARIF support for {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/sarif-support-for-code-scanning)."
|
||||||
|
|
||||||
You can upload the results using {% data variables.product.prodname_actions %}, the {% data variables.product.prodname_code_scanning %} API,{% if codeql-runner-supported %} the {% data variables.product.prodname_codeql_runner %},{% endif %} or the {% data variables.product.prodname_codeql_cli %}. The best upload method will depend on how you generate the SARIF file, for example, if you use:
|
You can upload the results using {% data variables.product.prodname_actions %}, the {% data variables.product.prodname_code_scanning %} API,{% ifversion codeql-runner-supported %} the {% data variables.product.prodname_codeql_runner %},{% endif %} or the {% data variables.product.prodname_codeql_cli %}. The best upload method will depend on how you generate the SARIF file, for example, if you use:
|
||||||
|
|
||||||
- {% data variables.product.prodname_actions %} to run the {% data variables.product.prodname_codeql %} action, there is no further action required. The {% data variables.product.prodname_codeql %} action uploads the SARIF file automatically when it completes analysis.
|
- {% data variables.product.prodname_actions %} to run the {% data variables.product.prodname_codeql %} action, there is no further action required. The {% data variables.product.prodname_codeql %} action uploads the SARIF file automatically when it completes analysis.
|
||||||
- {% data variables.product.prodname_actions %} to run a SARIF-compatible analysis tool, you could update the workflow to include a final step that uploads the results (see below).
|
- {% data variables.product.prodname_actions %} to run a SARIF-compatible analysis tool, you could update the workflow to include a final step that uploads the results (see below).
|
||||||
- The {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_code_scanning %} in your CI system, you can use the CLI to upload results to {% data variables.product.prodname_dotcom %} (for more information, see "[Installing {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)").{% if codeql-runner-supported %}
|
- The {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_code_scanning %} in your CI system, you can use the CLI to upload results to {% data variables.product.prodname_dotcom %} (for more information, see "[Installing {% data variables.product.prodname_codeql_cli %} in your CI system](/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)").{% ifversion codeql-runner-supported %}
|
||||||
- The {% data variables.product.prodname_codeql_runner %}, to run {% data variables.product.prodname_code_scanning %} in your CI system, by default the runner automatically uploads results to {% data variables.product.prodname_dotcom %} on completion. If you block the automatic upload, when you are ready to upload results you can use the `upload` command (for more information, see "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)").{% endif %}
|
- The {% data variables.product.prodname_codeql_runner %}, to run {% data variables.product.prodname_code_scanning %} in your CI system, by default the runner automatically uploads results to {% data variables.product.prodname_dotcom %} on completion. If you block the automatic upload, when you are ready to upload results you can use the `upload` command (for more information, see "[Running {% data variables.product.prodname_codeql_runner %} in your CI system](/code-security/secure-coding/running-codeql-runner-in-your-ci-system)").{% endif %}
|
||||||
- A tool that generates results as an artifact outside of your repository, you can use the {% data variables.product.prodname_code_scanning %} API to upload the file (for more information, see "[Upload an analysis as SARIF data](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)").
|
- A tool that generates results as an artifact outside of your repository, you can use the {% data variables.product.prodname_code_scanning %} API to upload the file (for more information, see "[Upload an analysis as SARIF data](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data)").
|
||||||
|
|
||||||
|
|||||||
@@ -147,10 +147,10 @@ $
|
|||||||
## Analyzing a {% data variables.product.prodname_codeql %} database
|
## Analyzing a {% data variables.product.prodname_codeql %} database
|
||||||
|
|
||||||
1. Create a {% data variables.product.prodname_codeql %} database (see above).
|
1. Create a {% data variables.product.prodname_codeql %} database (see above).
|
||||||
2. Run `codeql database analyze` on the database and specify which {% if codeql-packs %}packs and/or {% endif %}queries to use.
|
2. Run `codeql database analyze` on the database and specify which {% ifversion codeql-packs %}packs and/or {% endif %}queries to use.
|
||||||
```shell
|
```shell
|
||||||
codeql database analyze <database> --format=<format> \
|
codeql database analyze <database> --format=<format> \
|
||||||
--output=<output> {% if codeql-packs %}--download <packs,queries>{% else %}<queries>{% endif %}
|
--output=<output> {% ifversion codeql-packs %}--download <packs,queries>{% else %}<queries>{% endif %}
|
||||||
```
|
```
|
||||||
|
|
||||||
{% ifversion fpt or ghes > 3.1 or ghae or ghec %}
|
{% ifversion fpt or ghes > 3.1 or ghae or ghec %}
|
||||||
@@ -161,7 +161,7 @@ $
|
|||||||
```shell
|
```shell
|
||||||
codeql database analyze <database> --format=<format> \
|
codeql database analyze <database> --format=<format> \
|
||||||
--sarif-category=<language-specifier> --output=<output> \
|
--sarif-category=<language-specifier> --output=<output> \
|
||||||
{% if codeql-packs %}<packs,queries>{% else %}<queries>{% endif %}
|
{% ifversion codeql-packs %}<packs,queries>{% else %}<queries>{% endif %}
|
||||||
```
|
```
|
||||||
{% endnote %}
|
{% endnote %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
@@ -173,7 +173,7 @@ codeql database analyze <database> --format=<format> \
|
|||||||
| <nobr>`--format`</nobr> | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the format for the results file generated by the command. For upload to {% data variables.product.company_short %} this should be: {% ifversion fpt or ghae or ghec %}`sarif-latest`{% else %}`sarifv2.1.0`{% endif %}. For more information, see "[SARIF support for {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/sarif-support-for-code-scanning)."
|
| <nobr>`--format`</nobr> | {% octicon "check-circle-fill" aria-label="Required" %} | Specify the format for the results file generated by the command. For upload to {% data variables.product.company_short %} this should be: {% ifversion fpt or ghae or ghec %}`sarif-latest`{% else %}`sarifv2.1.0`{% endif %}. For more information, see "[SARIF support for {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/sarif-support-for-code-scanning)."
|
||||||
| <nobr>`--output`</nobr> | {% octicon "check-circle-fill" aria-label="Required" %} | Specify where to save the SARIF results file.{% ifversion fpt or ghes > 3.1 or ghae or ghec %}
|
| <nobr>`--output`</nobr> | {% octicon "check-circle-fill" aria-label="Required" %} | Specify where to save the SARIF results file.{% ifversion fpt or ghes > 3.1 or ghae or ghec %}
|
||||||
| <nobr>`--sarif-category`<nobr> | {% octicon "question" aria-label="Required with multiple results sets" %} | Optional for single database analysis. Required to define the language when you analyze multiple databases for a single commit in a repository. Specify a category to include in the SARIF results file for this analysis. A category is used to distinguish multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.|{% endif %}{% ifversion fpt or ghes > 3.3 or ghae or ghec %}
|
| <nobr>`--sarif-category`<nobr> | {% octicon "question" aria-label="Required with multiple results sets" %} | Optional for single database analysis. Required to define the language when you analyze multiple databases for a single commit in a repository. Specify a category to include in the SARIF results file for this analysis. A category is used to distinguish multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.|{% endif %}{% ifversion fpt or ghes > 3.3 or ghae or ghec %}
|
||||||
| <nobr>`--sarif-add-query-help`</nobr> | | Optional. Use if you want to include any available markdown-rendered query help for custom queries used in your analysis. Any query help for custom queries included in the SARIF output will be displayed in the code scanning UI if the relevant query generates an alert. For more information, see [Analyzing databases with the {% data variables.product.prodname_codeql_cli %}](https://codeql.github.com/docs/codeql-cli/analyzing-databases-with-the-codeql-cli/#including-query-help-for-custom-codeql-queries-in-sarif-files) in the documentation for the {% data variables.product.prodname_codeql_cli %}.{% endif %}{% if codeql-packs %}
|
| <nobr>`--sarif-add-query-help`</nobr> | | Optional. Use if you want to include any available markdown-rendered query help for custom queries used in your analysis. Any query help for custom queries included in the SARIF output will be displayed in the code scanning UI if the relevant query generates an alert. For more information, see [Analyzing databases with the {% data variables.product.prodname_codeql_cli %}](https://codeql.github.com/docs/codeql-cli/analyzing-databases-with-the-codeql-cli/#including-query-help-for-custom-codeql-queries-in-sarif-files) in the documentation for the {% data variables.product.prodname_codeql_cli %}.{% endif %}{% ifversion codeql-packs %}
|
||||||
| `<packs>` | | Optional. Use if you want to include CodeQL query packs in your analysis. For more information, see "[Downloading and using {% data variables.product.prodname_codeql %} packs](#downloading-and-using-codeql-query-packs)."
|
| `<packs>` | | Optional. Use if you want to include CodeQL query packs in your analysis. For more information, see "[Downloading and using {% data variables.product.prodname_codeql %} packs](#downloading-and-using-codeql-query-packs)."
|
||||||
| <nobr>`--download`</nobr> | | Optional. Use if some of your CodeQL query packs are not yet on disk and need to be downloaded before running queries.{% endif %}
|
| <nobr>`--download`</nobr> | | Optional. Use if some of your CodeQL query packs are not yet on disk and need to be downloaded before running queries.{% endif %}
|
||||||
| <nobr>`--threads`</nobr> | | Optional. Use if you want to use more than one thread to run queries. The default value is `1`. You can specify more threads to speed up query execution. To set the number of threads to the number of logical processors, specify `0`.
|
| <nobr>`--threads`</nobr> | | Optional. Use if you want to use more than one thread to run queries. The default value is `1`. You can specify more threads to speed up query execution. To set the number of threads to the number of logical processors, specify `0`.
|
||||||
@@ -239,7 +239,7 @@ $ echo $UPLOAD_TOKEN | codeql github upload-results --repository=my-org/example-
|
|||||||
|
|
||||||
There is no output from this command unless the upload was unsuccessful. The command prompt returns when the upload is complete and data processing has begun. On smaller codebases, you should be able to explore the {% data variables.product.prodname_code_scanning %} alerts in {% data variables.product.product_name %} shortly afterward. You can see alerts directly in the pull request or on the **Security** tab for branches, depending on the code you checked out. For more information, see "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)" and "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)."
|
There is no output from this command unless the upload was unsuccessful. The command prompt returns when the upload is complete and data processing has begun. On smaller codebases, you should be able to explore the {% data variables.product.prodname_code_scanning %} alerts in {% data variables.product.product_name %} shortly afterward. You can see alerts directly in the pull request or on the **Security** tab for branches, depending on the code you checked out. For more information, see "[Triaging {% data variables.product.prodname_code_scanning %} alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)" and "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)."
|
||||||
|
|
||||||
{% if codeql-packs %}
|
{% ifversion codeql-packs %}
|
||||||
## Downloading and using {% data variables.product.prodname_codeql %} query packs
|
## Downloading and using {% data variables.product.prodname_codeql %} query packs
|
||||||
|
|
||||||
{% data reusables.code-scanning.beta-codeql-packs-cli %}
|
{% data reusables.code-scanning.beta-codeql-packs-cli %}
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ topics:
|
|||||||
|
|
||||||
<!--UI-LINK: When GitHub Enterprise Server <=3.0 doesn't have GitHub Actions set up, the Security > Code scanning alerts view links to this article.-->
|
<!--UI-LINK: When GitHub Enterprise Server <=3.0 doesn't have GitHub Actions set up, the Security > Code scanning alerts view links to this article.-->
|
||||||
|
|
||||||
{% if codeql-runner-supported %}
|
{% ifversion codeql-runner-supported %}
|
||||||
|
|
||||||
{% data reusables.code-scanning.deprecation-codeql-runner %}
|
{% data reusables.code-scanning.deprecation-codeql-runner %}
|
||||||
{% data reusables.code-scanning.beta %}
|
{% data reusables.code-scanning.beta %}
|
||||||
|
|||||||
@@ -44,7 +44,7 @@ You can enable automatic security updates for any repository that uses {% data v
|
|||||||
Each {% data variables.product.prodname_dependabot %} alert has a unique numeric identifier and the {% data variables.product.prodname_dependabot_alerts %} tab lists an alert for every detected vulnerability. Legacy {% data variables.product.prodname_dependabot_alerts %} grouped vulnerabilities by dependency and generated a single alert per dependency. If you navigate to a legacy {% data variables.product.prodname_dependabot %} alert, you will be redirected to a {% data variables.product.prodname_dependabot_alerts %} tab filtered for that package. {% endif %}
|
Each {% data variables.product.prodname_dependabot %} alert has a unique numeric identifier and the {% data variables.product.prodname_dependabot_alerts %} tab lists an alert for every detected vulnerability. Legacy {% data variables.product.prodname_dependabot_alerts %} grouped vulnerabilities by dependency and generated a single alert per dependency. If you navigate to a legacy {% data variables.product.prodname_dependabot %} alert, you will be redirected to a {% data variables.product.prodname_dependabot_alerts %} tab filtered for that package. {% endif %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if dependabot-alerts-vulnerable-calls %}
|
{% ifversion dependabot-alerts-vulnerable-calls %}
|
||||||
## About the detection of calls to vulnerable functions
|
## About the detection of calls to vulnerable functions
|
||||||
|
|
||||||
{% data reusables.dependabot.vulnerable-calls-beta %}
|
{% data reusables.dependabot.vulnerable-calls-beta %}
|
||||||
@@ -101,7 +101,7 @@ If a patched version is available, you can generate a {% data variables.product.
|
|||||||
|
|
||||||
In cases where a patched version is not available, or you can’t update to the secure version, {% data variables.product.prodname_dependabot %} shares additional information to help you determine next steps. When you click through to view a {% data variables.product.prodname_dependabot %} alert, you can see the full details of the security advisory for the dependency including the affected functions. You can then check whether your code calls the impacted functions. This information can help you further assess your risk level, and determine workarounds or if you’re able to accept the risk represented by the security vulnerability.
|
In cases where a patched version is not available, or you can’t update to the secure version, {% data variables.product.prodname_dependabot %} shares additional information to help you determine next steps. When you click through to view a {% data variables.product.prodname_dependabot %} alert, you can see the full details of the security advisory for the dependency including the affected functions. You can then check whether your code calls the impacted functions. This information can help you further assess your risk level, and determine workarounds or if you’re able to accept the risk represented by the security vulnerability.
|
||||||
|
|
||||||
{% if dependabot-alerts-vulnerable-calls %}
|
{% ifversion dependabot-alerts-vulnerable-calls %}
|
||||||
|
|
||||||
For supported languages, {% data variables.product.prodname_dependabot %} detects calls to vulnerable functions for you. When you view an alert labeled as "Vulnerable call", the details include the name of the function and a link to the code that calls it. Often you will be able to take decisions based on this information, without exploring further.
|
For supported languages, {% data variables.product.prodname_dependabot %} detects calls to vulnerable functions for you. When you view an alert labeled as "Vulnerable call", the details include the name of the function and a link to the code that calls it. Often you will be able to take decisions based on this information, without exploring further.
|
||||||
|
|
||||||
@@ -128,10 +128,10 @@ For supported languages, {% data variables.product.prodname_dependabot %} detect
|
|||||||
If you schedule extensive work to upgrade a dependency, or decide that an alert does not need to be fixed, you can dismiss the alert. Dismissing alerts that you have already assessed makes it easier to triage new alerts as they appear.
|
If you schedule extensive work to upgrade a dependency, or decide that an alert does not need to be fixed, you can dismiss the alert. Dismissing alerts that you have already assessed makes it easier to triage new alerts as they appear.
|
||||||
|
|
||||||
1. View the details for an alert. For more information, see "[Viewing vulnerable dependencies](#viewing-vulnerable-dependencies)" (above).
|
1. View the details for an alert. For more information, see "[Viewing vulnerable dependencies](#viewing-vulnerable-dependencies)" (above).
|
||||||
1. Select the "Dismiss" dropdown, and click a reason for dismissing the alert.{% if reopen-dependabot-alerts %} Unfixed dismissed alerts can be reopened later.{% endif %}
|
1. Select the "Dismiss" dropdown, and click a reason for dismissing the alert.{% ifversion reopen-dependabot-alerts %} Unfixed dismissed alerts can be reopened later.{% endif %}
|
||||||

|

|
||||||
|
|
||||||
{% if reopen-dependabot-alerts %}
|
{% ifversion reopen-dependabot-alerts %}
|
||||||
|
|
||||||
## Viewing and updating closed alerts
|
## Viewing and updating closed alerts
|
||||||
|
|
||||||
|
|||||||
@@ -298,7 +298,7 @@ For more information about the `@dependabot ignore` commands, see "[Managing pul
|
|||||||
|
|
||||||
You can use the `ignore` option to customize which dependencies are updated. The `ignore` option supports the following options.
|
You can use the `ignore` option to customize which dependencies are updated. The `ignore` option supports the following options.
|
||||||
|
|
||||||
- `dependency-name`—use to ignore updates for dependencies with matching names, optionally using `*` to match zero or more characters. For Java dependencies, the format of the `dependency-name` attribute is: `groupId:artifactId` (for example: `org.kohsuke:github-api`). {% if dependabot-grouped-dependencies %} To prevent {% data variables.product.prodname_dependabot %} from automatically updating TypeScript type definitions from DefinitelyTyped, use `@types/*`.{% endif %}
|
- `dependency-name`—use to ignore updates for dependencies with matching names, optionally using `*` to match zero or more characters. For Java dependencies, the format of the `dependency-name` attribute is: `groupId:artifactId` (for example: `org.kohsuke:github-api`). {% ifversion dependabot-grouped-dependencies %} To prevent {% data variables.product.prodname_dependabot %} from automatically updating TypeScript type definitions from DefinitelyTyped, use `@types/*`.{% endif %}
|
||||||
- `versions`—use to ignore specific versions or ranges of versions. If you want to define a range, use the standard pattern for the package manager (for example: `^1.0.0` for npm, or `~> 2.0` for Bundler).
|
- `versions`—use to ignore specific versions or ranges of versions. If you want to define a range, use the standard pattern for the package manager (for example: `^1.0.0` for npm, or `~> 2.0` for Bundler).
|
||||||
- `update-types`—use to ignore types of updates, such as semver `major`, `minor`, or `patch` updates on version updates (for example: `version-update:semver-patch` will ignore patch updates). You can combine this with `dependency-name: "*"` to ignore particular `update-types` for all dependencies. Currently, `version-update:semver-major`, `version-update:semver-minor`, and `version-update:semver-patch` are the only supported options. Security updates are unaffected by this setting.
|
- `update-types`—use to ignore types of updates, such as semver `major`, `minor`, or `patch` updates on version updates (for example: `version-update:semver-patch` will ignore patch updates). You can combine this with `dependency-name: "*"` to ignore particular `update-types` for all dependencies. Currently, `version-update:semver-major`, `version-update:semver-minor`, and `version-update:semver-patch` are the only supported options. Security updates are unaffected by this setting.
|
||||||
|
|
||||||
|
|||||||
@@ -35,7 +35,7 @@ You enable {% data variables.product.prodname_dependabot_version_updates %} by c
|
|||||||
## Enabling {% data variables.product.prodname_dependabot_version_updates %}
|
## Enabling {% data variables.product.prodname_dependabot_version_updates %}
|
||||||
|
|
||||||
You enable {% data variables.product.prodname_dependabot_version_updates %} by commiting a *dependabot.yml* configuration file to your repository.
|
You enable {% data variables.product.prodname_dependabot_version_updates %} by commiting a *dependabot.yml* configuration file to your repository.
|
||||||
{% if dependabot-settings-update-37 %}If you enable the feature in your settings page, GitHub creates a basic file which you can edit, otherwise you can create the file using any file editor.
|
{% ifversion dependabot-settings-update-37 %}If you enable the feature in your settings page, GitHub creates a basic file which you can edit, otherwise you can create the file using any file editor.
|
||||||
|
|
||||||
{% data reusables.repositories.navigate-to-repo %}
|
{% data reusables.repositories.navigate-to-repo %}
|
||||||
{% data reusables.repositories.sidebar-settings %}
|
{% data reusables.repositories.sidebar-settings %}
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ This guide shows you how to configure security features for an organization. You
|
|||||||
|
|
||||||
## Managing access to your organization
|
## Managing access to your organization
|
||||||
|
|
||||||
You can use roles to control what actions people can take in your organization. {% if security-managers %}For example, you can assign the security manager role to a team to give them the ability to manage security settings across your organization, as well as read access to all repositories.{% endif %} For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)."
|
You can use roles to control what actions people can take in your organization. {% ifversion security-managers %}For example, you can assign the security manager role to a team to give them the ability to manage security settings across your organization, as well as read access to all repositories.{% endif %} For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)."
|
||||||
|
|
||||||
{% ifversion fpt or ghes > 3.0 or ghec %}
|
{% ifversion fpt or ghes > 3.0 or ghec %}
|
||||||
|
|
||||||
|
|||||||
@@ -111,7 +111,7 @@ For more information, see "[About {% data variables.product.prodname_dependabot_
|
|||||||
|
|
||||||
You can enable {% data variables.product.prodname_dependabot %} to automatically raise pull requests to keep your dependencies up-to-date. For more information, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/code-security/supply-chain-security/about-dependabot-version-updates)."
|
You can enable {% data variables.product.prodname_dependabot %} to automatically raise pull requests to keep your dependencies up-to-date. For more information, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/code-security/supply-chain-security/about-dependabot-version-updates)."
|
||||||
|
|
||||||
{% if dependabot-settings-update-37 %}
|
{% ifversion dependabot-settings-update-37 %}
|
||||||
1. From the main page of your repository, click **{% octicon "gear" aria-label="The Settings gear" %} Settings**.
|
1. From the main page of your repository, click **{% octicon "gear" aria-label="The Settings gear" %} Settings**.
|
||||||
2. Click **Security & analysis**.
|
2. Click **Security & analysis**.
|
||||||
3. Next to {% data variables.product.prodname_dependabot_version_updates %}, click **Enable** to create a basic *dependabot.yml* configuration file.
|
3. Next to {% data variables.product.prodname_dependabot_version_updates %}, click **Enable** to create a basic *dependabot.yml* configuration file.
|
||||||
|
|||||||
@@ -37,7 +37,7 @@ If your project communicates with an external service, you might use a token or
|
|||||||
|
|
||||||
Service providers can partner with {% data variables.product.company_short %} to provide their secret formats for scanning. {% data reusables.secret-scanning.partner-program-link %}
|
Service providers can partner with {% data variables.product.company_short %} to provide their secret formats for scanning. {% data reusables.secret-scanning.partner-program-link %}
|
||||||
|
|
||||||
{% if secret-scanning-push-protection %}
|
{% ifversion secret-scanning-push-protection %}
|
||||||
|
|
||||||
You can also enable {% data variables.product.prodname_secret_scanning %} as a push protection for a repository or an organization. When you enable this feature, {% data variables.product.prodname_secret_scanning %} prevents contributors from pushing code with a detected secret. To proceed, contributors must either remove the secret(s) from the push or, if needed, bypass the protection. For more information, see "[Protecting pushes with {% data variables.product.prodname_secret_scanning %}](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)."
|
You can also enable {% data variables.product.prodname_secret_scanning %} as a push protection for a repository or an organization. When you enable this feature, {% data variables.product.prodname_secret_scanning %} prevents contributors from pushing code with a detected secret. To proceed, contributors must either remove the secret(s) from the push or, if needed, bypass the protection. For more information, see "[Protecting pushes with {% data variables.product.prodname_secret_scanning %}](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)."
|
||||||
|
|
||||||
|
|||||||
@@ -35,7 +35,7 @@ You can enable {% data variables.product.prodname_secret_scanning_GHAS %} for an
|
|||||||
5. Review the impact of enabling {% data variables.product.prodname_advanced_security %}, then click **Enable {% data variables.product.prodname_GH_advanced_security %} for this repository**.
|
5. Review the impact of enabling {% data variables.product.prodname_advanced_security %}, then click **Enable {% data variables.product.prodname_GH_advanced_security %} for this repository**.
|
||||||
6. When you enable {% data variables.product.prodname_advanced_security %}, {% data variables.product.prodname_secret_scanning %} may automatically be enabled for the repository due to the organization's settings. If "{% data variables.product.prodname_secret_scanning_caps %}" is shown with an **Enable** button, you still need to enable {% data variables.product.prodname_secret_scanning %} by clicking **Enable**. If you see a **Disable** button, {% data variables.product.prodname_secret_scanning %} is already enabled.
|
6. When you enable {% data variables.product.prodname_advanced_security %}, {% data variables.product.prodname_secret_scanning %} may automatically be enabled for the repository due to the organization's settings. If "{% data variables.product.prodname_secret_scanning_caps %}" is shown with an **Enable** button, you still need to enable {% data variables.product.prodname_secret_scanning %} by clicking **Enable**. If you see a **Disable** button, {% data variables.product.prodname_secret_scanning %} is already enabled.
|
||||||

|

|
||||||
{% if secret-scanning-push-protection %}
|
{% ifversion secret-scanning-push-protection %}
|
||||||
7. Optionally, if you want to enable push protection, click **Enable** to the right of "Push protection." {% data reusables.secret-scanning.push-protection-overview %} For more information, see "[Protecting pushes with {% data variables.product.prodname_secret_scanning %}](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)."
|
7. Optionally, if you want to enable push protection, click **Enable** to the right of "Push protection." {% data reusables.secret-scanning.push-protection-overview %} For more information, see "[Protecting pushes with {% data variables.product.prodname_secret_scanning %}](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)."
|
||||||

|

|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|||||||
@@ -122,7 +122,7 @@ Before defining a custom pattern, you must ensure that you enable {% data variab
|
|||||||
{% data reusables.repositories.navigate-to-ghas-settings %}
|
{% data reusables.repositories.navigate-to-ghas-settings %}
|
||||||
{% data reusables.advanced-security.secret-scanning-new-custom-pattern %}
|
{% data reusables.advanced-security.secret-scanning-new-custom-pattern %}
|
||||||
{% data reusables.advanced-security.secret-scanning-add-custom-pattern-details %}
|
{% data reusables.advanced-security.secret-scanning-add-custom-pattern-details %}
|
||||||
{%- if secret-scanning-org-dry-runs %}
|
{%- ifversion secret-scanning-org-dry-runs %}
|
||||||
1. When you're ready to test your new custom pattern, to identify matches in select repositories without creating alerts, click **Save and dry run**.
|
1. When you're ready to test your new custom pattern, to identify matches in select repositories without creating alerts, click **Save and dry run**.
|
||||||
{% data reusables.advanced-security.secret-scanning-dry-run-select-repos %}
|
{% data reusables.advanced-security.secret-scanning-dry-run-select-repos %}
|
||||||
{% data reusables.advanced-security.secret-scanning-dry-run-results %}
|
{% data reusables.advanced-security.secret-scanning-dry-run-results %}
|
||||||
@@ -141,7 +141,7 @@ Before defining a custom pattern, you must ensure that you enable secret scannin
|
|||||||
|
|
||||||
{% note %}
|
{% note %}
|
||||||
|
|
||||||
{% if secret-scanning-enterprise-dry-runs %}
|
{% ifversion secret-scanning-enterprise-dry-runs %}
|
||||||
**Notes:**
|
**Notes:**
|
||||||
- At the enterprise level, only the creator of a custom pattern can edit the pattern, and use it in a dry run.
|
- At the enterprise level, only the creator of a custom pattern can edit the pattern, and use it in a dry run.
|
||||||
- Enterprise owners can only make use of dry runs on repositories that they have access to, and enterprise owners do not necessarily have access to all the organizations or repositories within the enterprise.
|
- Enterprise owners can only make use of dry runs on repositories that they have access to, and enterprise owners do not necessarily have access to all the organizations or repositories within the enterprise.
|
||||||
@@ -158,7 +158,7 @@ Before defining a custom pattern, you must ensure that you enable secret scannin
|
|||||||
{% data reusables.enterprise-accounts.advanced-security-security-features %}
|
{% data reusables.enterprise-accounts.advanced-security-security-features %}
|
||||||
1. Under "Secret scanning custom patterns", click {% ifversion ghes = 3.2 %}**New custom pattern**{% else %}**New pattern**{% endif %}.
|
1. Under "Secret scanning custom patterns", click {% ifversion ghes = 3.2 %}**New custom pattern**{% else %}**New pattern**{% endif %}.
|
||||||
{% data reusables.advanced-security.secret-scanning-add-custom-pattern-details %}
|
{% data reusables.advanced-security.secret-scanning-add-custom-pattern-details %}
|
||||||
{%- if secret-scanning-enterprise-dry-runs %}
|
{%- ifversion secret-scanning-enterprise-dry-runs %}
|
||||||
1. When you're ready to test your new custom pattern, to identify matches in the repository without creating alerts, click **Save and dry run**.
|
1. When you're ready to test your new custom pattern, to identify matches in the repository without creating alerts, click **Save and dry run**.
|
||||||
{% data reusables.advanced-security.secret-scanning-dry-run-select-repos %}
|
{% data reusables.advanced-security.secret-scanning-dry-run-select-repos %}
|
||||||
{% data reusables.advanced-security.secret-scanning-dry-run-results %}
|
{% data reusables.advanced-security.secret-scanning-dry-run-results %}
|
||||||
|
|||||||
@@ -84,7 +84,7 @@ If you confirm a secret is real and that you intend to fix it later, you should
|
|||||||
1. Click **Allow me to push this secret**.
|
1. Click **Allow me to push this secret**.
|
||||||
2. Reattempt the push on the command line within three hours. If you have not pushed within three hours, you will need to repeat this process.
|
2. Reattempt the push on the command line within three hours. If you have not pushed within three hours, you will need to repeat this process.
|
||||||
|
|
||||||
{% if secret-scanning-push-protection-web-ui %}
|
{% ifversion secret-scanning-push-protection-web-ui %}
|
||||||
## Using secret scanning as a push protection from the web UI
|
## Using secret scanning as a push protection from the web UI
|
||||||
|
|
||||||
When you use the web UI to attempt to commit a supported secret to a repository or organization with secret scanning as a push protection enabled, {% data variables.product.prodname_dotcom %} will block the commit. You will see a banner at the top of the page with information about the secret's location, and the secret will also be underlined in the file so you can easily find it.
|
When you use the web UI to attempt to commit a supported secret to a repository or organization with secret scanning as a push protection enabled, {% data variables.product.prodname_dotcom %} will block the commit. You will see a banner at the top of the page with information about the secret's location, and the secret will also be underlined in the file so you can easily find it.
|
||||||
|
|||||||
@@ -41,7 +41,7 @@ The application security team at your company can use the security overview for
|
|||||||
|
|
||||||
In the security overview, you can view, sort, and filter alerts to understand the security risks in your organization and in specific repositories. The security summary is highly interactive, allowing you to investigate specific categories of information, based on qualifiers like alert risk level, alert type, and feature enablement. You can also apply multiple filters to focus on narrower areas of interest. For example, you can identify private repositories that have a high number of {% data variables.product.prodname_dependabot_alerts %} or repositories that have no {% data variables.product.prodname_code_scanning %} alerts. For more information, see "[Filtering alerts in the security overview](/code-security/security-overview/filtering-alerts-in-the-security-overview)."
|
In the security overview, you can view, sort, and filter alerts to understand the security risks in your organization and in specific repositories. The security summary is highly interactive, allowing you to investigate specific categories of information, based on qualifiers like alert risk level, alert type, and feature enablement. You can also apply multiple filters to focus on narrower areas of interest. For example, you can identify private repositories that have a high number of {% data variables.product.prodname_dependabot_alerts %} or repositories that have no {% data variables.product.prodname_code_scanning %} alerts. For more information, see "[Filtering alerts in the security overview](/code-security/security-overview/filtering-alerts-in-the-security-overview)."
|
||||||
|
|
||||||
{% if security-overview-views %}
|
{% ifversion security-overview-views %}
|
||||||
|
|
||||||
In the security overview, at both the organization and repository level, there are dedicated views for specific security features, such as secret scanning alerts and code scanning alerts. You can use these views to limit your analysis to a specific set of alerts, and narrow the results further with a range of filters specific to each view. For example, in the secret scanning alert view, you can use the `Secret type` filter to view only secret scanning alerts for a specific secret, like a GitHub Personal Access Token. At the repository level, you can use the security overview to assess the specific repository's current security status, and configure any additional security features not yet in use on the repository.
|
In the security overview, at both the organization and repository level, there are dedicated views for specific security features, such as secret scanning alerts and code scanning alerts. You can use these views to limit your analysis to a specific set of alerts, and narrow the results further with a range of filters specific to each view. For example, in the secret scanning alert view, you can use the `Secret type` filter to view only secret scanning alerts for a specific secret, like a GitHub Personal Access Token. At the repository level, you can use the security overview to assess the specific repository's current security status, and configure any additional security features not yet in use on the repository.
|
||||||
|
|
||||||
|
|||||||
@@ -102,7 +102,7 @@ Available in the organization-level overview.
|
|||||||
| -------- | -------- |
|
| -------- | -------- |
|
||||||
| <code>topic:<em>TOPIC-NAME</em></code> | Displays repositories that are classified with *TOPIC-NAME*. |
|
| <code>topic:<em>TOPIC-NAME</em></code> | Displays repositories that are classified with *TOPIC-NAME*. |
|
||||||
|
|
||||||
{% if security-overview-views %}
|
{% ifversion security-overview-views %}
|
||||||
|
|
||||||
## Filter by severity
|
## Filter by severity
|
||||||
|
|
||||||
@@ -118,7 +118,7 @@ Available in the code scanning alert views. All code scanning alerts have one of
|
|||||||
|`severity:warning`|Displays {% data variables.product.prodname_code_scanning %} alerts categorized as warnings.|
|
|`severity:warning`|Displays {% data variables.product.prodname_code_scanning %} alerts categorized as warnings.|
|
||||||
|`severity:note`|Displays {% data variables.product.prodname_code_scanning %} alerts categorized as notes.|
|
|`severity:note`|Displays {% data variables.product.prodname_code_scanning %} alerts categorized as notes.|
|
||||||
|
|
||||||
{% if dependabot-alerts-vulnerable-calls %}
|
{% ifversion dependabot-alerts-vulnerable-calls %}
|
||||||
## Filter by {% data variables.product.prodname_dependabot %} alert type
|
## Filter by {% data variables.product.prodname_dependabot %} alert type
|
||||||
|
|
||||||
Available in the {% data variables.product.prodname_dependabot %} alert views. 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.
|
Available in the {% data variables.product.prodname_dependabot %} alert views. 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.
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ shortTitle: View the security overview
|
|||||||
1. To view aggregate information about alert types, click **Show more**.
|
1. To view aggregate information about alert types, click **Show more**.
|
||||||

|

|
||||||
{% data reusables.organizations.filter-security-overview %}
|
{% data reusables.organizations.filter-security-overview %}
|
||||||
{% if security-overview-views %}
|
{% ifversion security-overview-views %}
|
||||||
{% data reusables.organizations.security-overview-feature-specific-page %}
|
{% data reusables.organizations.security-overview-feature-specific-page %}
|
||||||

|

|
||||||
|
|
||||||
@@ -46,7 +46,7 @@ shortTitle: View the security overview
|
|||||||
|
|
||||||
{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}
|
{% data reusables.enterprise-accounts.access-enterprise-on-dotcom %}
|
||||||
1. In the left sidebar, click {% octicon "shield" aria-label="The shield icon" %} **Code Security**.
|
1. In the left sidebar, click {% octicon "shield" aria-label="The shield icon" %} **Code Security**.
|
||||||
{% if security-overview-feature-specific-alert-page %}
|
{% ifversion security-overview-feature-specific-alert-page %}
|
||||||
{% data reusables.organizations.security-overview-feature-specific-page %}
|
{% data reusables.organizations.security-overview-feature-specific-page %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|||||||
@@ -67,12 +67,12 @@ The recommended formats explicitly define which versions are used for all direct
|
|||||||
|
|
||||||
| Package manager | Languages | Recommended formats | All supported formats |
|
| Package manager | Languages | Recommended formats | All supported formats |
|
||||||
| --- | --- | --- | ---|
|
| --- | --- | --- | ---|
|
||||||
{%- if dependency-graph-rust-support %}
|
{%- ifversion dependency-graph-rust-support %}
|
||||||
| Cargo<sup>[*]</sup> | Rust | `Cargo.lock` | `Cargo.toml`, `Cargo.lock` |
|
| Cargo<sup>[*]</sup> | Rust | `Cargo.lock` | `Cargo.toml`, `Cargo.lock` |
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
| Composer | PHP | `composer.lock` | `composer.json`, `composer.lock` |
|
| Composer | PHP | `composer.lock` | `composer.json`, `composer.lock` |
|
||||||
| NuGet | .NET languages (C#, F#, VB), C++ | `.csproj`, `.vbproj`, `.nuspec`, `.vcxproj`, `.fsproj` | `.csproj`, `.vbproj`, `.nuspec`, `.vcxproj`, `.fsproj`, `packages.config` |
|
| NuGet | .NET languages (C#, F#, VB), C++ | `.csproj`, `.vbproj`, `.nuspec`, `.vcxproj`, `.fsproj` | `.csproj`, `.vbproj`, `.nuspec`, `.vcxproj`, `.fsproj`, `packages.config` |
|
||||||
{%- if github-actions-in-dependency-graph %}
|
{%- ifversion github-actions-in-dependency-graph %}
|
||||||
| {% data variables.product.prodname_actions %} workflows<sup>[†]</sup> | YAML | `.yml`, `.yaml` | `.yml`, `.yaml` |
|
| {% data variables.product.prodname_actions %} workflows<sup>[†]</sup> | YAML | `.yml`, `.yaml` | `.yml`, `.yaml` |
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
{%- ifversion fpt or ghec or ghes > 3.2 or ghae %}
|
{%- ifversion fpt or ghec or ghes > 3.2 or ghae %}
|
||||||
@@ -89,17 +89,17 @@ The recommended formats explicitly define which versions are used for all direct
|
|||||||
| RubyGems | Ruby | `Gemfile.lock` | `Gemfile.lock`, `Gemfile`, `*.gemspec` |
|
| RubyGems | Ruby | `Gemfile.lock` | `Gemfile.lock`, `Gemfile`, `*.gemspec` |
|
||||||
| Yarn | JavaScript | `yarn.lock` | `package.json`, `yarn.lock` |
|
| Yarn | JavaScript | `yarn.lock` | `package.json`, `yarn.lock` |
|
||||||
|
|
||||||
{% if dependency-graph-rust-support %}
|
{% ifversion dependency-graph-rust-support %}
|
||||||
[*] For the initial release of Rust support, dependency graph does not have the metadata and mappings required to detect transitive dependencies. Dependency graph displays transitive dependencies, one level deep, when they are defined in a `Cargo.lock` file. {% data variables.product.prodname_dependabot_alerts %} and {% data variables.product.prodname_dependabot_security_updates %} are available for vulnerable dependencies defined in the `Cargo.lock` file.
|
[*] For the initial release of Rust support, dependency graph does not have the metadata and mappings required to detect transitive dependencies. Dependency graph displays transitive dependencies, one level deep, when they are defined in a `Cargo.lock` file. {% data variables.product.prodname_dependabot_alerts %} and {% data variables.product.prodname_dependabot_security_updates %} are available for vulnerable dependencies defined in the `Cargo.lock` file.
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if github-actions-in-dependency-graph %}
|
{% ifversion github-actions-in-dependency-graph %}
|
||||||
[†] {% data variables.product.prodname_actions %} workflows must be located in the `.github/workflows/` directory of a repository to be recognized as manifests. Any actions or workflows referenced using the syntax `jobs[*].steps[*].uses` or `jobs.<job_id>.uses` will be parsed as dependencies. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/using-workflows/workflow-syntax-for-github-actions)."
|
[†] {% data variables.product.prodname_actions %} workflows must be located in the `.github/workflows/` directory of a repository to be recognized as manifests. Any actions or workflows referenced using the syntax `jobs[*].steps[*].uses` or `jobs.<job_id>.uses` will be parsed as dependencies. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/using-workflows/workflow-syntax-for-github-actions)."
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
[‡] If you list your Python dependencies within a `setup.py` file, we may not be able to parse and list every dependency in your project.
|
[‡] If you list your Python dependencies within a `setup.py` file, we may not be able to parse and list every dependency in your project.
|
||||||
|
|
||||||
{% if github-actions-in-dependency-graph %}
|
{% ifversion github-actions-in-dependency-graph %}
|
||||||
{% note %}
|
{% note %}
|
||||||
|
|
||||||
**Note:** {% data variables.product.prodname_actions %} workflow dependencies are displayed in the dependency graph for informational purposes. Dependabot alerts are not currently supported for {% data variables.product.prodname_actions %} workflows.
|
**Note:** {% data variables.product.prodname_actions %} workflow dependencies are displayed in the dependency graph for informational purposes. Dependabot alerts are not currently supported for {% data variables.product.prodname_actions %} workflows.
|
||||||
|
|||||||
@@ -52,7 +52,7 @@ topics:
|
|||||||
1. By default, to improve your app's security, your app will use expiring user authorization tokens. To opt-out of using expiring user tokens, you must deselect "Expire user authorization tokens". To learn more about setting up a refresh token flow and the benefits of expiring user tokens, see "[Refreshing user-to-server access tokens](/apps/building-github-apps/refreshing-user-to-server-access-tokens/)."
|
1. By default, to improve your app's security, your app will use expiring user authorization tokens. To opt-out of using expiring user tokens, you must deselect "Expire user authorization tokens". To learn more about setting up a refresh token flow and the benefits of expiring user tokens, see "[Refreshing user-to-server access tokens](/apps/building-github-apps/refreshing-user-to-server-access-tokens/)."
|
||||||

|

|
||||||
1. If your app authorizes users using the OAuth flow, you can select **Request user authorization (OAuth) during installation** to allow people to authorize the app when they install it, saving a step. If you select this option, the "Setup URL" becomes unavailable and users will be redirected to your "User authorization callback URL" after installing the app. See "[Authorizing users during installation](/apps/installing-github-apps/#authorizing-users-during-installation)" for more information.
|
1. If your app authorizes users using the OAuth flow, you can select **Request user authorization (OAuth) during installation** to allow people to authorize the app when they install it, saving a step. If you select this option, the "Setup URL" becomes unavailable and users will be redirected to your "User authorization callback URL" after installing the app. See "[Authorizing users during installation](/apps/installing-github-apps/#authorizing-users-during-installation)" for more information.
|
||||||
{% if device-flow-is-opt-in %}
|
{% ifversion device-flow-is-opt-in %}
|
||||||
1. If your GitHub App will use the device flow to identify and authorize users, click **Enable Device Flow**. For more information about the device flow, see "[Authorizing OAuth Apps](/developers/apps/building-oauth-apps/authorizing-oauth-apps#device-flow)."
|
1. If your GitHub App will use the device flow to identify and authorize users, click **Enable Device Flow**. For more information about the device flow, see "[Authorizing OAuth Apps](/developers/apps/building-oauth-apps/authorizing-oauth-apps#device-flow)."
|
||||||
{% endif %}
|
{% endif %}
|
||||||
1. If additional setup is required after installation, add a "Setup URL" to redirect users to after they install your app.
|
1. If additional setup is required after installation, add a "Setup URL" to redirect users to after they install your app.
|
||||||
|
|||||||
@@ -126,7 +126,7 @@ curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre
|
|||||||
|
|
||||||
The device flow allows you to authorize users for a headless app, such as a CLI tool or Git credential manager.
|
The device flow allows you to authorize users for a headless app, such as a CLI tool or Git credential manager.
|
||||||
|
|
||||||
{% if device-flow-is-opt-in %}Before you can use the device flow to identify and authorize users, you must first enable it in your app's settings. For more information on enabling device flow, see "[Modifying a GitHub App](/developers/apps/managing-github-apps/modifying-a-github-app)." {% endif %}For more information about authorizing users using the device flow, see "[Authorizing OAuth Apps](/developers/apps/authorizing-oauth-apps#device-flow)."
|
{% ifversion device-flow-is-opt-in %}Before you can use the device flow to identify and authorize users, you must first enable it in your app's settings. For more information on enabling device flow, see "[Modifying a GitHub App](/developers/apps/managing-github-apps/modifying-a-github-app)." {% endif %}For more information about authorizing users using the device flow, see "[Authorizing OAuth Apps](/developers/apps/authorizing-oauth-apps#device-flow)."
|
||||||
|
|
||||||
## Check which installation's resources a user can access
|
## Check which installation's resources a user can access
|
||||||
|
|
||||||
|
|||||||
@@ -125,7 +125,7 @@ curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre
|
|||||||
|
|
||||||
The device flow allows you to authorize users for a headless app, such as a CLI tool or Git credential manager.
|
The device flow allows you to authorize users for a headless app, such as a CLI tool or Git credential manager.
|
||||||
|
|
||||||
{% if device-flow-is-opt-in %}
|
{% ifversion device-flow-is-opt-in %}
|
||||||
|
|
||||||
Before you can use the device flow to authorize and identify users, you must first enable it in your app's settings. For more information about enabling the device flow in your app, see "[Modifying an OAuth App](/developers/apps/managing-oauth-apps/modifying-an-oauth-app)" for OAuth Apps and "[Modifying a GitHub App](/developers/apps/managing-github-apps/modifying-a-github-app)" for GitHub Apps.
|
Before you can use the device flow to authorize and identify users, you must first enable it in your app's settings. For more information about enabling the device flow in your app, see "[Modifying an OAuth App](/developers/apps/managing-oauth-apps/modifying-an-oauth-app)" for OAuth Apps and "[Modifying a GitHub App](/developers/apps/managing-github-apps/modifying-a-github-app)" for GitHub Apps.
|
||||||
|
|
||||||
@@ -260,7 +260,7 @@ If you make more than one access token request (`POST {% data variables.product.
|
|||||||
| `unsupported_grant_type` | The grant type must be `urn:ietf:params:oauth:grant-type:device_code` and included as an input parameter when you poll the OAuth token request `POST {% data variables.product.oauth_host_code %}/login/oauth/access_token`.
|
| `unsupported_grant_type` | The grant type must be `urn:ietf:params:oauth:grant-type:device_code` and included as an input parameter when you poll the OAuth token request `POST {% data variables.product.oauth_host_code %}/login/oauth/access_token`.
|
||||||
| `incorrect_client_credentials` | For the device flow, you must pass your app's client ID, which you can find on your app settings page. The `client_secret` is not needed for the device flow.
|
| `incorrect_client_credentials` | For the device flow, you must pass your app's client ID, which you can find on your app settings page. The `client_secret` is not needed for the device flow.
|
||||||
| `incorrect_device_code` | The device_code provided is not valid.
|
| `incorrect_device_code` | The device_code provided is not valid.
|
||||||
| `access_denied` | When a user clicks cancel during the authorization process, you'll receive a `access_denied` error and the user won't be able to use the verification code again.{% if device-flow-is-opt-in %}
|
| `access_denied` | When a user clicks cancel during the authorization process, you'll receive a `access_denied` error and the user won't be able to use the verification code again.{% ifversion device-flow-is-opt-in %}
|
||||||
| `device_flow_disabled` | Device flow has not been enabled in the app's settings. For more information, see "[Device flow](#device-flow)."{% endif %}
|
| `device_flow_disabled` | Device flow has not been enabled in the app's settings. For more information, see "[Device flow](#device-flow)."{% endif %}
|
||||||
|
|
||||||
For more information, see the "[OAuth 2.0 Device Authorization Grant](https://tools.ietf.org/html/rfc8628#section-3.5)."
|
For more information, see the "[OAuth 2.0 Device Authorization Grant](https://tools.ietf.org/html/rfc8628#section-3.5)."
|
||||||
|
|||||||
@@ -53,7 +53,7 @@ topics:
|
|||||||
**Note:** OAuth Apps cannot have multiple callback URLs, unlike {% data variables.product.prodname_github_apps %}.
|
**Note:** OAuth Apps cannot have multiple callback URLs, unlike {% data variables.product.prodname_github_apps %}.
|
||||||
|
|
||||||
{% endnote %}
|
{% endnote %}
|
||||||
{% endif %}{% if device-flow-is-opt-in %}
|
{% endif %}{% ifversion device-flow-is-opt-in %}
|
||||||
1. If your OAuth App will use the device flow to identify and authorize users, click **Enable Device Flow**. For more information about the device flow, see "[Authorizing OAuth Apps](/developers/apps/building-oauth-apps/authorizing-oauth-apps#device-flow)."
|
1. If your OAuth App will use the device flow to identify and authorize users, click **Enable Device Flow**. For more information about the device flow, see "[Authorizing OAuth Apps](/developers/apps/building-oauth-apps/authorizing-oauth-apps#device-flow)."
|
||||||
{% endif %}
|
{% endif %}
|
||||||
2. Click **Register application**.
|
2. Click **Register application**.
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ topics:
|
|||||||
{% data reusables.user-settings.github_apps %}
|
{% data reusables.user-settings.github_apps %}
|
||||||
{% data reusables.user-settings.modify_github_app %}
|
{% data reusables.user-settings.modify_github_app %}
|
||||||
5. In "Basic information", modify the GitHub App information that you'd like to change.
|
5. In "Basic information", modify the GitHub App information that you'd like to change.
|
||||||
{% if device-flow-is-opt-in %}
|
{% ifversion device-flow-is-opt-in %}
|
||||||
1. If your GitHub App will use the device flow to identify and authorize users, click **Enable device flow**. For more information about the device flow, see "[Authorizing OAuth Apps](/developers/apps/building-oauth-apps/authorizing-oauth-apps#device-flow)."
|
1. If your GitHub App will use the device flow to identify and authorize users, click **Enable device flow**. For more information about the device flow, see "[Authorizing OAuth Apps](/developers/apps/building-oauth-apps/authorizing-oauth-apps#device-flow)."
|
||||||
{% endif %}
|
{% endif %}
|
||||||
6. Click **Save changes**.
|
6. Click **Save changes**.
|
||||||
|
|||||||
@@ -965,7 +965,7 @@ Key | Type | Description
|
|||||||
|
|
||||||
{{ webhookPayloadsForCurrentVersion.project_column.created }}
|
{{ webhookPayloadsForCurrentVersion.project_column.created }}
|
||||||
|
|
||||||
{% if project-beta-webhooks %}
|
{% ifversion project-beta-webhooks %}
|
||||||
|
|
||||||
## projects_v2_item
|
## projects_v2_item
|
||||||
|
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ A {% data variables.product.prodname_GH_advanced_security %} license provides th
|
|||||||
|
|
||||||
- **{% data variables.product.prodname_code_scanning_capc %}** - Search for potential security vulnerabilities and coding errors in your code. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)."
|
- **{% data variables.product.prodname_code_scanning_capc %}** - Search for potential security vulnerabilities and coding errors in your code. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)."
|
||||||
|
|
||||||
- **{% data variables.product.prodname_secret_scanning_caps %}** - Detect secrets, for example keys and tokens, that have been checked into the repository.{% if secret-scanning-push-protection %} If push protection is enabled, also detects secrets when they are pushed to your repository. For more information, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-scanning/about-secret-scanning)" and "[Protecting pushes with {% data variables.product.prodname_secret_scanning %}](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)."{% else %} For more information, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-scanning/about-secret-scanning)."{% endif %}
|
- **{% data variables.product.prodname_secret_scanning_caps %}** - Detect secrets, for example keys and tokens, that have been checked into the repository.{% ifversion secret-scanning-push-protection %} If push protection is enabled, also detects secrets when they are pushed to your repository. For more information, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-scanning/about-secret-scanning)" and "[Protecting pushes with {% data variables.product.prodname_secret_scanning %}](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)."{% else %} For more information, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-scanning/about-secret-scanning)."{% endif %}
|
||||||
|
|
||||||
{% ifversion fpt or ghes > 3.1 or ghec or ghae %}
|
{% ifversion fpt or ghes > 3.1 or ghec or ghae %}
|
||||||
- **Dependency review** - Show the full impact of changes to dependencies and see details of any vulnerable versions before you merge a pull request. For more information, see "[About dependency review](/code-security/supply-chain-security/about-dependency-review)."
|
- **Dependency review** - Show the full impact of changes to dependencies and see details of any vulnerable versions before you merge a pull request. For more information, see "[About dependency review](/code-security/supply-chain-security/about-dependency-review)."
|
||||||
|
|||||||
@@ -18,11 +18,11 @@ versions:
|
|||||||
|
|
||||||
Typing <kbd>?</kbd> on {% data variables.product.prodname_dotcom %} brings up a dialog box that lists the keyboard shortcuts available for that page. You can use these keyboard shortcuts to perform actions across the site without using your mouse to navigate.
|
Typing <kbd>?</kbd> on {% data variables.product.prodname_dotcom %} brings up a dialog box that lists the keyboard shortcuts available for that page. You can use these keyboard shortcuts to perform actions across the site without using your mouse to navigate.
|
||||||
|
|
||||||
{% if keyboard-shortcut-accessibility-setting %}
|
{% ifversion keyboard-shortcut-accessibility-setting %}
|
||||||
You can disable character key shortcuts, while still allowing shortcuts that use modifier keys, in your accessibility settings. For more information, see "[Managing accessibility settings](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-accessibility-settings)."{% endif %}
|
You can disable character key shortcuts, while still allowing shortcuts that use modifier keys, in your accessibility settings. For more information, see "[Managing accessibility settings](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-accessibility-settings)."{% endif %}
|
||||||
|
|
||||||
Below is a list of some of the available keyboard shortcuts.
|
Below is a list of some of the available keyboard shortcuts.
|
||||||
{% if command-palette %}
|
{% ifversion command-palette %}
|
||||||
The {% data variables.product.prodname_command_palette %} also gives you quick access to a wide range of actions, without the need to remember keyboard shortcuts. For more information, see "[{% data variables.product.prodname_command_palette %}](/get-started/using-github/github-command-palette)."{% endif %}
|
The {% data variables.product.prodname_command_palette %} also gives you quick access to a wide range of actions, without the need to remember keyboard shortcuts. For more information, see "[{% data variables.product.prodname_command_palette %}](/get-started/using-github/github-command-palette)."{% endif %}
|
||||||
|
|
||||||
## Site wide shortcuts
|
## Site wide shortcuts
|
||||||
@@ -32,7 +32,7 @@ The {% data variables.product.prodname_command_palette %} also gives you quick a
|
|||||||
|<kbd>S</kbd> or <kbd>/</kbd> | Focus the search bar. For more information, see "[About searching on {% data variables.product.company_short %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github)."
|
|<kbd>S</kbd> or <kbd>/</kbd> | Focus the search bar. For more information, see "[About searching on {% data variables.product.company_short %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github)."
|
||||||
|<kbd>G</kbd> <kbd>N</kbd> | Go to your notifications. For more information, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications)."
|
|<kbd>G</kbd> <kbd>N</kbd> | Go to your notifications. For more information, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications)."
|
||||||
|<kbd>Esc</kbd> | When focused on a user, issue, or pull request hovercard, closes the hovercard and refocuses on the element the hovercard is in
|
|<kbd>Esc</kbd> | When focused on a user, issue, or pull request hovercard, closes the hovercard and refocuses on the element the hovercard is in
|
||||||
{% if command-palette %}|<kbd>Command</kbd>+<kbd>K</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>K</kbd> (Windows/Linux) | Opens the {% data variables.product.prodname_command_palette %}. If you are editing Markdown text, open the command palette with <kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>K</kbd> or <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>K</kbd>. For more information, see "[{% data variables.product.prodname_command_palette %}](/get-started/using-github/github-command-palette)."{% endif %}
|
{% ifversion command-palette %}|<kbd>Command</kbd>+<kbd>K</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>K</kbd> (Windows/Linux) | Opens the {% data variables.product.prodname_command_palette %}. If you are editing Markdown text, open the command palette with <kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>K</kbd> or <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>K</kbd>. For more information, see "[{% data variables.product.prodname_command_palette %}](/get-started/using-github/github-command-palette)."{% endif %}
|
||||||
|
|
||||||
## Repositories
|
## Repositories
|
||||||
|
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ You can also interact with other users in pull requests and issues using feature
|
|||||||
|
|
||||||
Every comment field on {% data variables.product.product_name %} contains a text formatting toolbar, allowing you to format your text without learning Markdown syntax. In addition to Markdown formatting like bold and italic styles and creating headers, links, and lists, the toolbar includes {% data variables.product.product_name %}-specific features such as @mentions, task lists, and links to issues and pull requests.
|
Every comment field on {% data variables.product.product_name %} contains a text formatting toolbar, allowing you to format your text without learning Markdown syntax. In addition to Markdown formatting like bold and italic styles and creating headers, links, and lists, the toolbar includes {% data variables.product.product_name %}-specific features such as @mentions, task lists, and links to issues and pull requests.
|
||||||
|
|
||||||
{% if fixed-width-font-gfm-fields %}
|
{% ifversion fixed-width-font-gfm-fields %}
|
||||||
|
|
||||||
## Enabling fixed-width fonts in the editor
|
## Enabling fixed-width fonts in the editor
|
||||||
|
|
||||||
|
|||||||
@@ -44,7 +44,7 @@ We support these files:
|
|||||||
* PNG (*.png*)
|
* PNG (*.png*)
|
||||||
* GIF (*.gif*)
|
* GIF (*.gif*)
|
||||||
* JPEG (*.jpg*)
|
* JPEG (*.jpg*)
|
||||||
{%- if svg-support %}
|
{%- ifversion svg-support %}
|
||||||
* SVG (*.svg*)
|
* SVG (*.svg*)
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
* Log files (*.log*)
|
* Log files (*.log*)
|
||||||
|
|||||||
@@ -66,7 +66,7 @@ For example, to syntax highlight Ruby code:
|
|||||||
|
|
||||||
We use [Linguist](https://github.com/github/linguist) to perform language detection and to select [third-party grammars](https://github.com/github/linguist/blob/master/vendor/README.md) for syntax highlighting. You can find out which keywords are valid in [the languages YAML file](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml).
|
We use [Linguist](https://github.com/github/linguist) to perform language detection and to select [third-party grammars](https://github.com/github/linguist/blob/master/vendor/README.md) for syntax highlighting. You can find out which keywords are valid in [the languages YAML file](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml).
|
||||||
|
|
||||||
{% if mermaid %}
|
{% ifversion mermaid %}
|
||||||
## Creating diagrams
|
## Creating diagrams
|
||||||
|
|
||||||
You can also use code blocks to create diagrams in Markdown. GitHub supports Mermaid, geoJSON, topoJSON, and ASCII STL syntax. For more information, see "[Creating diagrams](/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams)."
|
You can also use code blocks to create diagrams in Markdown. GitHub supports Mermaid, geoJSON, topoJSON, and ASCII STL syntax. For more information, see "[Creating diagrams](/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams)."
|
||||||
|
|||||||
@@ -76,5 +76,5 @@ Any issues that are referenced in a task list specify that they are tracked by t
|
|||||||
|
|
||||||
## Further reading
|
## Further reading
|
||||||
|
|
||||||
* "[Basic writing and formatting syntax](/articles/basic-writing-and-formatting-syntax)"{% if code-scanning-task-lists %}
|
* "[Basic writing and formatting syntax](/articles/basic-writing-and-formatting-syntax)"{% ifversion code-scanning-task-lists %}
|
||||||
* "[Tracking {% data variables.product.prodname_code_scanning %} alerts in issues using task lists](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/tracking-code-scanning-alerts-in-issues-using-task-lists)"{% endif %}
|
* "[Tracking {% data variables.product.prodname_code_scanning %} alerts in issues using task lists](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/tracking-code-scanning-alerts-in-issues-using-task-lists)"{% endif %}
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ shortTitle: Close an issue
|
|||||||
{% data reusables.repositories.navigate-to-repo %}
|
{% data reusables.repositories.navigate-to-repo %}
|
||||||
{% data reusables.repositories.sidebar-issues %}
|
{% data reusables.repositories.sidebar-issues %}
|
||||||
1. In the list of issues, click the issue you'd like to close.
|
1. In the list of issues, click the issue you'd like to close.
|
||||||
{%- if issue-close-reasons %}
|
{%- ifversion issue-close-reasons %}
|
||||||
1. Optionally, to change the reason for closing the issue, select {% octicon "triangle-down" aria-label="The down triangle octicon" %} next to "Close issue" and click a reason.
|
1. Optionally, to change the reason for closing the issue, select {% octicon "triangle-down" aria-label="The down triangle octicon" %} next to "Close issue" and click a reason.
|
||||||

|

|
||||||
2. Click **Close issue**.
|
2. Click **Close issue**.
|
||||||
|
|||||||
@@ -153,7 +153,7 @@ Query parameter | Example
|
|||||||
`projects` | `https://github.com/octo-org/octo-repo/issues/new?title=Bug+fix&projects=octo-org/1` creates an issue with the title "Bug fix" and adds it to the organization's project board 1.
|
`projects` | `https://github.com/octo-org/octo-repo/issues/new?title=Bug+fix&projects=octo-org/1` creates an issue with the title "Bug fix" and adds it to the organization's project board 1.
|
||||||
`template` | `https://github.com/octo-org/octo-repo/issues/new?template=issue_template.md` creates an issue with a template in the issue body. The `template` query parameter works with templates stored in an `ISSUE_TEMPLATE` subdirectory within the root, `docs/` or `.github/` directory in a repository. For more information, see "[Using templates to encourage useful issues and pull requests](/communities/using-templates-to-encourage-useful-issues-and-pull-requests)."
|
`template` | `https://github.com/octo-org/octo-repo/issues/new?template=issue_template.md` creates an issue with a template in the issue body. The `template` query parameter works with templates stored in an `ISSUE_TEMPLATE` subdirectory within the root, `docs/` or `.github/` directory in a repository. For more information, see "[Using templates to encourage useful issues and pull requests](/communities/using-templates-to-encourage-useful-issues-and-pull-requests)."
|
||||||
|
|
||||||
{% if code-scanning-task-lists %}
|
{% ifversion code-scanning-task-lists %}
|
||||||
## Creating an issue from a {% data variables.product.prodname_code_scanning %} alert
|
## Creating an issue from a {% data variables.product.prodname_code_scanning %} alert
|
||||||
|
|
||||||
{% data reusables.code-scanning.beta-alert-tracking-in-issues %}
|
{% data reusables.code-scanning.beta-alert-tracking-in-issues %}
|
||||||
|
|||||||
@@ -180,7 +180,7 @@ With issue and pull request search terms, you can:
|
|||||||
|
|
||||||
For issues, you can also use search to:
|
For issues, you can also use search to:
|
||||||
|
|
||||||
- Filter for issues that are linked to a pull request by a closing reference: `linked:pr`{% if issue-close-reasons %}
|
- Filter for issues that are linked to a pull request by a closing reference: `linked:pr`{% ifversion issue-close-reasons %}
|
||||||
- Filter issues by the reason they were closed: `is:closed reason:complete` or `is:closed reason:"not planned"`{% endif %}
|
- Filter issues by the reason they were closed: `is:closed reason:complete` or `is:closed reason:"not planned"`{% endif %}
|
||||||
|
|
||||||
For pull requests, you can also use search to:
|
For pull requests, you can also use search to:
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ topics:
|
|||||||
shortTitle: Customize organization profile
|
shortTitle: Customize organization profile
|
||||||
---
|
---
|
||||||
|
|
||||||
{% if org-profile-pin-private %}
|
{% ifversion org-profile-pin-private %}
|
||||||
|
|
||||||
## About your organization's profile page
|
## About your organization's profile page
|
||||||
|
|
||||||
@@ -45,7 +45,7 @@ You can format text and include emoji, images, and GIFs in your organization pro
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
{% if org-profile-pin-private %}
|
{% ifversion org-profile-pin-private %}
|
||||||
|
|
||||||
## Adding a member-only organization profile README
|
## Adding a member-only organization profile README
|
||||||
|
|
||||||
|
|||||||
@@ -60,7 +60,7 @@ To search for specific events, use the `action` qualifier in your query. Actions
|
|||||||
| [`marketplace_listing`](#marketplace_listing-category-actions) | Contains all activities related to listing apps in {% data variables.product.prodname_marketplace %}.{% endif %}{% ifversion fpt or ghes or ghec %}
|
| [`marketplace_listing`](#marketplace_listing-category-actions) | Contains all activities related to listing apps in {% data variables.product.prodname_marketplace %}.{% endif %}{% ifversion fpt or ghes or ghec %}
|
||||||
| [`members_can_create_pages`](#members_can_create_pages-category-actions) | Contains all activities related to managing the publication of {% data variables.product.prodname_pages %} sites for repositories in the organization. For more information, see "[Managing the publication of {% data variables.product.prodname_pages %} sites for your organization](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)." | {% endif %}
|
| [`members_can_create_pages`](#members_can_create_pages-category-actions) | Contains all activities related to managing the publication of {% data variables.product.prodname_pages %} sites for repositories in the organization. For more information, see "[Managing the publication of {% data variables.product.prodname_pages %} sites for your organization](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)." | {% endif %}
|
||||||
| [`org`](#org-category-actions) | Contains activities related to organization membership.{% ifversion ghec %}
|
| [`org`](#org-category-actions) | Contains activities related to organization membership.{% ifversion ghec %}
|
||||||
| [`org_credential_authorization`](#org_credential_authorization-category-actions) | Contains all activities related to authorizing credentials for use with SAML single sign-on.{% endif %}{% if secret-scanning-audit-log-custom-patterns %}
|
| [`org_credential_authorization`](#org_credential_authorization-category-actions) | Contains all activities related to authorizing credentials for use with SAML single sign-on.{% endif %}{% ifversion secret-scanning-audit-log-custom-patterns %}
|
||||||
| [`org_secret_scanning_custom_pattern`](#org_secret_scanning_custom_pattern-category-actions) | Contains organization-level activities related to secret scanning custom patterns. For more information, see "[Defining custom patterns for secret scanning](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning)." {% endif %}
|
| [`org_secret_scanning_custom_pattern`](#org_secret_scanning_custom_pattern-category-actions) | Contains organization-level activities related to secret scanning custom patterns. For more information, see "[Defining custom patterns for secret scanning](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning)." {% endif %}
|
||||||
| [`organization_label`](#organization_label-category-actions) | Contains all activities related to default labels for repositories in your organization.
|
| [`organization_label`](#organization_label-category-actions) | Contains all activities related to default labels for repositories in your organization.
|
||||||
| [`oauth_application`](#oauth_application-category-actions) | Contains all activities related to OAuth Apps.
|
| [`oauth_application`](#oauth_application-category-actions) | Contains all activities related to OAuth Apps.
|
||||||
@@ -73,11 +73,11 @@ To search for specific events, use the `action` qualifier in your query. Actions
|
|||||||
| [`repository_advisory`](#repository_advisory-category-actions) | Contains repository-level activities related to security advisories in the {% data variables.product.prodname_advisory_database %}. For more information, see "[About {% data variables.product.prodname_dotcom %} Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)."
|
| [`repository_advisory`](#repository_advisory-category-actions) | Contains repository-level activities related to security advisories in the {% data variables.product.prodname_advisory_database %}. For more information, see "[About {% data variables.product.prodname_dotcom %} Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)."
|
||||||
| [`repository_content_analysis`](#repository_content_analysis-category-actions) | Contains all activities related to [enabling or disabling data use for a private repository](/articles/about-github-s-use-of-your-data).{% endif %}{% ifversion fpt or ghec %}
|
| [`repository_content_analysis`](#repository_content_analysis-category-actions) | Contains all activities related to [enabling or disabling data use for a private repository](/articles/about-github-s-use-of-your-data).{% endif %}{% ifversion fpt or ghec %}
|
||||||
| [`repository_dependency_graph`](#repository_dependency_graph-category-actions) | Contains repository-level activities related to enabling or disabling the dependency graph for a {% ifversion fpt or ghec %}private {% endif %}repository. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)."{% endif %}{% ifversion ghes or ghae or ghec %}
|
| [`repository_dependency_graph`](#repository_dependency_graph-category-actions) | Contains repository-level activities related to enabling or disabling the dependency graph for a {% ifversion fpt or ghec %}private {% endif %}repository. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)."{% endif %}{% ifversion ghes or ghae or ghec %}
|
||||||
| [`repository_secret_scanning`](#repository_secret_scanning-category-actions) | Contains repository-level activities related to secret scanning. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." {% endif %}{% if secret-scanning-audit-log-custom-patterns %}
|
| [`repository_secret_scanning`](#repository_secret_scanning-category-actions) | Contains repository-level activities related to secret scanning. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." {% endif %}{% ifversion secret-scanning-audit-log-custom-patterns %}
|
||||||
| [`repository_secret_scanning_custom_pattern`](#respository_secret_scanning_custom_pattern-category-actions) | Contains repository-level activities related to secret scanning custom patterns. For more information, see "[Defining custom patterns for secret scanning](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning)." {% endif %}{% if secret-scanning-audit-log-custom-patterns %}
|
| [`repository_secret_scanning_custom_pattern`](#respository_secret_scanning_custom_pattern-category-actions) | Contains repository-level activities related to secret scanning custom patterns. For more information, see "[Defining custom patterns for secret scanning](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning)." {% endif %}{% ifversion secret-scanning-audit-log-custom-patterns %}
|
||||||
| [`repository_secret_scanning_push_protection`](#respository_secret_scanning_push_protection) | Contains repository-level activities related to secret scanning custom patterns. For more information, see "[Protecting pushes with secert scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." {% endif %}{% ifversion fpt or ghes or ghae or ghec %}
|
| [`repository_secret_scanning_push_protection`](#respository_secret_scanning_push_protection) | Contains repository-level activities related to secret scanning custom patterns. For more information, see "[Protecting pushes with secert scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." {% endif %}{% ifversion fpt or ghes or ghae or ghec %}
|
||||||
| [`repository_vulnerability_alert`](#repository_vulnerability_alert-category-actions) | Contains all activities related to [{% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies).{% endif %}{% ifversion fpt or ghec %}
|
| [`repository_vulnerability_alert`](#repository_vulnerability_alert-category-actions) | Contains all activities related to [{% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies).{% endif %}{% ifversion fpt or ghec %}
|
||||||
| [`repository_vulnerability_alerts`](#repository_vulnerability_alerts-category-actions) | Contains repository-level configuration activities for {% data variables.product.prodname_dependabot_alerts %}.{% endif %}{% if custom-repository-roles %}
|
| [`repository_vulnerability_alerts`](#repository_vulnerability_alerts-category-actions) | Contains repository-level configuration activities for {% data variables.product.prodname_dependabot_alerts %}.{% endif %}{% ifversion custom-repository-roles %}
|
||||||
| [`role`](#role-category-actions) | Contains all activities related to [custom repository roles](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization).{% endif %}{% ifversion ghes or ghae or ghec %}
|
| [`role`](#role-category-actions) | Contains all activities related to [custom repository roles](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization).{% endif %}{% ifversion ghes or ghae or ghec %}
|
||||||
| [`secret_scanning`](#secret_scanning-category-actions) | Contains organization-level configuration activities for secret scanning in existing repositories. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)."
|
| [`secret_scanning`](#secret_scanning-category-actions) | Contains organization-level configuration activities for secret scanning in existing repositories. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)."
|
||||||
| [`secret_scanning_new_repos`](#secret_scanning_new_repos-category-actions) | Contains organization-level configuration activities for secret scanning for new repositories created in the organization. {% endif %}{% ifversion fpt or ghec %}
|
| [`secret_scanning_new_repos`](#secret_scanning_new_repos-category-actions) | Contains organization-level configuration activities for secret scanning for new repositories created in the organization. {% endif %}{% ifversion fpt or ghec %}
|
||||||
@@ -462,7 +462,7 @@ For more information, see "[Managing the publication of {% data variables.produc
|
|||||||
| `runner_group_updated` | Triggered when the configuration of a self-hosted runner group is changed. For more information, see "[Changing the access policy of a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)."
|
| `runner_group_updated` | Triggered when the configuration of a self-hosted runner group is changed. For more information, see "[Changing the access policy of a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)."
|
||||||
| `runner_group_runners_added` | Triggered when a self-hosted runner is added to a group. For more information, see [Moving a self-hosted runner to a group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group).
|
| `runner_group_runners_added` | Triggered when a self-hosted runner is added to a group. For more information, see [Moving a self-hosted runner to a group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group).
|
||||||
| `runner_group_runner_removed` | Triggered when the REST API is used to remove a self-hosted runner from a group. For more information, see "[Remove a self-hosted runner from a group for an organization](/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization)."
|
| `runner_group_runner_removed` | Triggered when the REST API is used to remove a self-hosted runner from a group. For more information, see "[Remove a self-hosted runner from a group for an organization](/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization)."
|
||||||
| `runner_group_runners_updated`| Triggered when a runner group's list of members is updated. For more information, see "[Set self-hosted runners in a group for an organization](/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization)."{% if secret-scanning-audit-log-custom-patterns %}
|
| `runner_group_runners_updated`| Triggered when a runner group's list of members is updated. For more information, see "[Set self-hosted runners in a group for an organization](/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization)."{% ifversion secret-scanning-audit-log-custom-patterns %}
|
||||||
| `secret_scanning_push_protection_disable ` | Triggered when an organization owner or person with admin access to the organization disables push protection for secret scanning. For more information, see "[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning)."
|
| `secret_scanning_push_protection_disable ` | Triggered when an organization owner or person with admin access to the organization disables push protection for secret scanning. For more information, see "[Protecting pushes with secret scanning](/enterprise-cloud@latest/code-security/secret-scanning/protecting-pushes-with-secret-scanning)."
|
||||||
| `secret_scanning_push_protection_enable ` | Triggered when an organization owner or person with admin access to the organization enables push protection for secret scanning.{% endif %}{% ifversion fpt or ghes > 3.1 or ghae or ghec %}
|
| `secret_scanning_push_protection_enable ` | Triggered when an organization owner or person with admin access to the organization enables push protection for secret scanning.{% endif %}{% ifversion fpt or ghes > 3.1 or ghae or ghec %}
|
||||||
| `self_hosted_runner_online` | Triggered when the runner application is started. Can only be viewed using the REST API; not visible in the UI or JSON/CSV export. For more information, see "[Checking the status of a self-hosted runner](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)."
|
| `self_hosted_runner_online` | Triggered when the runner application is started. Can only be viewed using the REST API; not visible in the UI or JSON/CSV export. For more information, see "[Checking the status of a self-hosted runner](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners#checking-the-status-of-a-self-hosted-runner)."
|
||||||
@@ -489,7 +489,7 @@ For more information, see "[Managing the publication of {% data variables.produc
|
|||||||
| `deauthorized` | Triggered when a member [deauthorizes credentials for use with SAML single sign-on](/github/authenticating-to-github/authenticating-with-saml-single-sign-on).
|
| `deauthorized` | Triggered when a member [deauthorizes credentials for use with SAML single sign-on](/github/authenticating-to-github/authenticating-with-saml-single-sign-on).
|
||||||
| `revoke` | Triggered when an owner [revokes authorized credentials](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization).
|
| `revoke` | Triggered when an owner [revokes authorized credentials](/organizations/granting-access-to-your-organization-with-saml-single-sign-on/viewing-and-managing-a-members-saml-access-to-your-organization).
|
||||||
|
|
||||||
{% endif %}{% if secret-scanning-audit-log-custom-patterns %}
|
{% endif %}{% ifversion secret-scanning-audit-log-custom-patterns %}
|
||||||
|
|
||||||
### `org_secret_scanning_custom_pattern` category actions
|
### `org_secret_scanning_custom_pattern` category actions
|
||||||
|
|
||||||
@@ -687,7 +687,7 @@ For more information, see "[Managing the publication of {% data variables.produc
|
|||||||
| `disable` | Triggered when a repository owner or person with admin access to the repository disables secret scanning for a repository. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)."
|
| `disable` | Triggered when a repository owner or person with admin access to the repository disables secret scanning for a repository. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)."
|
||||||
| `enable` | Triggered when a repository owner or person with admin access to the repository enables secret scanning for a repository.
|
| `enable` | Triggered when a repository owner or person with admin access to the repository enables secret scanning for a repository.
|
||||||
|
|
||||||
{% endif %}{% if secret-scanning-audit-log-custom-patterns %}
|
{% endif %}{% ifversion secret-scanning-audit-log-custom-patterns %}
|
||||||
|
|
||||||
### `repository_secret_scanning_custom_pattern` category actions
|
### `repository_secret_scanning_custom_pattern` category actions
|
||||||
|
|
||||||
@@ -697,7 +697,7 @@ For more information, see "[Managing the publication of {% data variables.produc
|
|||||||
| `update` | Triggered when changes to a custom pattern are saved for secret scanning in a repository. For more information, see "[Defining custom patterns for secret scanning](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#editing-a-custom-pattern)."
|
| `update` | Triggered when changes to a custom pattern are saved for secret scanning in a repository. For more information, see "[Defining custom patterns for secret scanning](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#editing-a-custom-pattern)."
|
||||||
| `delete` | Triggered when a custom pattern is removed from secret scanning in a repository. For more information, see "[Defining custom patterns for secret scanning](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#removing-a-custom-pattern)."
|
| `delete` | Triggered when a custom pattern is removed from secret scanning in a repository. For more information, see "[Defining custom patterns for secret scanning](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#removing-a-custom-pattern)."
|
||||||
|
|
||||||
{% endif %}{% if secret-scanning-audit-log-custom-patterns %}
|
{% endif %}{% ifversion secret-scanning-audit-log-custom-patterns %}
|
||||||
|
|
||||||
### `repository_secret_scanning_push_protection` category actions
|
### `repository_secret_scanning_push_protection` category actions
|
||||||
|
|
||||||
@@ -724,7 +724,7 @@ For more information, see "[Managing the publication of {% data variables.produc
|
|||||||
| `disable` | Triggered when a repository owner or person with admin access to the repository disables {% data variables.product.prodname_dependabot_alerts %}.
|
| `disable` | Triggered when a repository owner or person with admin access to the repository disables {% data variables.product.prodname_dependabot_alerts %}.
|
||||||
| `enable` | Triggered when a repository owner or person with admin access to the repository enables {% data variables.product.prodname_dependabot_alerts %}.
|
| `enable` | Triggered when a repository owner or person with admin access to the repository enables {% data variables.product.prodname_dependabot_alerts %}.
|
||||||
|
|
||||||
{% endif %}{% if custom-repository-roles %}
|
{% endif %}{% ifversion custom-repository-roles %}
|
||||||
### `role` category actions
|
### `role` category actions
|
||||||
| Action | Description
|
| Action | Description
|
||||||
|------------------|-------------------
|
|------------------|-------------------
|
||||||
@@ -742,7 +742,7 @@ For more information, see "[Managing the publication of {% data variables.produc
|
|||||||
| `enable` | Triggered when an organization owner enables secret scanning for all existing{% ifversion ghec %}, private or internal{% endif %} repositories.
|
| `enable` | Triggered when an organization owner enables secret scanning for all existing{% ifversion ghec %}, private or internal{% endif %} repositories.
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if secret-scanning-alert-audit-log %}
|
{% ifversion secret-scanning-alert-audit-log %}
|
||||||
### `secret_scanning_alert` category actions
|
### `secret_scanning_alert` category actions
|
||||||
|
|
||||||
| Action | Description
|
| Action | Description
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user