Merge branch 'main' into patch-2
This commit is contained in:
mc
2
.gitattributes
vendored
2
.gitattributes
vendored
@@ -2,5 +2,5 @@
|
||||
* text=auto
|
||||
# Explicitly declare text files we want to always be normalized and converted
|
||||
# to native line endings on checkout.
|
||||
*.md text
|
||||
*.md text diff=markdown
|
||||
*.json.br filter=lfs diff=lfs merge=lfs -text
|
||||
|
||||
@@ -23,6 +23,6 @@ jobs:
|
||||
steps:
|
||||
- uses: alex-page/github-project-automation-plus@bb266ff4dde9242060e2d5418e120a133586d488
|
||||
with:
|
||||
project: Docs team reviews
|
||||
project: Docs open source board
|
||||
column: Help wanted
|
||||
repo-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }}
|
||||
|
||||
2
.github/workflows/openapi-decorate.yml
vendored
2
.github/workflows/openapi-decorate.yml
vendored
@@ -57,7 +57,7 @@ jobs:
|
||||
uses: EndBug/add-and-commit@050a66787244b10a4874a2a5f682130263edc192
|
||||
with:
|
||||
# The arguments for the `git add` command
|
||||
add: '["lib/rest/static/apps", "lib/rest/static/decorated"]'
|
||||
add: '["lib/rest/static/apps", "lib/rest/static/decorated", "lib/redirects/static/client-side-rest-api-redirects.json"]'
|
||||
|
||||
# The message for the commit
|
||||
message: 'Add decorated OpenAPI schema files'
|
||||
|
||||
@@ -7,5 +7,5 @@ then
|
||||
printf >&2 "\nGitHub Docs requires Git LFS but using the 'git-lfs' on your path failed.\n"
|
||||
fi
|
||||
else
|
||||
printf >&2 "\nGitHub Docs requires Git LFS but 'git-lfs' was not found on your path.\nLearn how to install Git LFS at <https://git.io/JBCId>.\n"
|
||||
printf >&2 "\nGitHub Docs requires Git LFS but 'git-lfs' was not found on your path.\nLearn how to install Git LFS at <https://docs.github.com/en/github/managing-large-files/versioning-large-files/installing-git-large-file-storage>.\n"
|
||||
fi
|
||||
|
||||
@@ -7,5 +7,5 @@ then
|
||||
printf >&2 "\nGitHub Docs requires Git LFS but using the 'git-lfs' on your path failed.\n"
|
||||
fi
|
||||
else
|
||||
printf >&2 "\nGitHub Docs requires Git LFS but 'git-lfs' was not found on your path.\nLearn how to install Git LFS at <https://git.io/JBCId>.\n"
|
||||
printf >&2 "\nGitHub Docs requires Git LFS but 'git-lfs' was not found on your path.\nLearn how to install Git LFS at <https://docs.github.com/en/github/managing-large-files/versioning-large-files/installing-git-large-file-storage>.\n"
|
||||
fi
|
||||
|
||||
@@ -7,5 +7,5 @@ then
|
||||
printf >&2 "\nGitHub Docs requires Git LFS but using the 'git-lfs' on your path failed.\n"
|
||||
fi
|
||||
else
|
||||
printf >&2 "\nGitHub Docs requires Git LFS but 'git-lfs' was not found on your path.\nLearn how to install Git LFS at <https://git.io/JBCId>.\n"
|
||||
printf >&2 "\nGitHub Docs requires Git LFS but 'git-lfs' was not found on your path.\nLearn how to install Git LFS at <https://docs.github.com/en/github/managing-large-files/versioning-large-files/installing-git-large-file-storage>.\n"
|
||||
fi
|
||||
|
||||
@@ -7,7 +7,7 @@ then
|
||||
printf >&2 "\nGitHub Docs requires Git LFS but using the 'git-lfs' on your path failed.\n"
|
||||
fi
|
||||
else
|
||||
printf >&2 "\nGitHub Docs requires Git LFS but 'git-lfs' was not found on your path.\nLearn how to install Git LFS at <https://git.io/JBCId>.\n"
|
||||
printf >&2 "\nGitHub Docs requires Git LFS but 'git-lfs' was not found on your path.\nLearn how to install Git LFS at <https://docs.github.com/en/github/managing-large-files/versioning-large-files/installing-git-large-file-storage>.\n"
|
||||
fi
|
||||
|
||||
. "$(dirname "$0")/_/husky.sh"
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 65 KiB |
BIN
assets/images/help/desktop/checks-dialog.png
Normal file
BIN
assets/images/help/desktop/checks-dialog.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 32 KiB |
BIN
assets/images/help/desktop/checks-failed-dialog.png
Normal file
BIN
assets/images/help/desktop/checks-failed-dialog.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 86 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 53 KiB After Width: | Height: | Size: 96 KiB |
BIN
assets/images/help/desktop/mac-enable-notifications.png
Normal file
BIN
assets/images/help/desktop/mac-enable-notifications.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 83 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
BIN
assets/images/help/desktop/pull-request-list-sync.png.png
Normal file
BIN
assets/images/help/desktop/pull-request-list-sync.png.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 122 KiB |
BIN
assets/images/help/desktop/pull-request-review-dialog.png
Normal file
BIN
assets/images/help/desktop/pull-request-review-dialog.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 42 KiB |
BIN
assets/images/help/desktop/pull-request-review-notification.png
Normal file
BIN
assets/images/help/desktop/pull-request-review-notification.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.7 KiB |
BIN
assets/images/help/desktop/re-run-confirmation-dialog.png
Normal file
BIN
assets/images/help/desktop/re-run-confirmation-dialog.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 66 KiB |
BIN
assets/images/help/desktop/re-run-failed-checks.png
Normal file
BIN
assets/images/help/desktop/re-run-failed-checks.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 103 KiB |
BIN
assets/images/help/desktop/re-run-individual-checks.png
Normal file
BIN
assets/images/help/desktop/re-run-individual-checks.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 105 KiB |
BIN
assets/images/help/desktop/windows-enable-notifications.png
Normal file
BIN
assets/images/help/desktop/windows-enable-notifications.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 64 KiB |
@@ -65,7 +65,7 @@ The examples below demonstrate using the `fwal/setup-swift` action.
|
||||
|
||||
### Using multiple Swift versions
|
||||
|
||||
You can configure your job to use a multiple versions of Swift in a build matrix.
|
||||
You can configure your job to use multiple versions of Swift in a matrix.
|
||||
|
||||
```yaml{:copy}
|
||||
{% data reusables.actions.actions-not-certified-by-github-comment %}
|
||||
|
||||
@@ -23,7 +23,7 @@ miniTocMaxHeadingLevel: 3
|
||||
|
||||
Contexts are a way to access information about workflow runs, runner environments, jobs, and steps. Each context is an object that contains properties, which can be strings or other objects.
|
||||
|
||||
{% data reusables.actions.context-contents %} For example, the `matrix` context is only populated for jobs in a [build matrix](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix).
|
||||
{% data reusables.actions.context-contents %} For example, the `matrix` context is only populated for jobs in a [matrix](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix).
|
||||
|
||||
You can access contexts using the expression syntax. For more information, see "[Expressions](/actions/learn-github-actions/expressions)."
|
||||
|
||||
@@ -552,19 +552,19 @@ The following example contents of the `secrets` context shows the automatic `GIT
|
||||
|
||||
## `strategy` context
|
||||
|
||||
For workflows with a build matrix, the `strategy` context contains information about the matrix execution strategy for the current job.
|
||||
For workflows with a matrix, the `strategy` context contains information about the matrix execution strategy for the current job.
|
||||
|
||||
| Property name | Type | Description |
|
||||
|---------------|------|-------------|
|
||||
| `strategy` | `object` | This context changes for each job in a workflow run. You can access this context from any job or step in a workflow. This object contains all the properties listed below. |
|
||||
| `strategy.fail-fast` | `string` | When `true`, all in-progress jobs are canceled if any job in a build matrix fails. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategyfail-fast)." |
|
||||
| `strategy.job-index` | `string` | The index of the current job in the build matrix. **Note:** This number is a zero-based number. The first job's index in the build matrix is `0`. |
|
||||
| `strategy.job-total` | `string` | The total number of jobs in the build matrix. **Note:** This number **is not** a zero-based number. For example, for a build matrix with four jobs, the value of `job-total` is `4`. |
|
||||
| `strategy.fail-fast` | `string` | When `true`, all in-progress jobs are canceled if any job in a matrix fails. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategyfail-fast)." |
|
||||
| `strategy.job-index` | `string` | The index of the current job in the matrix. **Note:** This number is a zero-based number. The first job's index in the matrix is `0`. |
|
||||
| `strategy.job-total` | `string` | The total number of jobs in the matrix. **Note:** This number **is not** a zero-based number. For example, for a matrix with four jobs, the value of `job-total` is `4`. |
|
||||
| `strategy.max-parallel` | `string` | The maximum number of jobs that can run simultaneously when using a `matrix` job strategy. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymax-parallel)." |
|
||||
|
||||
### Example contents of the `strategy` context
|
||||
|
||||
The following example contents of the `strategy` context is from a build matrix with four jobs, and is taken from the final job. Note the difference between the zero-based `job-index` number, and `job-total` which is not zero-based.
|
||||
The following example contents of the `strategy` context is from a matrix with four jobs, and is taken from the final job. Note the difference between the zero-based `job-index` number, and `job-total` which is not zero-based.
|
||||
|
||||
```yaml
|
||||
{
|
||||
@@ -577,7 +577,7 @@ The following example contents of the `strategy` context is from a build matrix
|
||||
|
||||
### Example usage of the `strategy` context
|
||||
|
||||
This example workflow uses the `strategy.job-index` property to set a unique name for a log file for each job in a build matrix.
|
||||
This example workflow uses the `strategy.job-index` property to set a unique name for a log file for each job in a matrix.
|
||||
|
||||
```yaml{:copy}
|
||||
name: Test matrix
|
||||
@@ -602,18 +602,18 @@ jobs:
|
||||
|
||||
## `matrix` context
|
||||
|
||||
For workflows with a build matrix, the `matrix` context contains the matrix properties defined in the workflow file that apply to the current job. For example, if you configure a build matrix with the `os` and `node` keys, the `matrix` context object includes the `os` and `node` properties with the values that are being used for the current job.
|
||||
For workflows with a matrix, the `matrix` context contains the matrix properties defined in the workflow file that apply to the current job. For example, if you configure a matrix with the `os` and `node` keys, the `matrix` context object includes the `os` and `node` properties with the values that are being used for the current job.
|
||||
|
||||
There are no standard properties in the `matrix` context, only those which are defined in the workflow file.
|
||||
|
||||
| Property name | Type | Description |
|
||||
|---------------|------|-------------|
|
||||
| `matrix` | `object` | This context is only available for jobs in a build matrix, and changes for each job in a workflow run. You can access this context from any job or step in a workflow. This object contains the properties listed below. |
|
||||
| `matrix` | `object` | This context is only available for jobs in a matrix, and changes for each job in a workflow run. You can access this context from any job or step in a workflow. This object contains the properties listed below. |
|
||||
| `matrix.<property_name>` | `string` | The value of a matrix property. |
|
||||
|
||||
### Example contents of the `matrix` context
|
||||
|
||||
The following example contents of the `matrix` context is from a job in a build matrix that has the `os` and `node` matrix properties defined in the workflow. The job is executing the matrix combination of an `ubuntu-latest` OS and Node.js version `16`.
|
||||
The following example contents of the `matrix` context is from a job in a matrix that has the `os` and `node` matrix properties defined in the workflow. The job is executing the matrix combination of an `ubuntu-latest` OS and Node.js version `16`.
|
||||
|
||||
```yaml
|
||||
{
|
||||
@@ -624,7 +624,7 @@ The following example contents of the `matrix` context is from a job in a build
|
||||
|
||||
### Example usage of the `matrix` context
|
||||
|
||||
This example workflow creates a build matrix with `os` and `node` keys. It uses the `matrix.os` property to set the runner type for each job, and uses the `matrix.node` property to set the Node.js version for each job.
|
||||
This example workflow creates a matrix with `os` and `node` keys. It uses the `matrix.os` property to set the runner type for each job, and uses the `matrix.node` property to set the Node.js version for each job.
|
||||
|
||||
```yaml{:copy}
|
||||
name: Test matrix
|
||||
|
||||
@@ -50,7 +50,7 @@ Both CircleCI and {% data variables.product.prodname_actions %} configure `jobs`
|
||||
|
||||
Both CircleCI and {% data variables.product.prodname_actions %} provide a mechanism to reuse and share tasks in a workflow. CircleCI uses a concept called orbs, written in YAML, to provide tasks that people can reuse in a workflow. {% data variables.product.prodname_actions %} has powerful and flexible reusable components called actions, which you build with either JavaScript files or Docker images. 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.product_name %}'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. For more information, see "[Creating actions](/actions/creating-actions)."
|
||||
|
||||
CircleCI can reuse pieces of workflows with YAML anchors and aliases. {% data variables.product.prodname_actions %} supports the most common need for reusability using build matrixes. For more information about build matrixes, see "[Managing complex workflows](/actions/learn-github-actions/managing-complex-workflows/#using-a-build-matrix)."
|
||||
CircleCI can reuse pieces of workflows with YAML anchors and aliases. {% data variables.product.prodname_actions %} supports the most common need for reusability using matrices. For more information about matrices, see "[Using a matrix for your jobs](/actions/using-jobs/using-a-matrix-for-your-jobs)."
|
||||
|
||||
## Using Docker images
|
||||
|
||||
|
||||
@@ -82,9 +82,9 @@ Jenkins can run the `stages` and `steps` in parallel, while {% data variables.pr
|
||||
| ------------- | ------------- |
|
||||
| [`parallel`](https://jenkins.io/doc/book/pipeline/syntax/#parallel) | [`jobs.<job_id>.strategy.max-parallel`](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymax-parallel) |
|
||||
|
||||
### Build matrix
|
||||
### Matrix
|
||||
|
||||
Both {% data variables.product.prodname_actions %} and Jenkins let you use a build matrix to define various system combinations.
|
||||
Both {% data variables.product.prodname_actions %} and Jenkins let you use a matrix to define various system combinations.
|
||||
|
||||
| Jenkins | {% data variables.product.prodname_actions %} |
|
||||
| ------------- | ------------- |
|
||||
|
||||
@@ -60,9 +60,9 @@ Travis CI can use `stages` to run jobs in parallel. Similarly, {% data variables
|
||||
Travis CI and {% data variables.product.prodname_actions %} both support status badges, which let you indicate whether a build is passing or failing.
|
||||
For more information, see ["Adding a workflow status badge to your repository](/actions/managing-workflow-runs/adding-a-workflow-status-badge)."
|
||||
|
||||
### Using a build matrix
|
||||
### Using a matrix
|
||||
|
||||
Travis CI and {% data variables.product.prodname_actions %} both support a build matrix, allowing you to perform testing using combinations of operating systems and software packages. For more information, see "[Using a build matrix](/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix)."
|
||||
Travis CI and {% data variables.product.prodname_actions %} both support a matrix, allowing you to perform testing using combinations of operating systems and software packages. For more information, see "[Using a matrix for your jobs](/actions/using-jobs/using-a-matrix-for-your-jobs)."
|
||||
|
||||
Below is an example comparing the syntax for each system:
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@ children:
|
||||
- /using-jobs-in-a-workflow
|
||||
- /choosing-the-runner-for-a-job
|
||||
- /using-conditions-to-control-job-execution
|
||||
- /using-a-build-matrix-for-your-jobs
|
||||
- /using-a-matrix-for-your-jobs
|
||||
- /using-concurrency
|
||||
- /using-environments-for-jobs
|
||||
- /running-jobs-in-a-container
|
||||
|
||||
@@ -1,30 +0,0 @@
|
||||
---
|
||||
title: Using a build matrix for your jobs
|
||||
shortTitle: Using a build matrix for your jobs
|
||||
intro: Create a build matrix and define variations for each job.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
miniTocMaxHeadingLevel: 4
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
|
||||
## Overview
|
||||
|
||||
{% data reusables.actions.jobs.section-using-a-build-matrix-for-your-jobs-strategy %}
|
||||
|
||||
## Creating a matrix of different job configurations
|
||||
|
||||
{% data reusables.actions.jobs.section-using-a-build-matrix-for-your-jobs-matrix %}
|
||||
|
||||
## Canceling remaining jobs if a `matrix` job fails
|
||||
|
||||
{% data reusables.actions.jobs.section-using-a-build-matrix-for-your-jobs-failfast %}
|
||||
|
||||
## Defining the maximum number of concurrent jobs in a `matrix`
|
||||
|
||||
{% data reusables.actions.jobs.section-using-a-build-matrix-for-your-jobs-max-parallel %}
|
||||
60
content/actions/using-jobs/using-a-matrix-for-your-jobs.md
Normal file
60
content/actions/using-jobs/using-a-matrix-for-your-jobs.md
Normal file
@@ -0,0 +1,60 @@
|
||||
---
|
||||
title: Using a matrix for your jobs
|
||||
shortTitle: Using a matrix
|
||||
intro: Create a matrix to define variations for each job.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
miniTocMaxHeadingLevel: 4
|
||||
redirect_from:
|
||||
- /actions/using-jobs/using-a-build-matrix-for-your-jobs
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
|
||||
## About matrix strategies
|
||||
|
||||
{% data reusables.actions.jobs.about-matrix-strategy %}
|
||||
|
||||
## Using a matrix strategy
|
||||
|
||||
{% data reusables.actions.jobs.using-matrix-strategy %}
|
||||
|
||||
### Example: Using a single-dimension matrix
|
||||
|
||||
{% data reusables.actions.jobs.single-dimension-matrix %}
|
||||
|
||||
### Example: Using a multi-dimension matrix
|
||||
|
||||
{% data reusables.actions.jobs.multi-dimension-matrix %}
|
||||
|
||||
### Example: Using contexts to create matrices
|
||||
|
||||
{% data reusables.actions.jobs.matrix-from-context %}
|
||||
|
||||
## Expanding or adding matrix configurations
|
||||
|
||||
{% data reusables.actions.jobs.matrix-include %}
|
||||
|
||||
### Example: Expanding configurations
|
||||
|
||||
{% data reusables.actions.jobs.matrix-expand-with-include %}
|
||||
|
||||
### Example: Adding configurations
|
||||
|
||||
{% data reusables.actions.jobs.matrix-add-with-include %}
|
||||
|
||||
## Excluding matrix configurations
|
||||
|
||||
{% data reusables.actions.jobs.matrix-exclude %}
|
||||
|
||||
## Handling failures
|
||||
|
||||
{% data reusables.actions.jobs.section-using-a-build-matrix-for-your-jobs-failfast %}
|
||||
|
||||
## Defining the maximum number of concurrent jobs
|
||||
|
||||
{% data reusables.actions.jobs.section-using-a-build-matrix-for-your-jobs-max-parallel %}
|
||||
@@ -28,7 +28,7 @@ A workflow must contain the following basic components:
|
||||
1. One or more _jobs_, each of which will execute on a _runner_ machine and run a series of one or more _steps_.
|
||||
1. Each step can either run a script that you define or run an action, which is a reusable extension that can simplify your workflow.
|
||||
|
||||
For more information these basic components, see "[Understanding GitHub Actions](/actions/learn-github-actions/understanding-github-actions#the-components-of-github-actions)."
|
||||
For more information on these basic components, see "[Understanding GitHub Actions](/actions/learn-github-actions/understanding-github-actions#the-components-of-github-actions)."
|
||||
|
||||
|
||||
|
||||
@@ -105,9 +105,9 @@ jobs:
|
||||
|
||||
For more information, see "[Defining prerequisite jobs](/actions/using-jobs/using-jobs-in-a-workflow#defining-prerequisite-jobs)."
|
||||
|
||||
### Using a build matrix
|
||||
### Using a matrix
|
||||
|
||||
You can use a build matrix if you want your workflow to run tests across multiple combinations of parameters, such as operating systems, platforms, and languages. The build matrix is created using the `strategy` keyword, which receives the build options as an array. For example, this build matrix will run the job multiple times, using different versions of Node.js:
|
||||
{% data reusables.actions.jobs.about-matrix-strategy %} The matrix is created using the `strategy` keyword, which receives the build options as an array. For example, this matrix will run the job multiple times, using different versions of Node.js:
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
@@ -115,14 +115,14 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
node: [6, 8, 10]
|
||||
node: [12, 14, 16]
|
||||
steps:
|
||||
- uses: {% data reusables.actions.action-setup-node %}
|
||||
with:
|
||||
node-version: {% raw %}${{ matrix.node }}{% endraw %}
|
||||
```
|
||||
|
||||
For more information, see "[Using a build matrix for your jobs](/actions/using-jobs/using-a-build-matrix-for-your-jobs)."
|
||||
For more information, see "[Using a matrix for your jobs](/actions/using-jobs/using-a-matrix-for-your-jobs)."
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
### Caching dependencies
|
||||
|
||||
@@ -745,11 +745,39 @@ If the timeout exceeds the job execution time limit for the runner, the job will
|
||||
|
||||
## `jobs.<job_id>.strategy`
|
||||
|
||||
{% data reusables.actions.jobs.section-using-a-build-matrix-for-your-jobs-strategy %}
|
||||
Use `jobs.<job_id>.strategy` to use a matrix strategy for your jobs. {% data reusables.actions.jobs.about-matrix-strategy %} For more information, see "[Using a matrix for your jobs](/actions/using-jobs/using-a-matrix-for-your-jobs)."
|
||||
|
||||
### `jobs.<job_id>.strategy.matrix`
|
||||
|
||||
{% data reusables.actions.jobs.section-using-a-build-matrix-for-your-jobs-matrix %}
|
||||
{% data reusables.actions.jobs.using-matrix-strategy %}
|
||||
|
||||
#### Example: Using a single-dimension matrix
|
||||
|
||||
{% data reusables.actions.jobs.single-dimension-matrix %}
|
||||
|
||||
#### Example: Using a multi-dimension matrix
|
||||
|
||||
{% data reusables.actions.jobs.multi-dimension-matrix %}
|
||||
|
||||
#### Example: Using contexts to create matrices
|
||||
|
||||
{% data reusables.actions.jobs.matrix-from-context %}
|
||||
|
||||
### `jobs.<job_id>.strategy.matrix.include`
|
||||
|
||||
{% data reusables.actions.jobs.matrix-include %}
|
||||
|
||||
#### Example: Expanding configurations
|
||||
|
||||
{% data reusables.actions.jobs.matrix-expand-with-include %}
|
||||
|
||||
#### Example: Adding configurations
|
||||
|
||||
{% data reusables.actions.jobs.matrix-add-with-include %}
|
||||
|
||||
### `jobs.<job_id>.strategy.matrix.exclude`
|
||||
|
||||
{% data reusables.actions.jobs.matrix-exclude %}
|
||||
|
||||
### `jobs.<job_id>.strategy.fail-fast`
|
||||
|
||||
|
||||
@@ -33,6 +33,13 @@ Before you can enable and configure {% data variables.product.prodname_registry
|
||||
1. Under "Packages Storage", select **Azure Blob Storage** and enter your Azure container name for your packages storage bucket and connection string.
|
||||
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** You can find your Azure Connection String by navigating to the Access Key menu in your Azure storage account.
|
||||
Usage of a SAS Token or SAS URL as connection string is not currently supported.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% data reusables.enterprise_management_console.save-settings %}
|
||||
|
||||
## Next steps
|
||||
|
||||
@@ -208,7 +208,7 @@ If this parameter is not used, the {% data variables.product.prodname_codeql_wor
|
||||
|
||||
{% data reusables.code-scanning.codeql-languages-bullets %}
|
||||
|
||||
The default {% data variables.product.prodname_codeql_workflow %} file contains a build matrix called `language` which lists the languages in your repository that are analyzed. {% data variables.product.prodname_codeql %} automatically populates this matrix when you add {% data variables.product.prodname_code_scanning %} to a repository. Using the `language` matrix optimizes {% data variables.product.prodname_codeql %} to run each analysis in parallel. We recommend that all workflows adopt this configuration due to the performance benefits of parallelizing builds. For more information about build matrices, see "[Managing complex workflows](/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix)."
|
||||
The default {% data variables.product.prodname_codeql_workflow %} file contains a matrix called `language` which lists the languages in your repository that are analyzed. {% data variables.product.prodname_codeql %} automatically populates this matrix when you add {% data variables.product.prodname_code_scanning %} to a repository. Using the `language` matrix optimizes {% data variables.product.prodname_codeql %} to run each analysis in parallel. We recommend that all workflows adopt this configuration due to the performance benefits of parallelizing builds. For more information about matrices, see "[Using a matrix for your jobs](/actions/using-jobs/using-a-matrix-for-your-jobs)."
|
||||
|
||||
{% data reusables.code-scanning.specify-language-to-analyze %}
|
||||
|
||||
|
||||
@@ -68,7 +68,7 @@ If an automatic build of code for a compiled language within your project fails,
|
||||
|
||||
- Remove the `autobuild` step from your {% data variables.product.prodname_code_scanning %} workflow and add specific build steps. For information about editing the workflow, see "[Configuring {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning#editing-a-code-scanning-workflow)." For more information about replacing the `autobuild` step, see "[Configuring the {% data variables.product.prodname_codeql %} workflow for compiled languages](/code-security/secure-coding/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)."
|
||||
|
||||
- If your workflow doesn't explicitly specify the languages to analyze, {% data variables.product.prodname_codeql %} implicitly detects the supported languages in your code base. In this configuration, out of the compiled languages C/C++, C#, and Java, {% data variables.product.prodname_codeql %} only analyzes the language with the most source files. Edit the workflow and add a build matrix specifying the languages you want to analyze. The default CodeQL analysis workflow uses such a matrix.
|
||||
- If your workflow doesn't explicitly specify the languages to analyze, {% data variables.product.prodname_codeql %} implicitly detects the supported languages in your code base. In this configuration, out of the compiled languages C/C++, C#, and Java, {% data variables.product.prodname_codeql %} only analyzes the language with the most source files. Edit the workflow and add a matrix specifying the languages you want to analyze. The default CodeQL analysis workflow uses such a matrix.
|
||||
|
||||
The following extracts from a workflow show how you can use a matrix within the job strategy to specify languages, and then reference each language within the "Initialize {% data variables.product.prodname_codeql %}" step:
|
||||
|
||||
@@ -190,7 +190,7 @@ If you use self-hosted runners to run {% data variables.product.prodname_codeql
|
||||
|
||||
### Use matrix builds to parallelize the analysis
|
||||
|
||||
The default {% data variables.product.prodname_codeql_workflow %} uses a build matrix of languages, which causes the analysis of each language to run in parallel. If you have specified the languages you want to analyze directly in the "Initialize CodeQL" step, analysis of each language will happen sequentially. To speed up analysis of multiple languages, modify your workflow to use a matrix. For more information, see the workflow extract in "[Automatic build for a compiled language fails](#automatic-build-for-a-compiled-language-fails)" above.
|
||||
The default {% data variables.product.prodname_codeql_workflow %} uses a matrix of languages, which causes the analysis of each language to run in parallel. If you have specified the languages you want to analyze directly in the "Initialize CodeQL" step, analysis of each language will happen sequentially. To speed up analysis of multiple languages, modify your workflow to use a matrix. For more information, see the workflow extract in "[Automatic build for a compiled language fails](#automatic-build-for-a-compiled-language-fails)" above.
|
||||
|
||||
### Reduce the amount of code being analyzed in a single workflow
|
||||
|
||||
|
||||
@@ -31,8 +31,8 @@ To change how you view diffs, in the top-right corner of the diff view, click {%
|
||||
|
||||
|
||||
|
||||
If you need to see more of the file than {% data variables.product.prodname_desktop %} shows by default, you can expand the diff.
|
||||
- To see the next few lines above or below the highlighted changes, click the arrow above or below the line numbers.
|
||||
If you need to see more of the file than {% data variables.product.prodname_desktop %} shows by default, you can expand the diff.
|
||||
- To see the next few lines above or below the highlighted changes, click the arrow above or below the line numbers.
|
||||
- To see the entire file, right-click in the diff view and click **Expand Whole File**.
|
||||
|
||||
|
||||
@@ -122,3 +122,11 @@ Once you're satisfied with the changes you've chosen to include in your commit,
|
||||
|
||||
|
||||
{% data reusables.desktop.push-origin %}
|
||||
|
||||
6. If you have a pull request based off the branch you are working on, {% data variables.product.prodname_desktop %} will display the status of the checks that have run for the pull request. For more information about checks, see "[Viewing and re-running checks in GitHub Desktop](/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop)."
|
||||
|
||||
|
||||
|
||||
If a pull request has not been created for the current branch, {% data variables.product.prodname_desktop %} will give you the option to create one. For more information, see "[Creating an issue or pull request](/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request)."
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
title: Configuring notifications in GitHub Desktop
|
||||
shortTitle: Configuring notifications
|
||||
intro: '{% data variables.product.prodname_desktop %} will keep you up-to-date with notifications about events that occur in your pull request branch.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
---
|
||||
## About notifications in {% data variables.product.prodname_desktop %}
|
||||
|
||||
{% data variables.product.prodname_desktop %} will show a system notification for events that occur in the currently selected repository. Notifications will be shown when:
|
||||
|
||||
- Pull request checks have failed.
|
||||
- A pull request review is left with a comment, approval, or requested changes.
|
||||
|
||||
Clicking the notification will switch application focus to {% data variables.product.prodname_desktop %} and provide more detailed information.
|
||||
|
||||
## Notifications about pull request check failures
|
||||
|
||||
When changes are made to a pull request branch, you will receive a notification if the checks fail.
|
||||
|
||||
|
||||
|
||||
Clicking the notification will display a dialog with details about the checks. Once you've reviewed why the checks have failed, you can re-run the checks, or quickly switch to the pull request branch to get started on fixing the errors. For more information, see "[Viewing and re-running checks in GitHub Desktop](/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop)."
|
||||
|
||||
|
||||
## Notifications for pull request reviews
|
||||
|
||||
{% data variables.product.prodname_desktop %} will surface a system notification when a teammate has approved, commented, or requested changes in your pull request. See "[About pull request reviews](/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews)" for more information on pull request reviews.
|
||||
|
||||
|
||||
|
||||
Clicking the notification will switch application focus to {% data variables.product.prodname_desktop %} and provide more context for the pull request review comment.
|
||||
|
||||
|
||||
## Enabling notifications
|
||||
|
||||
If system notifications are disabled for {% data variables.product.prodname_desktop %} you can follow the steps below to enable them.
|
||||
|
||||
{% mac %}
|
||||
|
||||
1. Click the **Apple** menu, then select **System Preferences**.
|
||||
2. Select **Notifications & Focus**.
|
||||
3. Select **{% data variables.product.prodname_desktop %}** from the list of applications.
|
||||
4. Click **Allow Notifications**.
|
||||
|
||||
|
||||
|
||||
For more information about macOS system notifications, see "[Use notifications on your Mac](https://support.apple.com/en-us/HT204079)."
|
||||
|
||||
{% endmac %}
|
||||
|
||||
{% windows %}
|
||||
|
||||
1. Open the **Start** menu, then select **Settings**.
|
||||
2. Select **System**, then click **Notifications**.
|
||||
3. Find **{% data variables.product.prodname_desktop %}** in the application list and click **On**.
|
||||
|
||||
|
||||
|
||||
For more information about Windows system notifications, see "[Change notification settings in Windows](https://support.microsoft.com/en-us/windows/change-notification-settings-in-windows-8942c744-6198-fe56-4639-34320cf9444e)."
|
||||
|
||||
{% endwindows %}
|
||||
@@ -8,6 +8,8 @@ versions:
|
||||
children:
|
||||
- /creating-an-issue-or-pull-request
|
||||
- /viewing-a-pull-request-in-github-desktop
|
||||
- /viewing-and-re-running-checks-in-github-desktop
|
||||
- /configuring-notifications-in-github-desktop
|
||||
- /changing-a-remotes-url-from-github-desktop
|
||||
shortTitle: Work with your remote repo
|
||||
---
|
||||
|
||||
@@ -14,6 +14,8 @@ You can view pull requests that you or your collaborators have proposed in {% da
|
||||
|
||||
When you view a pull request in {% data variables.product.prodname_desktop %}, you can see a history of commits that contributors made. You can also see which files the commits modified, added, or deleted. From {% data variables.product.prodname_desktop %}, you can open repositories in your preferred text editor to view any changes or make additional changes. After reviewing changes in a pull request, you can give feedback on {% data variables.product.prodname_dotcom %}. For more information, see "[About pull request reviews](/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews)."
|
||||
|
||||
If checks have been enabled in your repository, {% data variables.product.prodname_desktop %} will show the status of the checks on the pull request and allow you to re-run checks. For more information, see "[Viewing and re-running checks in GitHub Desktop](/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop)."
|
||||
|
||||
## Viewing a pull request in {% data variables.product.prodname_desktop %}
|
||||
{% data reusables.desktop.current-branch-menu %}
|
||||
{% data reusables.desktop.click-pull-requests %}
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: Viewing and re-running checks in GitHub Desktop
|
||||
shortTitle: Viewing and re-running checks
|
||||
intro: 'You can view the status of checks and re-run them in {% data variables.product.prodname_desktop %}.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
---
|
||||
## About checks in {% data variables.product.prodname_desktop %}
|
||||
|
||||
{% data variables.product.prodname_desktop %} displays the status of checks that have run in your pull request branches. The checks badge next to the branch name will display the *pending, passing,* or *failing* state of the checks. You can also re-run all, failed, or individual checks when viewing the status of the checks in {% data variables.product.prodname_desktop %}. For more information on setting up checks in your repository, see "[About status checks](/github/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)."
|
||||
|
||||
{% data variables.product.prodname_desktop %} will also show a system notification when checks fail. For more information on enabling notifications, see "[Configuring notifications in GitHub Desktop](/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/configuring-notifications-in-github-desktop)."
|
||||
|
||||
## Viewing and re-running checks
|
||||
|
||||
{% data reusables.desktop.current-branch-menu %}
|
||||
{% data reusables.desktop.click-pull-requests %}
|
||||
|
||||
{% data reusables.desktop.choose-pr-from-list %}
|
||||
|
||||
4. Click on the pull request number, to the right of the pull request branch name.
|
||||
|
||||
5. To re-run failed checks, click **{% octicon "sync" aria-label="The sync icon" %} Re-run** and select **Re-run Failed Checks**.
|
||||
|
||||
6. To re-run individual checks, hover over the individual check you want to re-run and select the {% octicon "sync" aria-label="The sync icon" %} icon to re-run the check.
|
||||
|
||||
7. You will see a confirmation dialog with the summary of the checks that will be re-run. Click **Re-run Checks** to confirm that you want to perform the re-run.
|
||||
|
||||
@@ -18,7 +18,7 @@ shortTitle: Learning resources
|
||||
---
|
||||
## Using Git
|
||||
|
||||
Familiarize yourself with Git by visiting the [official Git project site](https://git-scm.com) and reading the [ProGit book](http://git-scm.com/book). You can review the [Git command list](https://git-scm.com/docs) or [Git command lookup reference](http://gitref.org) while using the [Try Git](https://try.github.com) simulator.
|
||||
Familiarize yourself with Git by visiting the [official Git project site](https://git-scm.com) and reading the [ProGit book](http://git-scm.com/book). You can also review the [Git command list](https://git-scm.com/docs).
|
||||
|
||||
## Using {% data variables.product.product_name %}
|
||||
|
||||
|
||||
@@ -23,6 +23,7 @@ permissions: 'Organization owners can remove members from an organization.'
|
||||
**Warning:** When you remove members from an organization:
|
||||
- The paid license count does not automatically downgrade. To pay for fewer licenses after removing users from your organization, follow the steps in "[Downgrading your organization's paid seats](/articles/downgrading-your-organization-s-paid-seats)."
|
||||
- Removed members will lose access to private forks of your organization's private repositories, but they may still have local copies. However, they cannot sync local copies with your organization's repositories. Their private forks can be restored if the user is [reinstated as an organization member](/articles/reinstating-a-former-member-of-your-organization) within three months of being removed from the organization. Ultimately, you are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property.
|
||||
- When private repositories are forked to other organizations, those organizations are able to control access to the fork network. This means users may retain access to the forks even after losing access to the original organization because they will still have explicit access via a fork.
|
||||
{%- ifversion ghec %}
|
||||
- Removed members will also lose access to private forks of your organization's internal repositories, if the removed member is not a member of any other organization owned by the same enterprise account. For more information, see "[About enterprise accounts](/admin/overview/about-enterprise-accounts)."
|
||||
{%- endif %}
|
||||
|
||||
@@ -300,7 +300,7 @@ versions:
|
||||
- Include any additional features the setup action might provide that are useful to CI.
|
||||
- If applicable, provide examples of configuring exact versions or major/minor versions.
|
||||
- Include information about software already installed on GitHub-hosted runners or software configuration necessary to build and test the project.
|
||||
- Provide examples of configuring build matrix strategies.
|
||||
- Provide examples of configuring matrix strategies.
|
||||
- Link out to any docs about available software on the GitHub-hosted runners. (Ex. https://docs.github.com/en/actions/reference/software-installed-on-github-hosted-runners).
|
||||
- Include code samples.
|
||||
-->
|
||||
|
||||
@@ -46,7 +46,6 @@ sections:
|
||||
- When "Users can search GitHub.com" is enabled with {% data variables.product.prodname_github_connect %}, issues in private and internal repositories are not included in {% data variables.product.prodname_dotcom_the_website %} search results.
|
||||
- The {% data variables.product.prodname_registry %} npm registry no longer returns a time value in metadata responses. This was done to allow for substantial performance improvements. We continue to have all the data necessary to return a time value as part of the metadata response and will resume returning this value in the future once we have solved the existing performance issues.
|
||||
- Resource limits that are specific to processing pre-receive hooks may cause some pre-receive hooks to fail.
|
||||
- Actions services need to be restarted after restoring appliance from backup taken on a different host.
|
||||
- |
|
||||
When using SAML encrypted assertions with {% data variables.product.prodname_ghe_server %} 3.4.0 and 3.4.1, a new XML attribute `WantAssertionsEncrypted` in the `SPSSODescriptor` contains an invalid attribute for SAML metadata. IdPs that consume this SAML metadata endpoint may encounter errors when validating the SAML metadata XML schema. A fix will be available in the next patch release. [Updated: 2022-04-11]
|
||||
|
||||
|
||||
@@ -13,17 +13,12 @@ sections:
|
||||
- When converting a user account to an organization, if the user account was an owner of the {% data variables.product.prodname_ghe_server %} enterprise account, the converted organization would incorrectly appear in the enterprise owner list.
|
||||
- The `/stafftools/users/ip_addresses/:address` page responded with a `500 Internal Server Error` when attempting to display the page for an IPv6 address.
|
||||
- Creating an impersonation OAuth token using the Enterprise Administration REST API resulted in an error when an integration matching the OAuth Application ID already existed.
|
||||
- |
|
||||
When using SAML encrypted assertions with {% data variables.product.prodname_ghe_server %} 3.4.0 and 3.4.1, a new XML attribute `WantAssertionsEncrypted` in the `SPSSODescriptor` contains an invalid attribute for SAML metadata. IdPs that consume this SAML metadata endpoint may encounter errors when validating the SAML metadata XML schema. A fix will be available in the next patch release. [Updated: 2022-04-11]
|
||||
|
||||
To work around this problem, you can take one of the two following actions.
|
||||
- Reconfigure the IdP by uploading a static copy of the SAML metadata without the `WantAssertionsEncrypted` attribute.
|
||||
- Copy the SAML metadata, remove `WantAssertionsEncrypted` attribute, host it on a web server, and reconfigure the IdP to point to that URL.
|
||||
|
||||
changes:
|
||||
- Added support for replica domain names that are more than 63 characters.
|
||||
- Configuration errors that halt a config apply run are now output to the terminal in addition to the configuration log.
|
||||
- If {% data variables.product.prodname_GH_advanced_security %} features are enabled on your instance, the performance of background jobs has improved when processing batches for repository contributions.
|
||||
|
||||
known_issues:
|
||||
- On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user.
|
||||
- Custom firewall rules are removed during the upgrade process.
|
||||
@@ -32,7 +27,6 @@ sections:
|
||||
- When "Users can search GitHub.com" is enabled with {% data variables.product.prodname_github_connect %}, issues in private and internal repositories are not included in {% data variables.product.prodname_dotcom_the_website %} search results.
|
||||
- The {% data variables.product.prodname_registry %} npm registry no longer returns a time value in metadata responses. This was done to allow for substantial performance improvements. We continue to have all the data necessary to return a time value as part of the metadata response and will resume returning this value in the future once we have solved the existing performance issues.
|
||||
- Resource limits that are specific to processing pre-receive hooks may cause some pre-receive hooks to fail.
|
||||
- Actions services need to be restarted after restoring appliance from backup taken on a different host.
|
||||
- |
|
||||
When using SAML encrypted assertions with {% data variables.product.prodname_ghe_server %} 3.4.0 and 3.4.1, a new XML attribute `WantAssertionsEncrypted` in the `SPSSODescriptor` contains an invalid attribute for SAML metadata. IdPs that consume this SAML metadata endpoint may encounter errors when validating the SAML metadata XML schema. A fix will be available in the next patch release. [Updated: 2022-04-11]
|
||||
|
||||
|
||||
1
data/reusables/actions/jobs/about-matrix-strategy.md
Normal file
1
data/reusables/actions/jobs/about-matrix-strategy.md
Normal file
@@ -0,0 +1 @@
|
||||
A matrix strategy lets you use variables in a single job definition to automatically create multiple job runs that are based the combinations of the variables. For example, you can use a matrix strategy to test your code in multiple versions of a language or on multiple operating systems.
|
||||
29
data/reusables/actions/jobs/matrix-add-with-include.md
Normal file
29
data/reusables/actions/jobs/matrix-add-with-include.md
Normal file
@@ -0,0 +1,29 @@
|
||||
For example, this matrix will run 10 jobs, one for each combination of `os` and `version` in the matrix, plus a job for the `os` value of `windows-latest` and `version` value of `17`.
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
example_matrix:
|
||||
strategy:
|
||||
matrix:
|
||||
os: [macos-latest, windows-latest, ubuntu-latest]
|
||||
version: [12, 14, 16]
|
||||
include:
|
||||
- os: windows-latest
|
||||
version: 17
|
||||
```
|
||||
|
||||
If you don't specify any matrix variables, all configurations under `include` will run. For example, the following workflow would run two jobs, one for each `include` entry. This lets you take advantage of the matrix strategy without having a fully populated matrix.
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
includes_only:
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
include:
|
||||
- site: "production"
|
||||
datacenter: "site-a"
|
||||
- site: "staging"
|
||||
datacenter: "site-b"
|
||||
|
||||
```
|
||||
22
data/reusables/actions/jobs/matrix-exclude.md
Normal file
22
data/reusables/actions/jobs/matrix-exclude.md
Normal file
@@ -0,0 +1,22 @@
|
||||
To remove specific configurations defined in the matrix, use `jobs.<job_id>.strategy.matrix.exclude`. An excluded configuration only has to be a partial match for it to be excluded. For example, the following workflow will run nine jobs: one job for each of the 12 configurations, minus the one excluded job that matches `{os: macos-latest, version: 12, environment: production}`, and the two excluded jobs that match `{os: windows-latest, version: 16}`.
|
||||
|
||||
```yaml
|
||||
strategy:
|
||||
matrix:
|
||||
os: [macos-latest, windows-latest]
|
||||
version: [12, 14, 16]
|
||||
environment: [staging, production]
|
||||
exclude:
|
||||
- os: macos-latest
|
||||
version: 12
|
||||
environment: production
|
||||
- os: windows-latest
|
||||
version: 16
|
||||
runs-on: {% raw %}${{ matrix.os }}{% endraw %}
|
||||
```
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** All `include` combinations are processed after `exclude`. This allows you to use `include` to add back combinations that were previously excluded.
|
||||
|
||||
{% endnote %}
|
||||
22
data/reusables/actions/jobs/matrix-expand-with-include.md
Normal file
22
data/reusables/actions/jobs/matrix-expand-with-include.md
Normal file
@@ -0,0 +1,22 @@
|
||||
For example, the following workflow will run six jobs, one for each combination of `os` and `node`. When the job for the `os` value of `windows-latest` and `node` value of `16` runs, an additional variable called `npm` with the value of `6` will be included in the job.
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
example_matrix:
|
||||
strategy:
|
||||
matrix:
|
||||
os: [windows-latest, ubuntu-latest]
|
||||
node: [12, 14, 16]
|
||||
include:
|
||||
- os: windows-latest
|
||||
node: 16
|
||||
npm: 6
|
||||
runs-on: {% raw %}${{ matrix.os }}{% endraw %}
|
||||
steps:
|
||||
- uses: {% data reusables.actions.action-setup-node %}
|
||||
with:
|
||||
node-version: {% raw %}${{ matrix.node }}{% endraw %}
|
||||
- if: {% raw %}${{ matrix.npm }}{% endraw %}
|
||||
run: npm install -g npm@{% raw %}${{ matrix.npm }}{% endraw %}
|
||||
- run: npm --version
|
||||
```
|
||||
30
data/reusables/actions/jobs/matrix-from-context.md
Normal file
30
data/reusables/actions/jobs/matrix-from-context.md
Normal file
@@ -0,0 +1,30 @@
|
||||
You can use contexts to create matrices. For more information about contexts, see "[Contexts](/actions/learn-github-actions/contexts)."
|
||||
|
||||
For example, the following workflow triggers on the `repository_dispatch` event and uses information from the event payload to build the matrix. When a repository dispatch event is created with a payload like the one below, the matrix `version` variable will have a value of `[12, 14, 16]`. For more information about the `repository_dispatch` trigger, see "[Events that trigger workflows](/actions/using-workflows/events-that-trigger-workflows#repository_dispatch)."
|
||||
|
||||
```json
|
||||
{
|
||||
"event_type": "test",
|
||||
"client_payload": {
|
||||
"versions": [12, 14, 16]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
```yaml
|
||||
on:
|
||||
repository_dispatch:
|
||||
types:
|
||||
- test
|
||||
|
||||
jobs:
|
||||
example_matrix:
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
version: {% raw %}${{ github.event.client_payload.versions }}{% endraw %}
|
||||
steps:
|
||||
- uses: {% data reusables.actions.action-setup-node %}
|
||||
with:
|
||||
node-version: {% raw %}${{ matrix.version }}{% endraw %}
|
||||
```
|
||||
38
data/reusables/actions/jobs/matrix-include.md
Normal file
38
data/reusables/actions/jobs/matrix-include.md
Normal file
@@ -0,0 +1,38 @@
|
||||
Use `jobs.<job_id>.strategy.matrix.include` to expand existing matrix configurations or to add new configurations. The value of `include` is a list of objects.
|
||||
|
||||
For each object in the `include` list, the key:value pairs in the object will be added to each of the matrix combinations if none of the key:value pairs overwrite any of the original matrix values. If the object cannot be added to any of the matrix combinations, a new matrix combination will be created instead. Note that the original matrix values will not be overwritten, but added matrix values can be overwritten.
|
||||
|
||||
For example, this matrix:
|
||||
|
||||
```yaml
|
||||
strategy:
|
||||
matrix:
|
||||
fruit: [apple, pear]
|
||||
animal: [cat, dog]
|
||||
include:
|
||||
- color: green
|
||||
- color: pink
|
||||
animal: cat
|
||||
- fruit: apple
|
||||
shape: circle
|
||||
- fruit: banana
|
||||
- fruit: banana
|
||||
animal: cat
|
||||
```
|
||||
|
||||
will result in six jobs with the following matrix combinations:
|
||||
|
||||
- `{fruit: apple, animal: cat, color: pink, shape: circle}`
|
||||
- `{fruit: apple, animal: dog, color: green, shape: circle}`
|
||||
- `{fruit: pear, animal: cat, color: pink}`
|
||||
- `{fruit: pear, animal: dog, color: green}`
|
||||
- `{fruit: banana}`
|
||||
- `{fruit: banana, animal: cat}`
|
||||
|
||||
following this logic:
|
||||
|
||||
- `{color: green}` is added to all of the original matrix combinations because it can be added without overwriting any part of the original combinations.
|
||||
- `{color: pink, animal: cat}` adds `color:pink` only to the original matrix combinations that include `animal: cat`. This overwrites the `color: green` that was added by the previous `include` entry.
|
||||
- `{fruit: apple, shape: circle}` adds `shape: circle` only to the original matrix combinations that include `fruit: apple`.
|
||||
- `{fruit: banana}` cannot be added to any original matrix combination without overwriting a value, so it is added as an additional matrix combination.
|
||||
- `{fruit: banana, animal: cat}` cannot be added to any original matrix combination without overwriting a value, so it is added as an additional matrix combination. It does not add to the `{fruit: banana}` matrix combination because that combination was not one of the original matrix combinations.
|
||||
22
data/reusables/actions/jobs/multi-dimension-matrix.md
Normal file
22
data/reusables/actions/jobs/multi-dimension-matrix.md
Normal file
@@ -0,0 +1,22 @@
|
||||
You can specify multiple variables to create a multi-dimensional matrix. A job will run for each possible combination of the variables.
|
||||
|
||||
For example, the following workflow specifies two variables:
|
||||
|
||||
- Two operating systems specified in the `os` variable
|
||||
- Three Node.js versions specified in the `version` variable
|
||||
|
||||
The workflow will run six jobs, one for each combination of the `os` and `version` variables. Each job will set the `runs-on` value to the current `os` value and will pass the current `version` value to the `actions/setup-node` action.
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
example_matrix:
|
||||
strategy:
|
||||
matrix:
|
||||
os: [ubuntu-18.04, ubuntu-20.04]
|
||||
version: [10, 12, 14]
|
||||
runs-on: {% raw %}${{ matrix.os }}{% endraw %}
|
||||
steps:
|
||||
- uses: {% data reusables.actions.action-setup-node %}
|
||||
with:
|
||||
node-version: {% raw %}${{ matrix.version }}{% endraw %}
|
||||
```
|
||||
@@ -1 +1,23 @@
|
||||
When `jobs.<job_id>.strategy.fail-fast` is set to `true`, {% data variables.product.prodname_dotcom %} cancels all in-progress jobs in the matrix if any `matrix` job fails. Default: `true`
|
||||
You can control how job failures are handled with `jobs.<job_id>.strategy.fail-fast` and `jobs.<job_id>.continue-on-error`.
|
||||
|
||||
`jobs.<job_id>.strategy.fail-fast` applies to the entire matrix. If `jobs.<job_id>.strategy.fail-fast` is set to `true`, {% data variables.product.product_name %} will cancel all in-progress and queued jobs in the matrix if any job in the matrix fails. This property defaults to `true`.
|
||||
|
||||
`jobs.<job_id>.continue-on-error` applies to a single job. If `jobs.<job_id>.continue-on-error` is `true`, other jobs in the matrix will continue running even if the job with `jobs.<job_id>.continue-on-error: true` fails.
|
||||
|
||||
You can use `jobs.<job_id>.strategy.fail-fast` and `jobs.<job_id>.continue-on-error` together. For example, the following workflow will start four jobs. For each job, `continue-on-error` is determined by the value of `matrix.experimental`. If any of the jobs with `continue-on-error: false` fail, all jobs that are in progress or queued will be cancelled. If the job with `continue-on-error: true` fails, the other jobs will not be affected.
|
||||
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
continue-on-error: {% raw %}${{ matrix.experimental }}{% endraw %}
|
||||
strategy:
|
||||
fail-fast: true
|
||||
matrix:
|
||||
version: [6, 7, 8]
|
||||
experimental: [false]
|
||||
include:
|
||||
- version: 9
|
||||
experimental: true
|
||||
```
|
||||
|
||||
@@ -1,122 +0,0 @@
|
||||
|
||||
Use `jobs.<job_id>.strategy.matrix` to define a matrix of different job configurations. A matrix allows you to create multiple jobs by performing variable substitution in a single job definition. For example, you can use a matrix to create jobs for more than one supported version of a programming language, operating system, or tool. A matrix reuses the job's configuration and creates a job for each matrix you configure.
|
||||
|
||||
{% data reusables.actions.usage-matrix-limits %}
|
||||
|
||||
Each option you define in the `matrix` has a key and value. The keys you define become properties in the `matrix` context and you can reference the property in other areas of your workflow file. For example, if you define the key `os` that contains an array of operating systems, you can use the `matrix.os` property as the value of the `runs-on` keyword to create a job for each operating system. For more information, see "[Contexts](/actions/learn-github-actions/contexts)."
|
||||
|
||||
The order that you define a `matrix` matters. The first option you define will be the first job that runs in your workflow.
|
||||
|
||||
#### Example: Running multiple versions of Node.js
|
||||
|
||||
You can specify a matrix by supplying an array for the configuration options. For example, if the runner supports Node.js versions 10, 12, and 14, you could specify an array of those versions in the `matrix`.
|
||||
|
||||
This example creates a matrix of three jobs by setting the `node` key to an array of three Node.js versions. To use the matrix, the example sets the `matrix.node` context property as the value of the `setup-node` action's input parameter `node-version`. As a result, three jobs will run, each using a different Node.js version.
|
||||
|
||||
```yaml
|
||||
strategy:
|
||||
matrix:
|
||||
node: [10, 12, 14]
|
||||
steps:
|
||||
# Configures the node version used on GitHub-hosted runners
|
||||
- uses: {% data reusables.actions.action-setup-node %}
|
||||
with:
|
||||
# The Node.js version to configure
|
||||
node-version: {% raw %}${{ matrix.node }}{% endraw %}
|
||||
```
|
||||
|
||||
The `setup-node` action is the recommended way to configure a Node.js version when using {% data variables.product.prodname_dotcom %}-hosted runners. For more information, see the [`setup-node`](https://github.com/actions/setup-node) action.
|
||||
|
||||
#### Example: Running with multiple operating systems
|
||||
|
||||
You can create a matrix to run workflows on more than one runner operating system. You can also specify more than one matrix configuration. This example creates a matrix of 6 jobs:
|
||||
|
||||
- 2 operating systems specified in the `os` array
|
||||
- 3 Node.js versions specified in the `node` array
|
||||
|
||||
{% data reusables.repositories.actions-matrix-builds-os %}
|
||||
|
||||
```yaml
|
||||
runs-on: {% raw %}${{ matrix.os }}{% endraw %}
|
||||
strategy:
|
||||
matrix:
|
||||
os: [ubuntu-18.04, ubuntu-20.04]
|
||||
node: [10, 12, 14]
|
||||
steps:
|
||||
- uses: {% data reusables.actions.action-setup-node %}
|
||||
with:
|
||||
node-version: {% raw %}${{ matrix.node }}{% endraw %}
|
||||
```
|
||||
|
||||
{% ifversion ghae %}
|
||||
For more information about the configuration of self-hosted runners, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)."
|
||||
{% else %}To find supported configuration options for {% data variables.product.prodname_dotcom %}-hosted runners, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)."
|
||||
{% endif %}
|
||||
|
||||
#### Example: Including additional values in combinations
|
||||
|
||||
You can add additional configuration options to a build matrix job that already exists. For example, if you want to use a specific version of `npm` when the job that uses `windows-latest` and version 8 of `node` runs, you can use `include` to specify that additional option.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
runs-on: ${{ matrix.os }}
|
||||
strategy:
|
||||
matrix:
|
||||
os: [macos-latest, windows-latest, ubuntu-18.04]
|
||||
node: [8, 10, 12, 14]
|
||||
include:
|
||||
# includes a new variable of npm with a value of 6
|
||||
# for the matrix leg matching the os and version
|
||||
- os: windows-latest
|
||||
node: 8
|
||||
npm: 6
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
#### Example: Including new combinations
|
||||
|
||||
You can use `include` to add new jobs to a build matrix. Any unmatched include configurations are added to the matrix. For example, if you want to use `node` version 14 to build on multiple operating systems, but wanted one extra experimental job using node version 15 on Ubuntu, you can use `include` to specify that additional job.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
runs-on: ${{ matrix.os }}
|
||||
strategy:
|
||||
matrix:
|
||||
node: [14]
|
||||
os: [macos-latest, windows-latest, ubuntu-18.04]
|
||||
include:
|
||||
- node: 15
|
||||
os: ubuntu-18.04
|
||||
experimental: true
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
#### Example: Excluding configurations from a matrix
|
||||
|
||||
You can remove a specific configurations defined in the build matrix using the `exclude` option. Using `exclude` removes a job defined by the build matrix. The number of jobs is the cross product of the number of operating systems (`os`) included in the arrays you provide, minus any subtractions (`exclude`).
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
runs-on: ${{ matrix.os }}
|
||||
strategy:
|
||||
matrix:
|
||||
os: [macos-latest, windows-latest, ubuntu-18.04]
|
||||
node: [8, 10, 12, 14]
|
||||
exclude:
|
||||
# excludes node 8 on macOS
|
||||
- os: macos-latest
|
||||
node: 8
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** All `include` combinations are processed after `exclude`. This allows you to use `include` to add back combinations that were previously excluded.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
### Using environment variables in a matrix
|
||||
|
||||
You can add custom environment variables for each test combination by using the `include` key. You can then refer to the custom environment variables in a later step.
|
||||
|
||||
{% data reusables.actions.matrix-variable-example %}
|
||||
@@ -1,6 +1,13 @@
|
||||
Use `jobs.<job_id>.strategy.max-parallel` to set the maximum number of jobs that can run simultaneously when using a `matrix` job strategy. By default, {% data variables.product.prodname_dotcom %} will maximize the number of jobs run in parallel depending on the available runners on {% data variables.product.prodname_dotcom %}-hosted virtual machines.
|
||||
By default, {% data variables.product.product_name %} will maximize the number of jobs run in parallel depending on runner availability. To set the maximum number of jobs that can run simultaneously when using a `matrix` job strategy, use `jobs.<job_id>.strategy.max-parallel`.
|
||||
|
||||
For example, the following workflow will run a maximum of two jobs at a time, even if there are runners available to run all six jobs at once.
|
||||
|
||||
```yaml
|
||||
strategy:
|
||||
max-parallel: 2
|
||||
jobs:
|
||||
example_matrix:
|
||||
strategy:
|
||||
max-parallel: 2
|
||||
matrix:
|
||||
version: [10, 12, 14]
|
||||
os: [ubuntu-latest, windows-latest]
|
||||
```
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
Use `jobs.<job_id>.strategy` to create a build matrix for your jobs. You can define different variations to run each job in.
|
||||
15
data/reusables/actions/jobs/single-dimension-matrix.md
Normal file
15
data/reusables/actions/jobs/single-dimension-matrix.md
Normal file
@@ -0,0 +1,15 @@
|
||||
You can specify a single variable to create a single-dimension matrix.
|
||||
|
||||
For example, the following workflow defines the variable `version` with the values `[10, 12, 14]`. The workflow will run three jobs, one for each value in the variable. Each job will access the `version` value through the `matrix.version` context and pass the value as `node-version` to the `actions/setup-node` action.
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
example_matrix:
|
||||
strategy:
|
||||
matrix:
|
||||
version: [10, 12, 14]
|
||||
steps:
|
||||
- uses: {% data reusables.actions.action-setup-node %}
|
||||
with:
|
||||
node-version: {% raw %}${{ matrix.version }}{% endraw %}
|
||||
```
|
||||
25
data/reusables/actions/jobs/using-matrix-strategy.md
Normal file
25
data/reusables/actions/jobs/using-matrix-strategy.md
Normal file
@@ -0,0 +1,25 @@
|
||||
Use `jobs.<job_id>.strategy.matrix` to define a matrix of different job configurations. Within your matrix, define one or more variables followed by an array of values. For example, the following matrix has a veriable called `version` with the value `[10, 12, 14]` and a variable called `os` with the value `[ubuntu-latest, windows-latest]`:
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
example_matrix:
|
||||
strategy:
|
||||
matrix:
|
||||
version: [10, 12, 14]
|
||||
os: [ubuntu-latest, windows-latest]
|
||||
```
|
||||
|
||||
A job will run for each possible combination of the variables. In this example, the workflow will run six jobs, one for each combination of the `os` and `version` variables.
|
||||
|
||||
By default, {% data variables.product.product_name %} will maximize the number of jobs run in parallel depending on runner availability. The order of the variables in the matrix determines the order in which the jobs are created. The first variable you define will be the first job that is created in your workflow run. For example, the above matrix will create the jobs in the following order:
|
||||
|
||||
- `{version: 10, os: ubuntu-latest}`
|
||||
- `{version: 10, os: windows-latest}`
|
||||
- `{version: 12, os: ubuntu-latest}`
|
||||
- `{version: 12, os: windows-latest}`
|
||||
- `{version: 14, os: ubuntu-latest}`
|
||||
- `{version: 14, os: windows-latest}`
|
||||
|
||||
A matrix will generate a maximum of 256 jobs per workflow run. This limit applies to both {% data variables.product.product_name %}-hosted and self-hosted runners.
|
||||
|
||||
The variables that you define become properties in the `matrix` context, and you can reference the property in other areas of your workflow file. In this example, you can use `matrix.version` and `matrix.os` to access the current value of `version` and `os` that the job is using. For more information, see "[Contexts](/actions/learn-github-actions/contexts)."
|
||||
@@ -1,4 +1,6 @@
|
||||
1. In your project, click {% octicon "workflow" aria-label="the workflow icon" %}.
|
||||
1. Navigate to your project.
|
||||
1. In the top-right, click {% octicon "kebab-horizontal" aria-label="The menu icon" %} to open the menu.
|
||||
1. In the menu, click {% octicon "workflow" aria-label="The workflow icon" %} **Workflows**.
|
||||
1. Under **Default workflows**, click on the workflow that you want to edit.
|
||||
1. If the workflow can apply to both issues and pull requests, next to **When**, check the item type(s) that you want to act on.
|
||||
1. Next to **Set**, choose the value that you want to set the status to.
|
||||
|
||||
@@ -1,2 +1,3 @@
|
||||
1. Navigate to your project.
|
||||
1. Click {% octicon "gear" aria-label="the gear icon" %} to access the project settings.
|
||||
1. In the top-right, click {% octicon "kebab-horizontal" aria-label="The menu icon" %} to open the menu.
|
||||
1. In the menu, click {% octicon "gear" aria-label="The gear icon" %} **Settings** to access the project settings.
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
When you define a matrix of operating systems, you must set the value of `runs-on` to the `matrix.os` context property you defined.
|
||||
@@ -11,9 +11,9 @@ Adobe | Adobe Short-Lived Access Token | adobe_short_lived_access_token{% endif
|
||||
Adobe | Adobe JSON Web Token | adobe_jwt{% endif %}
|
||||
Alibaba Cloud | Alibaba Cloud Access Key ID | alibaba_cloud_access_key_id
|
||||
Alibaba Cloud | Alibaba Cloud Access Key Secret | alibaba_cloud_access_key_secret
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Amazon | Amazon OAuth Client ID | amazon_oauth_client_id{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Amazon | Amazon OAuth Client Secret | amazon_oauth_client_secret{% endif %}
|
||||
Amazon Web Services (AWS) | Amazon AWS Access Key ID | aws_access_key_id
|
||||
Amazon Web Services (AWS) | Amazon AWS Secret Access Key | aws_secret_access_key
|
||||
@@ -27,9 +27,9 @@ Atlassian | Atlassian API Token | atlassian_api_token
|
||||
Atlassian | Atlassian JSON Web Token | atlassian_jwt
|
||||
{%- ifversion fpt or ghec or ghes > 3.1 or ghae %}
|
||||
Atlassian | Bitbucket Server Personal Access Token | bitbucket_server_personal_access_token{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Azure | Azure Active Directory Application Secret | azure_active_directory_application_secret{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Azure | Azure Cache for Redis Access Key | azure_cache_for_redis_access_key{% endif %}
|
||||
Azure | Azure DevOps Personal Access Token | azure_devops_personal_access_token
|
||||
Azure | Azure SAS Token | azure_sas_token
|
||||
@@ -88,7 +88,7 @@ GitHub | GitHub Refresh Token | github_refresh_token{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.1 or ghae %}
|
||||
GitHub | GitHub App Installation Access Token | github_app_installation_access_token{% endif %}
|
||||
GitHub | GitHub SSH Private Key | github_ssh_private_key
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
GitLab | GitLab Access Token | gitlab_access_token{% endif %}
|
||||
GoCardless | GoCardless Live Access Token | gocardless_live_access_token
|
||||
GoCardless | GoCardless Sandbox Access Token | gocardless_sandbox_access_token
|
||||
@@ -102,13 +102,13 @@ Google | Google Cloud Storage Access Key Secret | google_cloud_storage_access_ke
|
||||
Google | Google Cloud Storage Service Account Access Key ID | google_cloud_storage_service_account_access_key_id{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
|
||||
Google | Google Cloud Storage User Access Key ID | google_cloud_storage_user_access_key_id{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Google | Google OAuth Access Token | google_oauth_access_token{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Google | Google OAuth Client ID | google_oauth_client_id{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Google | Google OAuth Client Secret | google_oauth_client_secret{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Google | Google OAuth Refresh Token | google_oauth_refresh_token{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.1 or ghae %}
|
||||
Grafana | Grafana API Key | grafana_api_key{% endif %}
|
||||
@@ -122,7 +122,7 @@ Intercom | Intercom Access Token | intercom_access_token{% endif %}
|
||||
Ionic | Ionic Personal Access Token | ionic_personal_access_token{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.1 or ghae %}
|
||||
Ionic | Ionic Refresh Token | ionic_refresh_token{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.4 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6944 %}
|
||||
JD Cloud | JD Cloud Access Key | jd_cloud_access_key{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
|
||||
JFrog | JFrog Platform Access Token | jfrog_platform_access_token{% endif %}
|
||||
@@ -138,15 +138,15 @@ Lob | Lob Live API Key | lob_live_api_key{% endif %}
|
||||
Lob | Lob Test API Key | lob_test_api_key{% endif %}
|
||||
Mailchimp | Mailchimp API Key | mailchimp_api_key
|
||||
Mailgun | Mailgun API Key | mailgun_api_key
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Mapbox | Mapbox Secret Access Token | mapbox_secret_access_token{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.1 or ghae %}
|
||||
MessageBird | MessageBird API Key | messagebird_api_key{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.1 or ghae %}
|
||||
Meta | Facebook Access Token | facebook_access_token{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Midtrans | Midtrans Production Server Key | midtrans_production_server_key{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Midtrans | Midtrans Sandbox Server Key | midtrans_sandbox_server_key{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
|
||||
New Relic | New Relic Personal API Key | new_relic_personal_api_key{% endif %}
|
||||
@@ -156,13 +156,13 @@ New Relic | New Relic REST API Key | new_relic_rest_api_key{% endif %}
|
||||
New Relic | New Relic Insights Query Key | new_relic_insights_query_key{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.2 or ghae-issue-5844 %}
|
||||
New Relic | New Relic License Key | new_relic_license_key{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Notion | Notion Integration Token | notion_integration_token{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Notion | Notion OAuth Client Secret | notion_oauth_client_secret{% endif %}
|
||||
npm | npm Access Token | npm_access_token
|
||||
NuGet | NuGet API Key | nuget_api_key
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Octopus Deploy | Octopus Deploy API Key | octopus_deploy_api_key{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.1 or ghae %}
|
||||
Onfido | Onfido Live API Token | onfido_live_api_token{% endif %}
|
||||
@@ -193,7 +193,7 @@ PyPI | PyPI API Token | pypi_api_token{% endif %}
|
||||
RubyGems | RubyGems API Key | rubygems_api_key{% endif %}
|
||||
Samsara | Samsara API Token | samsara_api_token
|
||||
Samsara | Samsara OAuth Access Token | samsara_oauth_access_token
|
||||
{%- ifversion fpt or ghec or ghes > 3.4 or ghae %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6944 %}
|
||||
Segment | Segment Public API Token | segment_public_api_token{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.1 or ghae %}
|
||||
SendGrid | SendGrid API Key | sendgrid_api_key{% endif %}
|
||||
@@ -212,11 +212,11 @@ Shopify | Shopify Private App Password | shopify_private_app_password
|
||||
Slack | Slack API Token | slack_api_token
|
||||
Slack | Slack Incoming Webhook URL | slack_incoming_webhook_url
|
||||
Slack | Slack Workflow Webhook URL | slack_workflow_webhook_url
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Square | Square Access Token | square_access_token{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Square | Square Production Application Secret | square_production_application_secret{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Square | Square Sandbox Application Secret | square_sandbox_application_secret{% endif %}
|
||||
SSLMate | SSLMate API Key | sslmate_api_key
|
||||
SSLMate | SSLMate Cluster Secret | sslmate_cluster_secret
|
||||
@@ -228,31 +228,31 @@ Stripe | Stripe Test API Restricted Key | stripe_test_restricted_key
|
||||
{%- ifversion fpt or ghec or ghes > 3.1 or ghae %}
|
||||
Stripe | Stripe Webhook Signing Secret | stripe_webhook_signing_secret{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.1 or ghae %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Supabase | Supabase Service Key | supabase_service_key{% endif %}
|
||||
Tableau | Tableau Personal Access Token | tableau_personal_access_token{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.1 or ghae %}
|
||||
Telegram | Telegram Bot Token | telegram_bot_token{% endif %}
|
||||
Tencent Cloud | Tencent Cloud Secret ID | tencent_cloud_secret_id
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Twilio | Twilio Access Token | twilio_access_token{% endif %}
|
||||
Twilio | Twilio Account String Identifier | twilio_account_sid
|
||||
Twilio | Twilio API Key | twilio_api_key
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Typeform | Typeform Personal Access Token | typeform_personal_access_token{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.4 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6944 %}
|
||||
WorkOS | WorkOS Production API Key | workos_production_api_key{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.4 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6944 %}
|
||||
WorkOS | WorkOS Staging API Key | workos_staging_api_key{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Yandex | Yandex.Cloud API Key | yandex_cloud_api_key{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Yandex | Yandex.Cloud IAM Cookie | yandex_cloud_iam_cookie{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Yandex | Yandex.Cloud IAM Token | yandex_cloud_iam_token{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Yandex | Yandex.Dictionary API Key | yandex_dictionary_api_key{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Yandex | Yandex.Predictor API Key | yandex_predictor_api_key{% endif %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 %}
|
||||
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5845 %}
|
||||
Yandex | Yandex.Translate API Key | yandex_translate_api_key{% endif %}
|
||||
|
||||
@@ -188,6 +188,8 @@
|
||||
"/rest/actions#disable-a-selected-organization-for-github-actions-in-an-enterprise": "/rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise",
|
||||
"/rest/actions#get-allowed-actions-for-an-enterprise": "/rest/actions/permissions#get-allowed-actions-for-an-enterprise",
|
||||
"/rest/actions#set-allowed-actions-for-an-enterprise": "/rest/actions/permissions#set-allowed-actions-for-an-enterprise",
|
||||
"/rest/actions#get-default-workflow-permissions-for-an-enterprise": "/rest/actions/permissions#get-default-workflow-permissions-for-an-enterprise",
|
||||
"/rest/actions#set-default-workflow-permissions-for-an-enterprise": "/rest/actions/permissions#set-default-workflow-permissions-for-an-enterprise",
|
||||
"/rest/actions#list-self-hosted-runner-groups-for-an-enterprise": "/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-enterprise",
|
||||
"/rest/actions#self-hosted-runner-groups": "/rest/actions/self-hosted-runner-groups",
|
||||
"/rest/actions#create-self-hosted-runner-group-for-an-enterprise": "/rest/actions/self-hosted-runner-groups#create-self-hosted-runner-group-for-an-enterprise",
|
||||
@@ -469,6 +471,8 @@
|
||||
"/rest/actions#set-workflow-access-to-a-repository": "/rest/actions/permissions#set-workflow-access-to-a-repository",
|
||||
"/rest/actions#get-allowed-actions-for-a-repository": "/rest/actions/permissions#get-allowed-actions-for-a-repository",
|
||||
"/rest/actions#set-allowed-actions-for-a-repository": "/rest/actions/permissions#set-allowed-actions-for-a-repository",
|
||||
"/rest/actions#get-default-workflow-permissions-for-a-repository": "/rest/actions/permissions#get-default-workflow-permissions-for-a-repository",
|
||||
"/rest/actions#set-default-workflow-permissions-for-a-repository": "/rest/actions/permissions#set-default-workflow-permissions-for-a-repository",
|
||||
"/rest/actions#list-self-hosted-runners-for-a-repository": "/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository",
|
||||
"/rest/actions#list-runner-applications-for-a-repository": "/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository",
|
||||
"/rest/actions#create-a-registration-token-for-a-repository": "/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository",
|
||||
|
||||
@@ -5,6 +5,14 @@
|
||||
"verb": "get",
|
||||
"requestPath": "/enterprises/{enterprise}/actions/cache/usage"
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/enterprises/{enterprise}/actions/permissions/workflow"
|
||||
},
|
||||
{
|
||||
"verb": "put",
|
||||
"requestPath": "/enterprises/{enterprise}/actions/permissions/workflow"
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/orgs/{org}/actions/cache/usage"
|
||||
@@ -241,6 +249,14 @@
|
||||
"verb": "put",
|
||||
"requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions"
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow"
|
||||
},
|
||||
{
|
||||
"verb": "put",
|
||||
"requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow"
|
||||
},
|
||||
{
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/actions/runners"
|
||||
|
||||
@@ -1207,6 +1207,129 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "https://api.github.com",
|
||||
"verb": "get",
|
||||
"requestPath": "/enterprises/{enterprise}/actions/permissions/workflow",
|
||||
"title": "Get default workflow permissions for an enterprise",
|
||||
"category": "actions",
|
||||
"subcategory": "permissions",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "enterprise",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": "<p>The slug version of the enterprise name. You can also substitute this value with the enterprise id.</p>"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"enabledForGitHubApps": true,
|
||||
"codeExamples": [
|
||||
{
|
||||
"key": "default",
|
||||
"request": {
|
||||
"description": "Example",
|
||||
"acceptHeader": "application/vnd.github.v3+json",
|
||||
"parameters": {
|
||||
"enterprise": "ENTERPRISE"
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"statusCode": "200",
|
||||
"contentType": "application/json",
|
||||
"description": "<p>Give read-only permission, and allow approving PRs.</p>",
|
||||
"example": {
|
||||
"default_workflow_permissions": "read",
|
||||
"can_approve_pull_request_reviews": true
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets the default workflow permissions granted to the <code>GITHUB_TOKEN</code> when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"<a href=\"https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise\">Enforcing a policy for workflow permissions in your enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.\nGitHub Apps must have the <code>enterprise_administration:write</code> permission to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>Success response</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "https://api.github.com",
|
||||
"verb": "put",
|
||||
"requestPath": "/enterprises/{enterprise}/actions/permissions/workflow",
|
||||
"title": "Set default workflow permissions for an enterprise",
|
||||
"category": "actions",
|
||||
"subcategory": "permissions",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "enterprise",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": "<p>The slug version of the enterprise name. You can also substitute this value with the enterprise id.</p>"
|
||||
}
|
||||
],
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p>The default workflow permissions granted to the GITHUB_TOKEN when running workflows.</p>",
|
||||
"enum": [
|
||||
"read",
|
||||
"write"
|
||||
],
|
||||
"name": "default_workflow_permissions",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.</p>",
|
||||
"name": "can_approve_pull_request_reviews",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
],
|
||||
"enabledForGitHubApps": true,
|
||||
"codeExamples": [
|
||||
{
|
||||
"key": "default",
|
||||
"request": {
|
||||
"contentType": "application/json",
|
||||
"description": "Give read-only permission, and allow approving PRs.",
|
||||
"acceptHeader": "application/vnd.github.v3+json",
|
||||
"bodyParameters": {
|
||||
"default_workflow_permissions": "read",
|
||||
"can_approve_pull_request_reviews": true
|
||||
},
|
||||
"parameters": {
|
||||
"enterprise": "ENTERPRISE"
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"statusCode": "204",
|
||||
"description": "<p>Success response</p>"
|
||||
}
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Sets the default workflow permissions granted to the <code>GITHUB_TOKEN</code> when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"<a href=\"https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise\">Enforcing a policy for workflow permissions in your enterprise</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.\nGitHub Apps must have the <code>enterprise_administration:write</code> permission to use this endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>Success response</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "https://api.github.com",
|
||||
"verb": "get",
|
||||
@@ -1877,7 +2000,7 @@
|
||||
"response": {
|
||||
"statusCode": "200",
|
||||
"contentType": "application/json",
|
||||
"description": "<p>Response</p>",
|
||||
"description": "<p>Give read-only permission, and allow approving PRs.</p>",
|
||||
"example": {
|
||||
"default_workflow_permissions": "read",
|
||||
"can_approve_pull_request_reviews": true
|
||||
@@ -1886,7 +2009,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets the default workflow permissions granted to the <code>GITHUB_TOKEN</code> when running workflows in an organization,\nas well if GitHub Actions can submit approving pull request reviews.</p>\n<p>You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>administration</code> organization permission to use this API.</p>",
|
||||
"descriptionHTML": "<p>Gets the default workflow permissions granted to the <code>GITHUB_TOKEN</code> when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"<a href=\"https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization\">Setting the permissions of the GITHUB_TOKEN for your organization</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>administration</code> organization permission to use this API.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -1928,11 +2051,11 @@
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>Whether GitHub Actions can submit approving pull request reviews.</p>",
|
||||
"description": "<p>Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.</p>",
|
||||
"name": "can_approve_pull_request_reviews",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Whether GitHub Actions can submit approving pull request reviews.",
|
||||
"rawDescription": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
],
|
||||
@@ -1942,7 +2065,7 @@
|
||||
"key": "default",
|
||||
"request": {
|
||||
"contentType": "application/json",
|
||||
"description": "Example",
|
||||
"description": "Give read-only permission, and allow approving PRs.",
|
||||
"acceptHeader": "application/vnd.github.v3+json",
|
||||
"bodyParameters": {
|
||||
"default_workflow_permissions": "read",
|
||||
@@ -1954,16 +2077,20 @@
|
||||
},
|
||||
"response": {
|
||||
"statusCode": "204",
|
||||
"description": "<p>Response</p>"
|
||||
"description": "<p>Success response</p>"
|
||||
}
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Sets the default workflow permissions granted to the <code>GITHUB_TOKEN</code> when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews.</p>\n<p>You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>administration</code> organization permission to use this API.</p>",
|
||||
"descriptionHTML": "<p>Sets the default workflow permissions granted to the <code>GITHUB_TOKEN</code> when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"<a href=\"https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization\">Setting the permissions of the GITHUB_TOKEN for your organization</a>.\"</p>\n<p>You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>administration</code> organization permission to use this API.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
"description": "<p>Success response</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "409",
|
||||
"description": "<p>Conflict response when changing a setting is prevented by the owning enterprise</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -2403,6 +2530,153 @@
|
||||
"description": "<p>No Content</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "https://api.github.com",
|
||||
"verb": "get",
|
||||
"requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow",
|
||||
"title": "Get default workflow permissions for a repository",
|
||||
"category": "actions",
|
||||
"subcategory": "permissions",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"enabledForGitHubApps": true,
|
||||
"codeExamples": [
|
||||
{
|
||||
"key": "default",
|
||||
"request": {
|
||||
"description": "Example",
|
||||
"acceptHeader": "application/vnd.github.v3+json",
|
||||
"parameters": {
|
||||
"owner": "OWNER",
|
||||
"repo": "REPO"
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"statusCode": "200",
|
||||
"contentType": "application/json",
|
||||
"description": "<p>Give read-only permission, and allow approving PRs.</p>",
|
||||
"example": {
|
||||
"default_workflow_permissions": "read",
|
||||
"can_approve_pull_request_reviews": true
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets the default workflow permissions granted to the <code>GITHUB_TOKEN</code> when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"<a href=\"https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository\">Setting the permissions of the GITHUB_TOKEN for your repository</a>.\"</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have the repository <code>administration</code> permission to use this API.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "https://api.github.com",
|
||||
"verb": "put",
|
||||
"requestPath": "/repos/{owner}/{repo}/actions/permissions/workflow",
|
||||
"title": "Set default workflow permissions for a repository",
|
||||
"category": "actions",
|
||||
"subcategory": "permissions",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
}
|
||||
],
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p>The default workflow permissions granted to the GITHUB_TOKEN when running workflows.</p>",
|
||||
"enum": [
|
||||
"read",
|
||||
"write"
|
||||
],
|
||||
"name": "default_workflow_permissions",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "<p>Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.</p>",
|
||||
"name": "can_approve_pull_request_reviews",
|
||||
"in": "body",
|
||||
"rawType": "boolean",
|
||||
"rawDescription": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.",
|
||||
"childParamsGroups": []
|
||||
}
|
||||
],
|
||||
"enabledForGitHubApps": true,
|
||||
"codeExamples": [
|
||||
{
|
||||
"key": "default",
|
||||
"request": {
|
||||
"contentType": "application/json",
|
||||
"description": "Give read-only permission, and allow approving PRs.",
|
||||
"acceptHeader": "application/vnd.github.v3+json",
|
||||
"bodyParameters": {
|
||||
"default_workflow_permissions": "read",
|
||||
"can_approve_pull_request_reviews": true
|
||||
},
|
||||
"parameters": {
|
||||
"owner": "OWNER",
|
||||
"repo": "REPO"
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"statusCode": "204",
|
||||
"description": "<p>Success response</p>"
|
||||
}
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Sets the default workflow permissions granted to the <code>GITHUB_TOKEN</code> when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"<a href=\"https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository\">Setting the permissions of the GITHUB_TOKEN for your repository</a>.\"</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have the repository <code>administration</code> permission to use this API.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>Success response</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "409",
|
||||
"description": "<p>Conflict response when changing a setting is prevented by the owning organization or enterprise</p>"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"secrets": [
|
||||
@@ -32139,6 +32413,29 @@
|
||||
},
|
||||
"descriptionHTML": ""
|
||||
},
|
||||
{
|
||||
"name": "tool_name",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"description": "The name of the tool used to generate the code scanning analysis."
|
||||
},
|
||||
"descriptionHTML": "<p>The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either <code>tool_name</code> or <code>tool_guid</code>, but not both.</p>"
|
||||
},
|
||||
{
|
||||
"name": "tool_guid",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
],
|
||||
"description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data."
|
||||
},
|
||||
"descriptionHTML": "<p>The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either <code>tool_guid</code> or <code>tool_name</code>, but not both.</p>"
|
||||
},
|
||||
{
|
||||
"name": "before",
|
||||
"in": "query",
|
||||
@@ -32203,7 +32500,7 @@
|
||||
"fixed"
|
||||
]
|
||||
},
|
||||
"descriptionHTML": "<p>Set to <code>open</code>, <code>closed, </code>fixed<code>, or </code>dismissed` to list code scanning alerts in a specific state.</p>"
|
||||
"descriptionHTML": "<p>Set to <code>open</code>, <code>closed</code>, <code>fixed</code>, or <code>dismissed</code> to list code scanning alerts in a specific state.</p>"
|
||||
},
|
||||
{
|
||||
"name": "sort",
|
||||
@@ -39547,7 +39844,7 @@
|
||||
"description": "<p>Validation failed</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories\">Enforcing repository management policies in your enterprise</a>.\"</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>"
|
||||
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories\">Enforcing repository management policies in your enterprise</a>.\"</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "https://api.github.com",
|
||||
@@ -90352,13 +90649,13 @@
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. A custom webhook event name.</p>",
|
||||
"description": "<p><strong>Required</strong>. A custom webhook event name. Must be 100 characters or fewer.</p>",
|
||||
"minLength": 1,
|
||||
"maxLength": 100,
|
||||
"name": "event_type",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A custom webhook event name.",
|
||||
"rawDescription": "A custom webhook event name. Must be 100 characters or fewer.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
|
||||
@@ -28343,7 +28343,7 @@
|
||||
"description": "<p>Validation failed</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.1/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.1/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.1/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/enterprise-server@3.1/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.1/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/enterprise-server@3.1/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>"
|
||||
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.1/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.1/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.1/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/enterprise-server@3.1/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.1/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/enterprise-server@3.1/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -71075,13 +71075,13 @@
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. A custom webhook event name.</p>",
|
||||
"description": "<p><strong>Required</strong>. A custom webhook event name. Must be 100 characters or fewer.</p>",
|
||||
"minLength": 1,
|
||||
"maxLength": 100,
|
||||
"name": "event_type",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A custom webhook event name.",
|
||||
"rawDescription": "A custom webhook event name. Must be 100 characters or fewer.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
|
||||
@@ -29411,7 +29411,7 @@
|
||||
"description": "<p>Validation failed</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.2/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.2/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/enterprise-server@3.2/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/enterprise-server@3.2/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>"
|
||||
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.2/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.2/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/enterprise-server@3.2/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/enterprise-server@3.2/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -73867,13 +73867,13 @@
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. A custom webhook event name.</p>",
|
||||
"description": "<p><strong>Required</strong>. A custom webhook event name. Must be 100 characters or fewer.</p>",
|
||||
"minLength": 1,
|
||||
"maxLength": 100,
|
||||
"name": "event_type",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A custom webhook event name.",
|
||||
"rawDescription": "A custom webhook event name. Must be 100 characters or fewer.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
|
||||
@@ -29566,7 +29566,7 @@
|
||||
"description": "<p>Validation failed</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.3/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/enterprise-server@3.3/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/enterprise-server@3.3/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>"
|
||||
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.3/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/enterprise-server@3.3/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/enterprise-server@3.3/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -73808,13 +73808,13 @@
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. A custom webhook event name.</p>",
|
||||
"description": "<p><strong>Required</strong>. A custom webhook event name. Must be 100 characters or fewer.</p>",
|
||||
"minLength": 1,
|
||||
"maxLength": 100,
|
||||
"name": "event_type",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A custom webhook event name.",
|
||||
"rawDescription": "A custom webhook event name. Must be 100 characters or fewer.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
|
||||
@@ -31002,7 +31002,7 @@
|
||||
"description": "<p>Validation failed</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.4/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.4/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/enterprise-server@3.4/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/enterprise-server@3.4/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>"
|
||||
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.4/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.4/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/enterprise-server@3.4/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/enterprise-server@3.4/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "http(s)://HOSTNAME/api/v3",
|
||||
@@ -78125,13 +78125,13 @@
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. A custom webhook event name.</p>",
|
||||
"description": "<p><strong>Required</strong>. A custom webhook event name. Must be 100 characters or fewer.</p>",
|
||||
"minLength": 1,
|
||||
"maxLength": 100,
|
||||
"name": "event_type",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A custom webhook event name.",
|
||||
"rawDescription": "A custom webhook event name. Must be 100 characters or fewer.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
|
||||
@@ -26866,7 +26866,7 @@
|
||||
"description": "<p>Validation failed</p>"
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories\">Enforcing repository management policies in your enterprise</a>.\"</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>"
|
||||
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories\">Enforcing repository management policies in your enterprise</a>.\"</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>"
|
||||
},
|
||||
{
|
||||
"serverUrl": "https://HOSTNAME/api/v3",
|
||||
@@ -68699,13 +68699,13 @@
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "<p><strong>Required</strong>. A custom webhook event name.</p>",
|
||||
"description": "<p><strong>Required</strong>. A custom webhook event name. Must be 100 characters or fewer.</p>",
|
||||
"minLength": 1,
|
||||
"maxLength": 100,
|
||||
"name": "event_type",
|
||||
"in": "body",
|
||||
"rawType": "string",
|
||||
"rawDescription": "A custom webhook event name.",
|
||||
"rawDescription": "A custom webhook event name. Must be 100 characters or fewer.",
|
||||
"childParamsGroups": []
|
||||
},
|
||||
{
|
||||
|
||||
@@ -20043,6 +20043,143 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/enterprises/{enterprise}/actions/permissions/workflow": {
|
||||
"get": {
|
||||
"summary": "Get default workflow permissions for an enterprise",
|
||||
"description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\nGitHub Apps must have the `enterprise_administration:write` permission to use this endpoint.",
|
||||
"tags": [
|
||||
"actions"
|
||||
],
|
||||
"operationId": "actions/get-github-actions-default-workflow-permissions-enterprise",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/actions#get-default-workflow-permissions-for-an-enterprise"
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "enterprise",
|
||||
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Success response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"default_workflow_permissions": {
|
||||
"type": "string",
|
||||
"description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.",
|
||||
"enum": [
|
||||
"read",
|
||||
"write"
|
||||
]
|
||||
},
|
||||
"can_approve_pull_request_reviews": {
|
||||
"type": "boolean",
|
||||
"description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"default_workflow_permissions",
|
||||
"can_approve_pull_request_reviews"
|
||||
]
|
||||
},
|
||||
"examples": {
|
||||
"default": {
|
||||
"summary": "Give read-only permission, and allow approving PRs.",
|
||||
"value": {
|
||||
"default_workflow_permissions": "read",
|
||||
"can_approve_pull_request_reviews": true
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "actions",
|
||||
"subcategory": "permissions"
|
||||
}
|
||||
},
|
||||
"put": {
|
||||
"summary": "Set default workflow permissions for an enterprise",
|
||||
"description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\nGitHub Apps must have the `enterprise_administration:write` permission to use this endpoint.",
|
||||
"tags": [
|
||||
"actions"
|
||||
],
|
||||
"operationId": "actions/set-github-actions-default-workflow-permissions-enterprise",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/actions#set-default-workflow-permissions-for-an-enterprise"
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "enterprise",
|
||||
"description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"default_workflow_permissions": {
|
||||
"type": "string",
|
||||
"description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.",
|
||||
"enum": [
|
||||
"read",
|
||||
"write"
|
||||
]
|
||||
},
|
||||
"can_approve_pull_request_reviews": {
|
||||
"type": "boolean",
|
||||
"description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk."
|
||||
}
|
||||
}
|
||||
},
|
||||
"examples": {
|
||||
"default": {
|
||||
"summary": "Give read-only permission, and allow approving PRs.",
|
||||
"value": {
|
||||
"default_workflow_permissions": "read",
|
||||
"can_approve_pull_request_reviews": true
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"204": {
|
||||
"description": "Success response"
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "actions",
|
||||
"subcategory": "permissions"
|
||||
}
|
||||
}
|
||||
},
|
||||
"/enterprises/{enterprise}/actions/runner-groups": {
|
||||
"get": {
|
||||
"summary": "List self-hosted runner groups for an enterprise",
|
||||
@@ -67340,7 +67477,7 @@
|
||||
"/orgs/{org}/actions/permissions/workflow": {
|
||||
"get": {
|
||||
"summary": "Get default workflow permissions for an organization",
|
||||
"description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well if GitHub Actions can submit approving pull request reviews.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
|
||||
"description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
|
||||
"tags": [
|
||||
"actions"
|
||||
],
|
||||
@@ -67377,7 +67514,7 @@
|
||||
},
|
||||
"can_approve_pull_request_reviews": {
|
||||
"type": "boolean",
|
||||
"description": "Whether GitHub Actions can submit approving pull request reviews."
|
||||
"description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
@@ -67387,6 +67524,7 @@
|
||||
},
|
||||
"examples": {
|
||||
"default": {
|
||||
"summary": "Give read-only permission, and allow approving PRs.",
|
||||
"value": {
|
||||
"default_workflow_permissions": "read",
|
||||
"can_approve_pull_request_reviews": true
|
||||
@@ -67406,7 +67544,7 @@
|
||||
},
|
||||
"put": {
|
||||
"summary": "Set default workflow permissions for an organization",
|
||||
"description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
|
||||
"description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
|
||||
"tags": [
|
||||
"actions"
|
||||
],
|
||||
@@ -67427,7 +67565,10 @@
|
||||
],
|
||||
"responses": {
|
||||
"204": {
|
||||
"description": "Response"
|
||||
"description": "Success response"
|
||||
},
|
||||
"409": {
|
||||
"description": "Conflict response when changing a setting is prevented by the owning enterprise"
|
||||
}
|
||||
},
|
||||
"requestBody": {
|
||||
@@ -67447,12 +67588,13 @@
|
||||
},
|
||||
"can_approve_pull_request_reviews": {
|
||||
"type": "boolean",
|
||||
"description": "Whether GitHub Actions can submit approving pull request reviews."
|
||||
"description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk."
|
||||
}
|
||||
}
|
||||
},
|
||||
"examples": {
|
||||
"default": {
|
||||
"summary": "Give read-only permission, and allow approving PRs.",
|
||||
"value": {
|
||||
"default_workflow_permissions": "read",
|
||||
"can_approve_pull_request_reviews": true
|
||||
@@ -79284,6 +79426,29 @@
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "tool_name",
|
||||
"description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"description": "The name of the tool used to generate the code scanning analysis."
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "tool_guid",
|
||||
"description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
],
|
||||
"description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data."
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "before",
|
||||
"description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor.",
|
||||
@@ -79336,7 +79501,7 @@
|
||||
},
|
||||
{
|
||||
"name": "state",
|
||||
"description": "Set to `open`, `closed, `fixed`, or `dismissed` to list code scanning alerts in a specific state.",
|
||||
"description": "Set to `open`, `closed`, `fixed`, or `dismissed` to list code scanning alerts in a specific state.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"schema": {
|
||||
@@ -161528,6 +161693,160 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/repos/{owner}/{repo}/actions/permissions/workflow": {
|
||||
"get": {
|
||||
"summary": "Get default workflow permissions for a repository",
|
||||
"description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API.",
|
||||
"tags": [
|
||||
"actions"
|
||||
],
|
||||
"operationId": "actions/get-github-actions-default-workflow-permissions-repository",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/actions#get-default-workflow-permissions-for-a-repository"
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"default_workflow_permissions": {
|
||||
"type": "string",
|
||||
"description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.",
|
||||
"enum": [
|
||||
"read",
|
||||
"write"
|
||||
]
|
||||
},
|
||||
"can_approve_pull_request_reviews": {
|
||||
"type": "boolean",
|
||||
"description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"default_workflow_permissions",
|
||||
"can_approve_pull_request_reviews"
|
||||
]
|
||||
},
|
||||
"examples": {
|
||||
"default": {
|
||||
"summary": "Give read-only permission, and allow approving PRs.",
|
||||
"value": {
|
||||
"default_workflow_permissions": "read",
|
||||
"can_approve_pull_request_reviews": true
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "actions",
|
||||
"subcategory": "permissions"
|
||||
}
|
||||
},
|
||||
"put": {
|
||||
"summary": "Set default workflow permissions for a repository",
|
||||
"description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API.",
|
||||
"tags": [
|
||||
"actions"
|
||||
],
|
||||
"operationId": "actions/set-github-actions-default-workflow-permissions-repository",
|
||||
"externalDocs": {
|
||||
"description": "API method documentation",
|
||||
"url": "https://docs.github.com/rest/reference/actions#set-default-workflow-permissions-for-a-repository"
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"204": {
|
||||
"description": "Success response"
|
||||
},
|
||||
"409": {
|
||||
"description": "Conflict response when changing a setting is prevented by the owning organization or enterprise"
|
||||
}
|
||||
},
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"default_workflow_permissions": {
|
||||
"type": "string",
|
||||
"description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.",
|
||||
"enum": [
|
||||
"read",
|
||||
"write"
|
||||
]
|
||||
},
|
||||
"can_approve_pull_request_reviews": {
|
||||
"type": "boolean",
|
||||
"description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk."
|
||||
}
|
||||
}
|
||||
},
|
||||
"examples": {
|
||||
"default": {
|
||||
"summary": "Give read-only permission, and allow approving PRs.",
|
||||
"value": {
|
||||
"default_workflow_permissions": "read",
|
||||
"can_approve_pull_request_reviews": true
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"x-github": {
|
||||
"githubCloudOnly": false,
|
||||
"enabledForGitHubApps": true,
|
||||
"category": "actions",
|
||||
"subcategory": "permissions"
|
||||
}
|
||||
}
|
||||
},
|
||||
"/repos/{owner}/{repo}/actions/runners": {
|
||||
"get": {
|
||||
"summary": "List self-hosted runners for a repository",
|
||||
@@ -243237,7 +243556,7 @@
|
||||
},
|
||||
"put": {
|
||||
"summary": "Add a repository collaborator",
|
||||
"description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations).\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.",
|
||||
"description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations).\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
@@ -275735,7 +276054,7 @@
|
||||
"properties": {
|
||||
"event_type": {
|
||||
"type": "string",
|
||||
"description": "A custom webhook event name.",
|
||||
"description": "A custom webhook event name. Must be 100 characters or fewer.",
|
||||
"minLength": 1,
|
||||
"maxLength": 100
|
||||
},
|
||||
|
||||
@@ -189362,7 +189362,7 @@
|
||||
},
|
||||
"put": {
|
||||
"summary": "Add a repository collaborator",
|
||||
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.1/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.1/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.1/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.1/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.1/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@3.1/rest/reference/repos#invitations).\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.",
|
||||
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.1/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.1/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.1/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.1/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.1/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@3.1/rest/reference/repos#invitations).\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
@@ -221063,7 +221063,7 @@
|
||||
"properties": {
|
||||
"event_type": {
|
||||
"type": "string",
|
||||
"description": "A custom webhook event name.",
|
||||
"description": "A custom webhook event name. Must be 100 characters or fewer.",
|
||||
"minLength": 1,
|
||||
"maxLength": 100
|
||||
},
|
||||
|
||||
@@ -193773,7 +193773,7 @@
|
||||
},
|
||||
"put": {
|
||||
"summary": "Add a repository collaborator",
|
||||
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.2/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.2/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#invitations).\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.",
|
||||
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.2/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.2/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#invitations).\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
@@ -225549,7 +225549,7 @@
|
||||
"properties": {
|
||||
"event_type": {
|
||||
"type": "string",
|
||||
"description": "A custom webhook event name.",
|
||||
"description": "A custom webhook event name. Must be 100 characters or fewer.",
|
||||
"minLength": 1,
|
||||
"maxLength": 100
|
||||
},
|
||||
|
||||
@@ -197327,7 +197327,7 @@
|
||||
},
|
||||
"put": {
|
||||
"summary": "Add a repository collaborator",
|
||||
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.3/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.3/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#invitations).\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.",
|
||||
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.3/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.3/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#invitations).\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
@@ -228984,7 +228984,7 @@
|
||||
"properties": {
|
||||
"event_type": {
|
||||
"type": "string",
|
||||
"description": "A custom webhook event name.",
|
||||
"description": "A custom webhook event name. Must be 100 characters or fewer.",
|
||||
"minLength": 1,
|
||||
"maxLength": 100
|
||||
},
|
||||
|
||||
@@ -213145,7 +213145,7 @@
|
||||
},
|
||||
"put": {
|
||||
"summary": "Add a repository collaborator",
|
||||
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.4/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.4/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@3.4/rest/reference/repos#invitations).\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.",
|
||||
"description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.4/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.4/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@3.4/rest/reference/repos#invitations).\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
@@ -244921,7 +244921,7 @@
|
||||
"properties": {
|
||||
"event_type": {
|
||||
"type": "string",
|
||||
"description": "A custom webhook event name.",
|
||||
"description": "A custom webhook event name. Must be 100 characters or fewer.",
|
||||
"minLength": 1,
|
||||
"maxLength": 100
|
||||
},
|
||||
|
||||
@@ -177935,7 +177935,7 @@
|
||||
},
|
||||
"put": {
|
||||
"summary": "Add a repository collaborator",
|
||||
"description": "This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/github-ae@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/github-ae@latest/rest/reference/repos#invitations).\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.",
|
||||
"description": "This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/github-ae@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/github-ae@latest/rest/reference/repos#invitations).\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.",
|
||||
"tags": [
|
||||
"repos"
|
||||
],
|
||||
@@ -209336,7 +209336,7 @@
|
||||
"properties": {
|
||||
"event_type": {
|
||||
"type": "string",
|
||||
"description": "A custom webhook event name.",
|
||||
"description": "A custom webhook event name. Must be 100 characters or fewer.",
|
||||
"minLength": 1,
|
||||
"maxLength": 100
|
||||
},
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:77da1e149b3a161bcd81dc839a44991e1cfa4e98825af4d278f25bbe8decb1b0
|
||||
size 675591
|
||||
oid sha256:af5fee93295b8e33a57098e109ef133eb9114783ab459fec21129c34573f43a5
|
||||
size 675144
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:7d702045a9f6c5508b13d43529ebb1ab1b124a3624eb2fc602d44574e82f2d93
|
||||
size 1359137
|
||||
oid sha256:c1cb94b844a4d8e608debf2b53084dc90f43aa90c5ebd140ec3e5f810e26b2bf
|
||||
size 1360680
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:178f757313ee283cb0dcd1a89fc2902e9504d0ee7a9b458b35c6a4dca869afe0
|
||||
size 906104
|
||||
oid sha256:4c8922f12a7afcd9b94fe1520901d30f8fc54d2565a7b9633ac60e6169d70278
|
||||
size 907341
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:3c086ffa54ef4b00c68118ae2a8bc5fe393725bc1449c401afa6aba4abb79733
|
||||
size 3486504
|
||||
oid sha256:5f2ff0b842b06c445b4e4ef52744ef6ab099739257761da448f6245df74e715a
|
||||
size 3492542
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:59dc109089f5fc9ceda920d361aa84adcfeb61fd2a542daa17bad742f504c6db
|
||||
size 624553
|
||||
oid sha256:74795fa8e4ad78ab3d0c25a6a946e9dcd4cffc82f33331ddb4f0b5c7f8b447a6
|
||||
size 624135
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:964113d667cb1eb74114663a3878b98807c2c35a2eae6a8a7e2411dc2e1d09a7
|
||||
size 2628190
|
||||
oid sha256:a3127726f71945033b984ed611a184160a26cfe99af0fb6e0186e744768544c1
|
||||
size 2628330
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:bb4848cbaa43074173fbceee45dc706493e5f733c72f46724b68d24999291d67
|
||||
size 686806
|
||||
oid sha256:d9bbaa6498c6a24686f6ab6e6f5aadca31f3e31c80c5f53d307a8f19a761fb6b
|
||||
size 686495
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:aaad6ec8e4b1fc53ecd038aa1608a5a8c798bab2e549679ad2b88f88c5c6efd2
|
||||
size 3663849
|
||||
oid sha256:11724312b85ff55bd877fa359e899bbd140e080d09e40c2edbb83cf722120726
|
||||
size 3662712
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:dd8714dd6fdd5f8df01ad0e49a93f7d81486372480acdf1d65e5c3c570c1e0fa
|
||||
size 615909
|
||||
oid sha256:14971e778df98d958d04d5dd566594bddf667687be15788e0931e0c38aca0c05
|
||||
size 615550
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:4de74ef8df7210e6f19b675819ed88c514443339f6628293062b40ec91074cfb
|
||||
size 2531357
|
||||
oid sha256:0d315f34003d214c2386b495d4bbd2b89929ca68fdc23409ddb183fd63fae3ab
|
||||
size 2526434
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:deb10bf90614073265455c76b90130374835f4301b6d18e85287f43175341b07
|
||||
size 693388
|
||||
oid sha256:cae6104f81fa93569cdee6f7bcc469cc989527759aaeac02244eeb4cc234bd60
|
||||
size 692488
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:917315ceafe5ad47033002f4f3611f976c3f348754d663a9f0a4cac890b5adc5
|
||||
size 1389121
|
||||
oid sha256:529043d2621b7e66236d79a8e182f0c33e076605269f3cfc5d94fd6379424940
|
||||
size 1389038
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:30f2c85cc1089473d8356d35a1529423de780301a2d20f77881b48be2fcc6ce3
|
||||
size 936590
|
||||
oid sha256:1634846660e63ec82e465d0aa0f87af0edbec93eb9d95f08b81b6b8910200f97
|
||||
size 938700
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:6b8ddb7e487ba027547253c1db1734d75189a7f5f30c1df9263afe6dc3758307
|
||||
size 3607284
|
||||
oid sha256:5ddb4400383e468899c9defa3e48bfe8c7bd27bd93a663d3eba077d63d4973f7
|
||||
size 3611572
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:c7696bf975b1da5212944ac7033a95665347b0c50953b1a3e05c130178a8f84f
|
||||
size 640634
|
||||
oid sha256:0b025628f93a2f5283844f59ea5d7e332718febe95260018668c4245b1869e74
|
||||
size 641200
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:ce7200bce955dcaade2d8c6001c72540dab5fd3dcee5e31a51e57ef1addf1561
|
||||
size 2697987
|
||||
oid sha256:442b0de96637c5386dac25eeabd42e5d381ad70d1826a627aeab9ef06b4041c4
|
||||
size 2700409
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:333fabf2ea6e78e526e98ab757ef3d3fe508603c26627d8fc624511a3c1446ea
|
||||
size 703519
|
||||
oid sha256:1b50edb54eef52dd06b5db649576cb61a76cd89249e5552b5d48a30a5b274821
|
||||
size 704005
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:dbbe614fbd74014cc77eb1710f96afdd34b980e828366bec91eede5a938a2ae4
|
||||
size 3760914
|
||||
oid sha256:008d6a7a7cadc0d87d4d4ad81ff36b63be687ca76ed02ce3704776f981f7f0d9
|
||||
size 3759448
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:a6c853f1b96f0a548fc527f7e56707e274d904bebd38930d1cd0f8d6a1c63be6
|
||||
size 631424
|
||||
oid sha256:7ee590d0d96da975d51c48e82e58764b8c3d4f632a8b0baf362f3e6a90842c9f
|
||||
size 632178
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:2f98093618a86e30f1d713d034f1a6af0d211119dc78d482c9e4e7ca7f48b5ac
|
||||
size 2592331
|
||||
oid sha256:f09082808110ec21a9e978d3b084eb2fba1a72c1d3f6cf68cc29a32e540a19fc
|
||||
size 2589776
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:1b0999c754fe0ce322712768f2db8f614dee442f1549fb38df88ceed00b877ec
|
||||
size 716362
|
||||
oid sha256:ce4079aa0bc6eaa17d7a64ae6463afbe08f1c1124bdfbb64b98c07249a1be89d
|
||||
size 716501
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:f1f7fff0dfd993c13df21de0c06b95312c9e2fd77c82064dca7cc082d785dd2a
|
||||
size 1438965
|
||||
oid sha256:cbc08561ab479d1031c58e626c156661cdb6fce520dceefc1c671ad7248aa728
|
||||
size 1437916
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:c3bb2725022e53857d70fcbd242cd54fe46ae7a420828583904da8886c8c6528
|
||||
size 971121
|
||||
oid sha256:199eb24c8fd4b9c7262672c9e623b2e6d20a6b3dccec6cc66a3e8c3b4b14d3d0
|
||||
size 972163
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:09dc34f88176fff7b340631cc1441ae62f626bb63b26f5a049ad84583c375c6e
|
||||
size 3725251
|
||||
oid sha256:0286535f2d052417d2bf09010fa4eef0c9eb602b1707ba5e54bfa10129f2168f
|
||||
size 3729917
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:9e7f596b8ffbaa9b0000181082b2e803a447402593cd1b4f7f4cb675436d0c9c
|
||||
size 659478
|
||||
oid sha256:4b944c0e19a317485c14bcf11e42c893cf9736ac3a3879925722f33c4971e99f
|
||||
size 660360
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:74af5cb44f818c38014aa79cdb1eddc0be562170b494757de8ef6872508f5aaf
|
||||
size 2787410
|
||||
oid sha256:ae012aa3f5e867b0611ca90993dd30a1afc68b4357e30eec1e8d4f9d056432c1
|
||||
size 2787399
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user