diff --git a/.github/workflows/copy-api-issue-to-internal.yml b/.github/workflows/copy-api-issue-to-internal.yml index 13bac002f1c0..d14236eea9ea 100644 --- a/.github/workflows/copy-api-issue-to-internal.yml +++ b/.github/workflows/copy-api-issue-to-internal.yml @@ -52,13 +52,6 @@ jobs: ISSUE_TITLE: ${{ github.event.issue.title }} ISSUE_BODY: ${{ github.event.issue.body }} - - name: Comment on the new issue - run: gh issue comment $NEW_ISSUE --body "This issue was originally opened in the open source repo as $OLD_ISSUE" - env: - GITHUB_TOKEN: ${{secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES}} - NEW_ISSUE: ${{ env.NEW_ISSUE }} - OLD_ISSUE: ${{ github.event.issue.html_url }} - - name: Comment on the old issue run: gh issue comment $OLD_ISSUE --body "Thank you for opening this issue! Updates to the REST/GraphQL API description must be made internally. I have copied your issue to an internal issue, so I will close this issue." env: @@ -70,3 +63,10 @@ jobs: env: GITHUB_TOKEN: ${{secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES}} OLD_ISSUE: ${{ github.event.issue.html_url }} + + - name: Comment on the new issue + run: gh issue comment $NEW_ISSUE --body "This issue was originally opened in the open source repo as $OLD_ISSUE" + env: + GITHUB_TOKEN: ${{secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES}} + NEW_ISSUE: ${{ env.NEW_ISSUE }} + OLD_ISSUE: ${{ github.event.issue.html_url }} diff --git a/.github/workflows/link-check-all.yml b/.github/workflows/link-check-all.yml index db3848d5883f..d98360469966 100644 --- a/.github/workflows/link-check-all.yml +++ b/.github/workflows/link-check-all.yml @@ -53,6 +53,14 @@ jobs: # Don't care about CDN caching image URLs DISABLE_REWRITE_ASSET_URLS: true run: | + + # Note as of Aug 2022, we *don't* check external links + # on the pages you touched in the PR. We could enable that + # but it has the added risk of false positives blocking CI. + # We are using this script for the daily/nightly checker that + # checks external links too. Once we're confident it really works + # well, we can consider enabling it here on every content PR too. + ./script/rendered-content-link-checker.js \ --language en \ --max 100 \ diff --git a/.github/workflows/site-policy-reminder.yml b/.github/workflows/site-policy-reminder.yml index 4491321bcc19..e1484c1b8dba 100644 --- a/.github/workflows/site-policy-reminder.yml +++ b/.github/workflows/site-policy-reminder.yml @@ -9,6 +9,7 @@ on: types: [labeled] permissions: + pull-requests: write contents: none jobs: diff --git a/.gitignore b/.gitignore index 7a5746c1df79..30492bcbc590 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,7 @@ .DS_Store .env .vscode/settings.json +.idea/ /node_modules/ npm-debug.log coverage/ diff --git a/assets/images/help/classroom/classroom-settings-click-google-classroom.png b/assets/images/help/classroom/classroom-settings-click-google-classroom.png new file mode 100644 index 000000000000..f43d23817cbd Binary files /dev/null and b/assets/images/help/classroom/classroom-settings-click-google-classroom.png differ diff --git a/assets/images/help/codespaces/jupyter-notebook-step3.png b/assets/images/help/codespaces/jupyter-notebook-step3.png new file mode 100644 index 000000000000..2b7208bf5b93 Binary files /dev/null and b/assets/images/help/codespaces/jupyter-notebook-step3.png differ diff --git a/assets/images/help/codespaces/jupyter-python-kernel-dropdown.png b/assets/images/help/codespaces/jupyter-python-kernel-dropdown.png new file mode 100644 index 000000000000..64a573c63fec Binary files /dev/null and b/assets/images/help/codespaces/jupyter-python-kernel-dropdown.png differ diff --git a/assets/images/help/codespaces/jupyter-python-kernel-link.png b/assets/images/help/codespaces/jupyter-python-kernel-link.png new file mode 100644 index 000000000000..6809b4498c04 Binary files /dev/null and b/assets/images/help/codespaces/jupyter-python-kernel-link.png differ diff --git a/assets/images/help/codespaces/jupyter-run-all.png b/assets/images/help/codespaces/jupyter-run-all.png new file mode 100644 index 000000000000..429aaa124530 Binary files /dev/null and b/assets/images/help/codespaces/jupyter-run-all.png differ diff --git a/assets/images/help/codespaces/open-codespace-in-jupyter.png b/assets/images/help/codespaces/open-codespace-in-jupyter.png new file mode 100644 index 000000000000..f404c6f61505 Binary files /dev/null and b/assets/images/help/codespaces/open-codespace-in-jupyter.png differ diff --git a/assets/images/help/enterprises/audit-stream-choice-datadog.png b/assets/images/help/enterprises/audit-stream-choice-datadog.png new file mode 100644 index 000000000000..0d81cd0bc5cb Binary files /dev/null and b/assets/images/help/enterprises/audit-stream-choice-datadog.png differ diff --git a/assets/images/help/enterprises/audit-stream-datadog-site.png b/assets/images/help/enterprises/audit-stream-datadog-site.png new file mode 100644 index 000000000000..05826e3230de Binary files /dev/null and b/assets/images/help/enterprises/audit-stream-datadog-site.png differ diff --git a/assets/images/help/enterprises/audit-stream-datadog-token.png b/assets/images/help/enterprises/audit-stream-datadog-token.png new file mode 100644 index 000000000000..68af0881e809 Binary files /dev/null and b/assets/images/help/enterprises/audit-stream-datadog-token.png differ diff --git a/assets/images/help/settings/cookie-settings-accept-or-reject.png b/assets/images/help/settings/cookie-settings-accept-or-reject.png new file mode 100644 index 000000000000..3c220255fd7c Binary files /dev/null and b/assets/images/help/settings/cookie-settings-accept-or-reject.png differ diff --git a/assets/images/help/settings/cookie-settings-manage.png b/assets/images/help/settings/cookie-settings-manage.png new file mode 100644 index 000000000000..c95b55080a30 Binary files /dev/null and b/assets/images/help/settings/cookie-settings-manage.png differ diff --git a/assets/images/help/settings/cookie-settings-save.png b/assets/images/help/settings/cookie-settings-save.png new file mode 100644 index 000000000000..7a85412d784b Binary files /dev/null and b/assets/images/help/settings/cookie-settings-save.png differ diff --git a/assets/images/hosted-runner-mgmt.png b/assets/images/hosted-runner-mgmt.png new file mode 100644 index 000000000000..9b62a8c94410 Binary files /dev/null and b/assets/images/hosted-runner-mgmt.png differ diff --git a/assets/images/hosted-runner.png b/assets/images/hosted-runner.png new file mode 100644 index 000000000000..fa052d51eecc Binary files /dev/null and b/assets/images/hosted-runner.png differ diff --git a/components/lib/get-rest-code-samples.ts b/components/lib/get-rest-code-samples.ts index 982c6945cb82..27c6a7f4ec44 100644 --- a/components/lib/get-rest-code-samples.ts +++ b/components/lib/get-rest-code-samples.ts @@ -45,7 +45,7 @@ export function getShellExample(operation: Operation, codeSample: CodeSample) { const args = [ operation.verb !== 'get' && `-X ${operation.verb.toUpperCase()}`, - `-H "Accept: ${defaultAcceptHeader}" \\ \n -H "Authorization: token "`, + `-H "Accept: ${defaultAcceptHeader}" \\ \n -H "Authorization: Bearer "`, `${operation.serverUrl}${requestPath}`, requestBodyParams, ].filter(Boolean) @@ -86,12 +86,12 @@ export function getGHExample(operation: Operation, codeSample: CodeSample) { requestBodyParams = Object.keys(codeSample.request.bodyParameters) .map((key) => { if (typeof codeSample.request.bodyParameters[key] === 'string') { - return `-f ${key}='${codeSample.request.bodyParameters[key]}'\n` + return `-f ${key}='${codeSample.request.bodyParameters[key]}' ` } else { - return `-F ${key}=${codeSample.request.bodyParameters[key]}\n` + return `-F ${key}=${codeSample.request.bodyParameters[key]} ` } }) - .join(' ') + .join('\\\n ') } const args = [ operation.verb !== 'get' && `--method ${operation.verb.toUpperCase()}`, @@ -141,11 +141,7 @@ export function getJSExample(operation: Operation, codeSample: CodeSample) { } } const comment = `// Octokit.js\n// https://github.com/octokit/core.js#readme\n` - const require = `const octokit = new Octokit(${stringify( - { auth: 'personal-access-token123' }, - null, - 2 - )})\n\n` + const require = `const octokit = new Octokit(${stringify({ auth: 'YOUR-TOKEN' }, null, 2)})\n\n` return `${comment}${require}await octokit.request('${operation.verb.toUpperCase()} ${ operation.requestPath diff --git a/components/playground/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces/dotnet.tsx b/components/playground/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces/dotnet.tsx index 010d218b1dd1..d04647983ec9 100644 --- a/components/playground/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces/dotnet.tsx +++ b/components/playground/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces/dotnet.tsx @@ -53,18 +53,26 @@ const article: PlaygroundArticleT = { To set up your repository to use a custom dev container, you will need to create one or more \`devcontainer.json\` files. You can add these either from a template, in Visual Studio Code, or you can write your own. For more information on dev container configurations, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". - 1. Access the Command Palette (Shift + Command + P / Ctrl + Shift + P), then start typing "dev container". Select **Codespaces: Add Development Container Configuration Files...**. - ![Codespaces: Add Development Container Configuration Files... in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) + 1. Access the Command Palette (Shift+Command+P / Ctrl+Shift+P), then start typing "dev container". Select **Codespaces: Add Development Container Configuration Files...**. + + ![Codespaces: Add Development Container Configuration Files... in the Command Palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) + 2. For this example, click **C# (.NET)**. If you need additional features you can select any container that’s specific to C# (.NET) or a combination of tools such as C# (.NET) and MS SQL. - ![Select C# (.NET) option from the list](/assets/images/help/codespaces/add-dotnet-prebuilt-container.png) + ![Select C# (.NET) option from the list](/assets/images/help/codespaces/add-dotnet-prebuilt-container.png) + 3. Click the recommended version of .NET. - ![.NET version selection](/assets/images/help/codespaces/add-dotnet-version.png) + + ![.NET version selection](/assets/images/help/codespaces/add-dotnet-version.png) + 4. Accept the default option to add Node.js to your customization. - ![Add Node.js selection](/assets/images/help/codespaces/dotnet-options.png) + + ![Add Node.js selection](/assets/images/help/codespaces/dotnet-options.png) + 5. Select any additional features to install and click **OK**. - 6. Access the command palette (Shift + Command + P / Ctrl + Shift + P), then start typing "rebuild". Select **Codespaces: Rebuild Container**. - ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) + 6. Access the Command Palette (Shift+Command+P / Ctrl+Shift+P), then start typing "rebuild". Select **Codespaces: Rebuild Container**. + ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) + `, }, { @@ -197,13 +205,16 @@ const article: PlaygroundArticleT = { "postCreateCommand": "dotnet restore", \`\`\` - 4. Access the command palette (\`Shift + Command + P\`/ \`Ctrl + Shift + P\`), then start typing "rebuild". Select **Codespaces: Rebuild Container**. - ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. + 4. Access the Command Palette (Shift+Command+P / Ctrl+Shift+P), then start typing "rebuild". Select **Codespaces: Rebuild Container**. + + ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) + + Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. 5. Check your changes were successfully applied by verifying the "Code Spell Checker" extension was installed. - ![Extensions list](/assets/images/help/codespaces/dotnet-extensions.png) + ![Extensions list](/assets/images/help/codespaces/dotnet-extensions.png) + `, }, { @@ -217,9 +228,10 @@ const article: PlaygroundArticleT = { 1. Run your application by pressing \`F5\` or entering \`dotnet watch run\` in your terminal. - 2. When your project starts, you should see a message in the bottom right corner with a prompt to connect to the port your project uses. + 2. When your project starts, you should see a message in the bottom right corner with a prompt to connect to the port your project uses. + + ![Port forwarding toast](/assets/images/help/codespaces/python-port-forwarding.png) - ![Port forwarding toast](/assets/images/help/codespaces/python-port-forwarding.png) `, }, { diff --git a/components/playground/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces/java.tsx b/components/playground/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces/java.tsx index 6824f820c665..3950e5920fd9 100644 --- a/components/playground/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces/java.tsx +++ b/components/playground/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces/java.tsx @@ -51,15 +51,23 @@ const article: PlaygroundArticleT = { To set up your repository to use a custom dev container, you will need to create one or more \`devcontainer.json\` files. You can add these either from a template, in Visual Studio Code, or you can write your own. For more information on dev container configurations, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". - 1. Access the Command Palette (\`Shift + Command + P\` / \`Ctrl + Shift + P\`), then start typing "dev container". Select **Codespaces: Add Development Container Configuration Files...**. - !["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) + 1. Access the Command Palette (Shift+Command+P / Ctrl+Shift+P), then start typing "dev container". Select **Codespaces: Add Development Container Configuration Files...**. + + !["Codespaces: Add Development Container Configuration Files..." in the Command Palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) + 2. For this example, click **Java**. In practice, you could select any container that’s specific to Java or a combination of tools such as Java and Azure Functions. - ![Select Java option from the list](/assets/images/help/codespaces/add-java-prebuilt-container.png) + + ![Select Java option from the list](/assets/images/help/codespaces/add-java-prebuilt-container.png) + 3. Click the recommended version of Java. - ![Java version selection](/assets/images/help/codespaces/add-java-version.png) + + ![Java version selection](/assets/images/help/codespaces/add-java-version.png) + 4. Select any additional features to install and click **OK**. - 5. Access the command palette (\`Shift + Command + P\`/ \`Ctrl + Shift + P\`), then start typing "rebuild". Select **Codespaces: Rebuild Container**. - ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) + 5. Access the Command Palette (Shift+Command+P / Ctrl+Shift+P), then start typing "rebuild". Select **Codespaces: Rebuild Container**. + + ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) + `, }, { @@ -185,9 +193,11 @@ const article: PlaygroundArticleT = { For more information about \`devcontainer.json\` properties, see the Visual Studio Code documentation: "[devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference)." - 4. Access the command palette (\`Shift + Command + P\`/ \`Ctrl + Shift + P\`), then start typing "rebuild". Select **Codespaces: Rebuild Container**. - ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. + 4. Access the Command Palette (Shift+Command+P / Ctrl+Shift+P), then start typing "rebuild". Select **Codespaces: Rebuild Container**. + + ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) + + Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. `, }, { diff --git a/components/playground/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces/nodejs.tsx b/components/playground/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces/nodejs.tsx index 6667f11234da..eebba23d1f4e 100644 --- a/components/playground/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces/nodejs.tsx +++ b/components/playground/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces/nodejs.tsx @@ -29,7 +29,7 @@ const article: PlaygroundArticleT = { content: dedent` 1. Under the repository name, use the **Code** drop-down menu, and in the **Codespaces** tab, click **Create codespace on BRANCH**. - ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) + ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) If you don’t see this option, GitHub Codespaces isn't available for your project. See [Access to GitHub Codespaces](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information. @@ -51,15 +51,23 @@ const article: PlaygroundArticleT = { To set up your repository to use a custom dev container, you will need to create one or more \`devcontainer.json\` files. You can add these either from a template, in Visual Studio Code, or you can write your own. For more information on dev container configurations, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". - 1. Access the Command Palette (\`Shift + Command + P\` / \`Ctrl + Shift + P\`), then start typing "dev container". Select **Codespaces: Add Development Container Configuration Files...**. - !["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) + 1. Access the Command Palette (Shift+Command+P / Ctrl+Shift+P), then start typing "dev container". Select **Codespaces: Add Development Container Configuration Files...**. + + !["Codespaces: Add Development Container Configuration Files..." in the Command Palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) + 2. For this example, click **Node.js**. If you need additional features you can select any container that’s specific to Node or a combination of tools such as Node and MongoDB. - ![Select Node option from the list](/assets/images/help/codespaces/add-node-prebuilt-container.png) + + ![Select Node option from the list](/assets/images/help/codespaces/add-node-prebuilt-container.png) + 3. Click the recommended version of Node.js. - ![Node.js version selection](/assets/images/help/codespaces/add-node-version.png) + + ![Node.js version selection](/assets/images/help/codespaces/add-node-version.png) + 4. Select any additional features to install and click **OK**. - 5. Access the command palette (\`Shift + Command + P\`/ \`Ctrl + Shift + P\`), then start typing "rebuild". Select **Codespaces: Rebuild Container**. - ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) + 5. Access the Command Palette (Shift+Command+P / Ctrl+Shift+P), then start typing "rebuild". Select **Codespaces: Rebuild Container**. + + ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) + `, }, { @@ -173,7 +181,9 @@ const article: PlaygroundArticleT = { With your dev container configuration added and a basic understanding of what everything does, you can now make changes to customize your environment further. In this example, you'll add properties to install npm when your codespace launches and make a list of ports inside the container available locally. 1. In the Explorer, select the \`devcontainer.json\` file from the tree to open it. You might have to expand the \`.devcontainer\` folder to see it. - ![devcontainer.json file in the Explorer](/assets/images/help/codespaces/devcontainers-options.png) + + ![devcontainer.json file in the Explorer](/assets/images/help/codespaces/devcontainers-options.png) + 2. Add the following lines to your \`devcontainer.json\` file after \`extensions\`: \`\`\`js{:copy} @@ -182,10 +192,11 @@ const article: PlaygroundArticleT = { \`\`\` For more information about \`devcontainer.json\` properties, see the Visual Studio Code documentation: "[devcontainer.json reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference)." - 1. Access the command palette (\`Shift + Command + P\`/ \`Ctrl + Shift + P\`), then start typing "rebuild". Select **Codespaces: Rebuild Container**. - ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) + 3. Access the Command Palette (Shift+Command+P / Ctrl+Shift+P), then start typing "rebuild". Select **Codespaces: Rebuild Container**. + + ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. + Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. `, }, { diff --git a/components/playground/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces/python.tsx b/components/playground/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces/python.tsx index 7bba6a54a8b4..87425b849b27 100644 --- a/components/playground/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces/python.tsx +++ b/components/playground/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces/python.tsx @@ -29,9 +29,9 @@ const article: PlaygroundArticleT = { content: dedent` 1. Under the repository name, use the **Code** drop-down menu, and in the **Codespaces** tab, click **Create codespace on BRANCH**. - ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) + ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) - If you don’t see this option, GitHub Codespaces isn't available for your project. See [Access to GitHub Codespaces](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information. + If you don’t see this option, GitHub Codespaces isn't available for your project. See [Access to GitHub Codespaces](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information. When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Python, pip, and Miniconda. It also includes a common set of tools like git, wget, rsync, openssh, and nano. @@ -53,17 +53,27 @@ const article: PlaygroundArticleT = { To set up your repository to use a custom dev container, you will need to create one or more \`devcontainer.json\` files. You can add these either from a template, in Visual Studio Code, or you can write your own. For more information on dev container configurations, see "[Introduction to dev containers](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". - 1. Access the command palette (\`Shift + Command + P\` / \`Ctrl + Shift + P\`), then start typing "dev container". Select **Codespaces: Add Development Container Configuration Files...**. - !["Codespaces: Add Development Container Configuration Files..." in the command palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) + 1. Access the Command Palette (Shift+Command+P / Ctrl+Shift+P), then start typing "dev container". Select **Codespaces: Add Development Container Configuration Files...**. + + !["Codespaces: Add Development Container Configuration Files..." in the Command Palette](/assets/images/help/codespaces/add-prebuilt-container-command.png) + 2. For this example, click **Python 3**. If you need additional features you can select any container that’s specific to Python or a combination of tools such as Python 3 and PostgreSQL. - ![Select Python option from the list](/assets/images/help/codespaces/add-python-prebuilt-container.png) + + ![Select Python option from the list](/assets/images/help/codespaces/add-python-prebuilt-container.png) + 3. Click the recommended version of Python. - ![Python version selection](/assets/images/help/codespaces/add-python-version.png) + + ![Python version selection](/assets/images/help/codespaces/add-python-version.png) + 4. Accept the default option to add Node.js to your customization. - ![Add Node.js selection](/assets/images/help/codespaces/add-nodejs-selection.png) + + ![Add Node.js selection](/assets/images/help/codespaces/add-nodejs-selection.png) + 5. Select any additional features to install and click **OK**. - 6. Access the command palette (\`Shift + Command + P\` / \`Ctrl + Shift + P\`), then start typing "rebuild". Select **Codespaces: Rebuild Container**. - ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) + 6. Access the Command Palette (Shift+Command+P / Ctrl+Shift+P), then start typing "rebuild". Select **Codespaces: Rebuild Container**. + + ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) + `, }, { @@ -197,7 +207,7 @@ const article: PlaygroundArticleT = { "postCreateCommand": "pip3 install --user -r requirements.txt", \`\`\` - 4. Access the command palette (\`Shift + Command + P\` / \`Ctrl + Shift + P\`), then start typing "rebuild". Select **Codespaces: Rebuild Container**. + 4. Access the Command Palette (Shift+Command+P / Ctrl+Shift+P), then start typing "rebuild". Select **Codespaces: Rebuild Container**. ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) diff --git a/components/rest/RestOperation.module.scss b/components/rest/RestOperation.module.scss index 37efa6b34aff..8d582d3a4715 100644 --- a/components/rest/RestOperation.module.scss +++ b/components/rest/RestOperation.module.scss @@ -13,6 +13,6 @@ table-layout: fixed !important; } -.codeBlock code { +.codeBlock code:not(td *) { word-break: break-all; } diff --git a/components/ui/MiniTocs/MiniTocs.tsx b/components/ui/MiniTocs/MiniTocs.tsx index 621e82fd84bd..c1301d20a020 100644 --- a/components/ui/MiniTocs/MiniTocs.tsx +++ b/components/ui/MiniTocs/MiniTocs.tsx @@ -1,4 +1,3 @@ -import React from 'react' import { Heading, NavList } from '@primer/react' import cx from 'classnames' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md index 2f1b6925f778..7a6d7d63205c 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md @@ -25,6 +25,7 @@ children: - /managing-the-default-branch-name-for-your-repositories - /managing-security-and-analysis-settings-for-your-personal-account - /managing-access-to-your-personal-accounts-project-boards + - /managing-your-cookie-preferences-for-githubs-enterprise-marketing-pages - /integrating-jira-with-your-personal-projects - /what-does-the-available-for-hire-checkbox-do shortTitle: Personal account settings diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-cookie-preferences-for-githubs-enterprise-marketing-pages.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-cookie-preferences-for-githubs-enterprise-marketing-pages.md new file mode 100644 index 000000000000..9f7621f05677 --- /dev/null +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-cookie-preferences-for-githubs-enterprise-marketing-pages.md @@ -0,0 +1,33 @@ +--- +title: Managing your cookie preferences for GitHub's enterprise marketing pages +intro: "You can control how {% data variables.product.company_short %} uses information from non-essential tracking cookies for enterprise marketing pages." +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - Accounts +shortTitle: Manage cookie preferences +--- + +## About cookie preferences on enterprise marketing pages + +{% data variables.product.company_short %} may use non-essential cookies on some enterprise marketing pages. You can customize how these cookies behave. For more information about how {% data variables.product.company_short %} uses cookies, see "[{% data variables.product.company_short %} Privacy Statement](/free-pro-team@latest/site-policy/privacy-policies/github-privacy-statement)." + +## Changing your cookie preferences + +You can customize how non-essential cookies behave on any {% data variables.product.company_short %} enterprise marketing page. + +1. Navigate to the {% data variables.product.company_short %} enterprise marketing page where you'd like to change your cookie preferences. For example, navigate to [{% data variables.product.company_short %} Resources](https://resources.github.com/). +1. Scroll to the bottom of the page, then click **Manage Cookies**. + + ![Screenshot of button to manage cookie settings.](/assets/images/help/settings/cookie-settings-manage.png) + +1. Under "Manage cookie preferences," to accept or reject each non-essential cookie, click **Accept** or **Reject**. + + ![Screenshot of radio buttons to choose "Accept" or "Reject" for non-essential cookies.](/assets/images/help/settings/cookie-settings-accept-or-reject.png) + +1. Click **Save changes**. + + ![Screenshot of button to save changes.](/assets/images/help/settings/cookie-settings-save.png) diff --git a/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md b/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md index 8103a977e8cf..f3eecc885847 100644 --- a/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md +++ b/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md @@ -145,11 +145,11 @@ With OIDC, a {% data variables.product.prodname_actions %} workflow requires a t Audience and Subject claims are typically used in combination while setting conditions on the cloud role/resources to scope its access to the GitHub workflows. - **Audience**: By default, this value uses the URL of the organization or repository owner. This can be used to set a condition that only the workflows in the specific organization can access the cloud role. -- **Subject**: Has a predefined format and is a concatenation of some of the key metadata about the workflow, such as the {% data variables.product.prodname_dotcom %} organization, repository, branch, or associated [`job`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idenvironment) environment. See "[Example subject claims](#example-subject-claims)" to see how the subject claim is assembled from concatenated metadata. +- **Subject**: By default, has a predefined format and is a concatenation of some of the key metadata about the workflow, such as the {% data variables.product.prodname_dotcom %} organization, repository, branch, or associated [`job`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idenvironment) environment. See "[Example subject claims](#example-subject-claims)" to see how the subject claim is assembled from concatenated metadata. -There are also many additional claims supported in the OIDC token that can also be used for setting these conditions. +If you need more granular trust conditions, you can customize the issuer (`iss`) and subject (`sub`) claims that are included with the JWT. For more information, see "[Customizing the token claims](#customizing-the-token-claims)". -In addition, your cloud provider could allow you to assign a role to the access tokens, letting you specify even more granular permissions. +There are also many additional claims supported in the OIDC token that can be used for setting these conditions. In addition, your cloud provider could allow you to assign a role to the access tokens, letting you specify even more granular permissions. {% note %} @@ -243,9 +243,13 @@ curl -H "Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" "$ACTIONS_ID_TOK {% ifversion actions-oidc-hardening-config %} ## Customizing the token claims -You can security harden your OIDC configuration by customizing the claims that are included with the JWT. This allows your cloud provider to apply more granular trust conditions when determining whether to grant access to its resources. For example, {% ifversion ghec %}you can customize the issuer (`iss`) claim to only allow access from a specific enterprise URL, and {% endif %}you can customize the subject (`sub`) value to require that requests originate from a specific repository, reusable workflow, or other source. +You can security harden your OIDC configuration by customizing the claims that are included with the JWT. These customisations allow you to define more granular trust conditions on your cloud roles when allowing your workflows to access resources hosted in the cloud: -To configure the claim conditions on {% data variables.product.prodname_dotcom %}, you can use the REST API endpoints described in the following sections. +{% ifversion ghec %} - For an additional layer of security, you can append the `issuer` url with your enterprise slug. This lets you set conditions on the issuer (`iss`) claim, configuring it to only accept JWT tokens from a unique `issuer` URL that must include your enterprise slug.{% endif %} +- You can standardize your OIDC configuration by setting conditions on the subject (`sub`) claim that require JWT tokens to originate from a specific repository, reusable workflow, or other source. +- You can define granular OIDC policies by using additional OIDC token claims, such as `repository_id` and `repo_visibility`. For more information, see "[Understanding the OIDC token](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#understanding-the-oidc-token)". + +To customize these claim formats, organization and repository admins can use the REST API endpoints described in the following sections. {% ifversion ghec %} @@ -280,19 +284,21 @@ After this setting is applied, the JWT will contain the updated `iss` value. In To configure organization-wide security, compliance, and standardization, you can customize the standard claims to suit your required access conditions. If your cloud provider supports conditions on subject claims, you can create a condition that checks whether the `sub` value matches the path of the reusable workflow, such as `"job_workflow_ref: "octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main""`. The exact format will vary depending on your cloud provider's OIDC configuration. To configure the matching condition on {% data variables.product.prodname_dotcom %}, you can can use the REST API to require that the `sub` claim must always include a specific custom claim, such as `job_workflow_ref`. For more information, see "[Set the customization template for an OIDC subject claim for an organization](/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization)." +Customizing the claims results in a new format for the entire `sub` claim, which replaces the default predefined `sub` format in the token described in "[Example subject claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims)." + The following example templates demonstrate various ways to customize the subject claim. To configure these settings on {% data variables.product.prodname_dotcom %}, organization admins use the REST API to specify a list of claims that must be included in the subject (`sub`) claim. {% data reusables.actions.use-request-body-api %} -To customize your subject claims, you should first create a matching condition in your cloud provider's OIDC configuration, before adding the configuration using the REST API. Once the configuration is completed, each time a new job runs, the OIDC token generated during that job will follow the new customization template. If the matching condition doesn't exist in the cloud provider's OIDC configuration before the job runs, the generated token might not be accepted by the cloud provider, since the cloud conditions may not be synchronized. +To customize your subject claims, you should first create a matching condition in your cloud provider's OIDC configuration, before customizing the configuration using the REST API. Once the configuration is completed, each time a new job runs, the OIDC token generated during that job will follow the new customization template. If the matching condition doesn't exist in the cloud provider's OIDC configuration before the job runs, the generated token might not be accepted by the cloud provider, since the cloud conditions may not be synchronized. {% note %} -**Note**: When the organization template is applied, it will not affect any existing repositories that already use OIDC. For new repositories that are created after the template has been applied, the repository owner will need to opt-in to receive this configuration. For more information, see "[Set the opt-in flag of an OIDC subject claim customization for a repository](/rest/actions/oidc#set-the-opt-in-flag-of-an-oidc-subject-claim-customization-for-a-repository)." +**Note**: When the organization template is applied, it will not affect any existing repositories that already use OIDC. For existing repositories, as well as any new repositories that are created after the template has been applied, the repository owner will need to opt-in to receive this configuration. For more information, see "[Set the opt-in flag of an OIDC subject claim customization for a repository](/rest/actions/oidc#set-the-opt-in-flag-of-an-oidc-subject-claim-customization-for-a-repository)." {% endnote %} #### Example: Allowing repository based on visibility and owner -This example template enables cloud access based on repository visibility and owner, letting you restrict cloud role access to only private repositories within an organization or enterprise. {% data reusables.actions.use-request-body-api %} +This example template allows the `sub` claim to have a new format, using `repository_owner` and `repository_visibility`: ```json { @@ -303,11 +309,11 @@ This example template enables cloud access based on repository visibility and ow } ``` -In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include specific values for `repository_owner` and `repository_visibility`. For example: `"repository_owner: "monalisa":repository_visibility:private"`. +In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include specific values for `repository_owner` and `repository_visibility`. For example: `"repository_owner: "monalisa":repository_visibility:private"`. The approach lets you restrict cloud role access to only private repositories within an organization or enterprise. #### Example: Allowing access to all repositories with a specific owner -This example template grants access to all repositories with a specified `repository_owner`. {% data reusables.actions.use-request-body-api %} +This example template enables the `sub` claim to have a new format with only the value of `repository_owner`. {% data reusables.actions.use-request-body-api %} ```json { @@ -322,7 +328,9 @@ In your cloud provider's OIDC configuration, configure the `sub` condition to re #### Example: Requiring a reusable workflow -This example template requires a specific reusable workflow in a claim, letting an enterprise enforce consistent deployments across its enterprise, organizations, and repositories. {% data reusables.actions.use-request-body-api %} +This example template allows the `sub` claim to have a new format that contains the value of the `job_workflow_ref` claim. This enables an enterprise to use [reusable workflows](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims) to enforce consistent deployments across its organizations and repositories. + +{% data reusables.actions.use-request-body-api %} ```json { @@ -336,7 +344,9 @@ In your cloud provider's OIDC configuration, configure the `sub` condition to re #### Example: Requiring a reusable workflow and other claims -This example template combines the requirement of a specific reusable workflow with additional claims. {% data reusables.actions.use-request-body-api %} +The following example template combines the requirement of a specific reusable workflow with additional claims. {% data reusables.actions.use-request-body-api %} + +This example also demonstrates how to use `"context"` to define your conditions. This is the part that follows the repository in the [default `sub` format](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims). For example, when the job references an environment, the context contains: `environment:`. ```json { @@ -350,6 +360,9 @@ This example template combines the requirement of a specific reusable workflow w In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include specific values for `repo`, `context`, and `job_workflow_ref`. +This customization template requires that the `sub` uses the following format: `repo::environment::job_workflow_ref:`. +For example: `"sub": "repo:octo-org/octo-repo:environment:prod:job_workflow_ref:octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main"` + #### Example: Granting access to a specific repository This example template lets you grant cloud access to all the workflows in a specific repository, across all branches/tags and environments. To help improve security, combine this template with the custom issuer URL described in "[Customizing the token URL for an enterprise](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-url-for-an-enterprise)." diff --git a/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md b/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md index 1fb177d06582..25ba9d8db07b 100644 --- a/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md +++ b/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md @@ -23,11 +23,18 @@ topics: Rather than copying and pasting deployment jobs from one workflow to another, you can create a reusable workflow that performs the deployment steps. A reusable workflow can be used by another workflow if it meets one of the access requirements described in "[Reusing workflows](/actions/learn-github-actions/reusing-workflows#access-to-reusable-workflows)." -When combined with OpenID Connect (OIDC), reusable workflows let you enforce consistent deployments across your repository, organization, or enterprise. You can do this by defining trust conditions on cloud roles based on reusable workflows. +You should be familiar with the concepts described in "[Reusing workflows](/actions/learn-github-actions/reusing-workflows" and "[About security hardening with OpenID Connect](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)." -In order to create trust conditions based on reusable workflows, your cloud provider must support custom claims for `job_workflow_ref`. This allows your cloud provider to identify which repository the job originally came from. If your cloud provider only supports the standard claims (_audience_ and _subject_), it will not be able to determine that the job originated from the reusable workflow repository. Cloud providers that support `job_workflow_ref` include Google Cloud Platform and HashiCorp Vault. +## Defining the trust conditions -Before proceeding, you should be familiar with the concepts of [reusable workflows](/actions/learn-github-actions/reusing-workflows) and [OpenID Connect](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect). +When combined with OpenID Connect (OIDC), reusable workflows let you enforce consistent deployments across your repository, organization, or enterprise. You can do this by defining trust conditions on cloud roles based on reusable workflows. The available options will vary depending on your cloud provider: + +- **Using `job_workflow_ref`**: + - To create trust conditions based on reusable workflows, your cloud provider must support custom claims for `job_workflow_ref`. This allows your cloud provider to identify which repository the job originally came from. + - For clouds that only support the standard claims (audience (`aud`) and subject (`sub`)), you can use the API to customize the `sub` claim to include `job_workflow_ref`. For more information, see "[Customizing the token claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-claims)". Support for custom claims is currently available for Google Cloud Platform and HashiCorp Vault. + +- **Customizing the token claims**: + - You can configure more granular trust conditions by customizing the issuer (`iss`) and subject (`sub`) claims included with the JWT. For more information, see "[Customizing the token claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-claims)". ## How the token works with reusable workflows diff --git a/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md b/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md index 33df75d7fe38..6e7678877030 100644 --- a/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md @@ -71,7 +71,7 @@ You can add self-hosted runners at the organization level, where they can be use {% data reusables.organizations.navigate-to-org %} {% data reusables.organizations.org_settings %} {% data reusables.organizations.settings-sidebar-actions-runners %} -1. Click **New runner**. +{% ifversion actions-hosted-runners %}1. Click **New runner**, then click **New self-hosted runner**.{% else %}1. Click **New runner**.{% endif %} {% data reusables.actions.self-hosted-runner-configure %} {% elsif ghae or ghes < 3.4 %} {% data reusables.organizations.navigate-to-org %} diff --git a/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md b/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md index f3f28d5e158e..f95896503ddf 100644 --- a/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md +++ b/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md @@ -18,15 +18,24 @@ shortTitle: Run runner app on startup {% capture service_first_step %}1. Stop the self-hosted runner application if it is currently running.{% endcapture %} {% capture service_non_windows_intro_shell %}On the runner machine, open a shell in the directory where you installed the self-hosted runner application. Use the commands below to install and manage the self-hosted runner service.{% endcapture %} -{% capture service_nonwindows_intro %}You must add a runner to {% data variables.product.product_name %} before you can configure the self-hosted runner application as a service. For more information, see "[Adding self-hosted runners](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)."{% endcapture %} -{% capture service_win_name %}actions.runner.*{% endcapture %} +{% capture service_nonwindows_intro %} + +{% note %} + +**Note:** You must add a runner to {% data variables.product.product_name %} before you can configure the self-hosted runner application as a service. +For more information, see "[Adding self-hosted runners](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)." + +{% endnote %} +{% endcapture %} + +{% capture service_win_name %}actions.runner.*{% endcapture %} {% linux %} {{ service_nonwindows_intro }} -For Linux systems that use `systemd`, you can use the `svc.sh` script distributed with the self-hosted runner application to install and manage using the application as a service. +For Linux systems that use `systemd`, you can use the `svc.sh` script that is created after successfully adding the runner to install and manage using the application as a service. {{ service_non_windows_intro_shell }} diff --git a/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md b/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md index 63a8e542c85b..acf5f2645137 100644 --- a/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md +++ b/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md @@ -9,216 +9,65 @@ versions: ghae: '*' ghec: '*' type: tutorial -shortTitle: Manage access to runners +shortTitle: Using runner groups --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} -## About self-hosted runner groups +## About runner groups -{% ifversion fpt %} -{% note %} - -**Note:** All organizations have a single default self-hosted runner group. Only enterprise accounts and organizations owned by enterprise accounts can create and manage additional self-hosted runner groups. - -{% endnote %} - -Self-hosted runner groups are used to control access to self-hosted runners. Organization admins can configure access policies that control which repositories in an organization have access to the runner group. - -If you use {% data variables.product.prodname_ghe_cloud %}, you can create additional runner groups; enterprise admins can configure access policies that control which organizations in an enterprise have access to the runner group; and organization admins can assign additional granular repository access policies to the enterprise runner group. For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups). -{% endif %} +{% data reusables.actions.about-runner-groups %} {% ifversion fpt %}For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups).{% endif %} {% ifversion ghec or ghes or ghae %} -Self-hosted runner groups are used to control access to self-hosted runners at the organization and enterprise level. Enterprise owners can configure access policies that control which organizations {% ifversion restrict-groups-to-workflows %}and workflows {% endif %}in an enterprise have access to the runner group. Organization owners can configure access policies that control which repositories{% ifversion restrict-groups-to-workflows %} and workflows{% endif %} in an organization have access to the runner group. - -When an enterprise owner grants an organization access to a runner group, organization owners can see the runner group listed in the organization's self-hosted runner settings. The organization owners can then assign additional granular repository{% ifversion restrict-groups-to-workflows %} and workflow{% endif %} access policies to the enterprise runner group. - -When new runners are created, they are automatically assigned to the default group. Runners can only be in one group at a time. You can move runners from the default group to another group. For more information, see "[Moving a self-hosted runner to a group](#moving-a-self-hosted-runner-to-a-group)." ## Creating a self-hosted runner group for an organization -All organizations have a single default self-hosted runner group. Organizations within an enterprise account can create additional self-hosted groups. Organization admins can allow individual repositories access to a runner group. For information about how to create a self-hosted runner group with the REST API, see "[Self-hosted runner groups](/rest/reference/actions#self-hosted-runner-groups)." - -Self-hosted runners are automatically assigned to the default group when created, and can only be members of one group at a time. You can move a runner from the default group to any group you create. - -When creating a group, you must choose a policy that defines which repositories{% ifversion restrict-groups-to-workflows %} and workflows{% endif %} have access to the runner group. - -{% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %} -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.org_settings %} -{% data reusables.organizations.settings-sidebar-actions-runner-groups %} -1. In the "Runner groups" section, click **New runner group**. -1. Enter a name for your runner group. - {% data reusables.actions.runner-group-assign-policy-repo %} - - {% warning %} +{%- ifversion ghec or ghes %} - **Warning**: {% indented_data_reference reusables.actions.self-hosted-runner-security spaces=3 %} +{% data reusables.actions.self-hosted-runner-security-admonition %} - For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." +{%- endif %} - {% endwarning %} -{% data reusables.actions.runner-group-assign-policy-workflow %}{%- ifversion restrict-groups-to-workflows %} Organization-owned runner groups cannot access workflows from a different organization in the enterprise; instead, you must create an enterprise-owned runner group.{% endif %} -{% data reusables.actions.self-hosted-runner-create-group %} -{% elsif ghae or ghes < 3.4 %} -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.org_settings %} -{% data reusables.organizations.settings-sidebar-actions-runner-groups %} -1. Under {% ifversion ghes or ghae %}"Runners"{% endif %}, click **Add new**, and then **New group**. - - ![Add runner group](/assets/images/help/settings/actions-org-add-runner-group.png) -1. Enter a name for your runner group, and assign a policy for repository access. - - You can configure a runner group to be accessible to a specific list of repositories, or to all repositories in the organization.{% ifversion ghec or ghes %} By default, only private repositories can access runners in a runner group, but you can override this. This setting can't be overridden if configuring an organization's runner group that was shared by an enterprise.{% endif %} - - {%- ifversion ghes %} - {% warning %} - - **Warning**: - - {% indented_data_reference reusables.actions.self-hosted-runner-security spaces=3 %} - - For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." - - {% endwarning %} - {%- endif %} - - ![Add runner group options](/assets/images/help/settings/actions-org-add-runner-group-options.png) -1. Click **Save group** to create the group and apply the policy. -{% endif %} +{% data reusables.actions.creating-a-runner-group-for-an-organization %} ## Creating a self-hosted runner group for an enterprise -Enterprises can add their self-hosted runners to groups for access management. Enterprises can create groups of self-hosted runners that are accessible to specific organizations in the enterprise account{% ifversion restrict-groups-to-workflows %} or to specific workflows{% endif %}. Organization owners can then assign additional granular repository{% ifversion restrict-groups-to-workflows %} or workflow{% endif %} access policies to the enterprise runner groups. For information about how to create a self-hosted runner group with the REST API, see the enterprise endpoints in the [{% data variables.product.prodname_actions %} REST API](/rest/reference/actions#self-hosted-runner-groups). - -Self-hosted runners are automatically assigned to the default group when created, and can only be members of one group at a time. You can assign the runner to a specific group during the registration process, or you can later move the runner from the default group to a custom group. - -When creating a group, you must choose a policy that defines which organizations have access to the runner group. - -{% data reusables.actions.self-hosted-runner-groups-add-to-enterprise-first-steps %} -1. To choose a policy for organization access, select the **Organization access** drop-down, and click a policy. You can configure a runner group to be accessible to a specific list of organizations, or all organizations in the enterprise.{% ifversion ghes %} By default, only private repositories can access runners in a runner group, but you can override this.{% endif %} + {%- ifversion ghec or ghes %} - {%- ifversion ghec or ghes %} - {% warning %} +{% data reusables.actions.self-hosted-runner-security-admonition %} - **Warning**: +{%- endif %} - {% indented_data_reference reusables.actions.self-hosted-runner-security spaces=3 %} - - For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." - - {% endwarning %} - {%- endif %} - {%- ifversion ghec or ghes %} - - ![Add runner group options](/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png) - {%- elsif ghae %} - - ![Add runner group options](/assets/images/help/settings/actions-enterprise-account-add-runner-group-options-ae.png) - {%- endif %} -{% data reusables.actions.runner-group-assign-policy-workflow %} -1. Click **Save group** to create the group and apply the policy. +{% data reusables.actions.creating-a-runner-group-for-an-enterprise %} {% endif %} ## Changing the access policy of a self-hosted runner group -For runner groups in an enterprise, you can change what organizations in the enterprise can access a runner group{% ifversion restrict-groups-to-workflows %} or restrict what workflows a runner group can run{% endif %}. For runner groups in an organization, you can change what repositories in the organization can access a runner group{% ifversion restrict-groups-to-workflows %} or restrict what workflows a runner group can run{% endif %}. - -### Changing what organizations or repositories can access a runner group - -{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %} -{% data reusables.actions.self-hosted-runner-groups-navigate-to-repo-org-enterprise %} -{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %} -1. For runner groups in an enterprise, under **Organization access**, modify what organizations can access the runner group. For runner groups in an organization, under **Repository access**, modify what repositories can access the runner group. - - {%- ifversion fpt or ghec or ghes %} - {% warning %} - - **Warning**: - - {% indented_data_reference reusables.actions.self-hosted-runner-security spaces=3 %} - - For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." - - {% endwarning %} - {%- endif %} -{% elsif ghae or ghes < 3.4 %} -{% data reusables.actions.self-hosted-runner-configure-runner-group-access %} -{% endif %} - -{% ifversion restrict-groups-to-workflows %} -### Changing what workflows can access a runner group -You can configure a self-hosted runner group to run either selected workflows or all workflows. For example, you might use this setting to protect secrets that are stored on self-hosted runners or to standardize deployment workflows by restricting a runner group to run only a specific reusable workflow. This setting cannot be overridden if you are configuring an organization's runner group that was shared by an enterprise. -{% data reusables.actions.self-hosted-runner-groups-navigate-to-repo-org-enterprise %} -{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %} -1. Under **Workflow access**, select the dropdown menu and click **Selected workflows**. -1. Click {% octicon "gear" aria-label="the gear icon" %}. -1. Enter a comma separated list of the workflows that can access the runner group. Use the full path, including the repository name and owner. Pin the workflow to a branch, tag, or full SHA. For example: `octo-org/octo-repo/.github/workflows/build.yml@v2, octo-org/octo-repo/.github/workflows/deploy.yml@d6dc6c96df4f32fa27b039f2084f576ed2c5c2a5, monalisa/octo-test/.github/workflows/test.yml@main`. +{%- ifversion fpt or ghec or ghes %} - Only jobs directly defined within the selected workflows will have access to the runner group. - - Organization-owned runner groups cannot access workflows from a different organization in the enterprise; instead, you must create an enterprise-owned runner group. +{% data reusables.actions.self-hosted-runner-security-admonition %} -1. Click **Save**. +{%- endif %} -{% endif %} +{% data reusables.actions.changing-the-access-policy-of-a-runner-group %} ## Changing the name of a runner group -{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %} -{% data reusables.actions.self-hosted-runner-groups-navigate-to-repo-org-enterprise %} -{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %} -1. Change the runner group name. - -{% elsif ghae or ghes < 3.4 %} -{% data reusables.actions.self-hosted-runner-configure-runner-group %} -1. Change the runner group name. -{% endif %} +{% data reusables.actions.changing-the-name-of-a-runner-group %} {% ifversion ghec or ghes or ghae %} ## Automatically adding a self-hosted runner to a group -You can use the configuration script to automatically add a new self-hosted runner to a group. For example, this command registers a new self-hosted runner and uses the `--runnergroup` parameter to add it to a group named `rg-runnergroup`. - -```sh -./config.sh --url $org_or_enterprise_url --token $token --runnergroup rg-runnergroup -``` - -The command will fail if the runner group doesn't exist: - -``` -Could not find any self-hosted runner group named "rg-runnergroup". -``` +{% data reusables.actions.automatically-adding-a-runner-to-a-group %} ## Moving a self-hosted runner to a group -If you don't specify a runner group during the registration process, your new self-hosted runners are automatically assigned to the default group, and can then be moved to another group. - -{% data reusables.actions.self-hosted-runner-navigate-to-org-enterprise %} -{% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %} -1. In the "Runners" list, click the runner that you want to configure. -2. Select the **Runner group** drop-down. -3. In "Move runner to group", choose a destination group for the runner. -{% elsif ghae or ghes < 3.4 %} -1. In the {% ifversion ghes or ghae %}"Runner groups"{% endif %} section of the settings page, locate the current group of the runner you want to move and expand the list of group members. - ![View runner group members](/assets/images/help/settings/actions-org-runner-group-members.png) -2. Select the checkbox next to the self-hosted runner, and then click **Move to group** to see the available destinations. - ![Runner group member move](/assets/images/help/settings/actions-org-runner-group-member-move.png) -3. To move the runner, click on the destination group. - ![Runner group member move](/assets/images/help/settings/actions-org-runner-group-member-move-destination.png) -{% endif %} +{% data reusables.actions.moving-a-runner-to-a-group %} ## Removing a self-hosted runner group -Self-hosted runners are automatically returned to the default group when their group is removed. +{% data reusables.actions.removing-a-runner-group %} -{% ifversion ghes or ghae or ghec %} -{% data reusables.actions.self-hosted-runner-groups-navigate-to-repo-org-enterprise %} -1. In the list of groups, to the right of the group you want to delete, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}. -2. To remove the group, click **Remove group**. -3. Review the confirmation prompts, and click **Remove this runner group**. - -{% endif %} {% endif %} diff --git a/content/actions/learn-github-actions/understanding-github-actions.md b/content/actions/learn-github-actions/understanding-github-actions.md index 3ac38d19c681..f6e9e9ca751a 100644 --- a/content/actions/learn-github-actions/understanding-github-actions.md +++ b/content/actions/learn-github-actions/understanding-github-actions.md @@ -2,6 +2,7 @@ title: Understanding GitHub Actions shortTitle: Understanding GitHub Actions intro: 'Learn the basics of {% data variables.product.prodname_actions %}, including core concepts and essential terminology.' +miniTocMaxHeadingLevel: 3 redirect_from: - /github/automating-your-workflow-with-github-actions/core-concepts-for-github-actions - /actions/automating-your-workflow-with-github-actions/core-concepts-for-github-actions @@ -82,7 +83,7 @@ For more information, see "[Creating actions](/actions/creating-actions)." ### Runners -{% data reusables.actions.about-runners %} Each runner can run a single job at a time. {% ifversion ghes or ghae %} You must host your own runners for {% data variables.product.product_name %}. {% elsif fpt or ghec %}{% data variables.product.company_short %} provides Ubuntu Linux, Microsoft Windows, and macOS runners to run your workflows; each workflow run executes in a fresh, newly-provisioned virtual machine. If you need a different operating system or require a specific hardware configuration, you can host your own runners.{% endif %} For more information{% ifversion fpt or ghec %} about self-hosted runners{% endif %}, see "[Hosting your own runners](/actions/hosting-your-own-runners)." +{% data reusables.actions.about-runners %} Each runner can run a single job at a time. {% ifversion ghes or ghae %} You must host your own runners for {% data variables.product.product_name %}. {% elsif fpt or ghec %}{% data variables.product.company_short %} provides Ubuntu Linux, Microsoft Windows, and macOS runners to run your workflows; each workflow run executes in a fresh, newly-provisioned virtual machine. {% ifversion actions-hosted-runners %} {% data variables.product.prodname_dotcom %} also offers {% data variables.actions.hosted_runner %}s, which are available in larger configurations. For more information, see "[Using {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/using-larger-runners)." {% endif %}If you need a different operating system or require a specific hardware configuration, you can host your own runners.{% endif %} For more information{% ifversion fpt or ghec %} about self-hosted runners{% endif %}, see "[Hosting your own runners](/actions/hosting-your-own-runners)." {% data reusables.actions.workflow-basic-example-and-explanation %} diff --git a/content/actions/publishing-packages/publishing-nodejs-packages.md b/content/actions/publishing-packages/publishing-nodejs-packages.md index 50746929a63c..0768413dbcfe 100644 --- a/content/actions/publishing-packages/publishing-nodejs-packages.md +++ b/content/actions/publishing-packages/publishing-nodejs-packages.md @@ -98,9 +98,9 @@ Each time you create a new release, you can trigger a workflow to publish your p ### Configuring the destination repository -If you don't provide the `repository` key in your *package.json* file, then {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the `name` field of the *package.json* file. For example, a package named `@my-org/test` is published to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. +Linking your package to {% data variables.product.prodname_registry %} using the `repository` key is optional. If you choose not to provide the `repository` key in your *package.json* file, then {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the `name` field of the *package.json* file. For example, a package named `@my-org/test` is published to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. If the `url` specified in the `repository` key is invalid, your package may still be published however it won't be linked to the repository source as intended. -However, if you do provide the `repository` key, then the repository in that key is used as the destination npm registry for {% data variables.product.prodname_registry %}. For example, publishing the below *package.json* results in a package named `my-amazing-package` published to the `octocat/my-other-repo` {% data variables.product.prodname_dotcom %} repository. +If you do provide the `repository` key in your *package.json* file, then the repository in that key is used as the destination npm registry for {% data variables.product.prodname_registry %}. For example, publishing the below *package.json* results in a package named `my-amazing-package` published to the `octocat/my-other-repo` {% data variables.product.prodname_dotcom %} repository. Once published, only the repository source is updated, and the package doesn't inherit any permissions from the destination repository. ```json { diff --git a/content/actions/using-github-hosted-runners/about-github-hosted-runners.md b/content/actions/using-github-hosted-runners/about-github-hosted-runners.md index dcfa57bf9be7..62fe7d964cd0 100644 --- a/content/actions/using-github-hosted-runners/about-github-hosted-runners.md +++ b/content/actions/using-github-hosted-runners/about-github-hosted-runners.md @@ -86,6 +86,15 @@ While the job runs, the logs and output can be viewed in the {% data variables.p ## Supported runners and hardware resources +{% ifversion actions-hosted-runners %} + +{% note %} + +**Note**: {% data variables.product.prodname_dotcom %} also offers {% data variables.actions.hosted_runner %}s, which are available in larger configurations. For more information, see "[Using {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/using-larger-runners)." + +{% endnote %} +{% endif %} + Hardware specification for Windows and Linux virtual machines: - 2-core CPU (x86_64) - 7 GB of RAM diff --git a/content/actions/using-github-hosted-runners/controlling-access-to-larger-runners.md b/content/actions/using-github-hosted-runners/controlling-access-to-larger-runners.md new file mode 100644 index 000000000000..6aac71b2345a --- /dev/null +++ b/content/actions/using-github-hosted-runners/controlling-access-to-larger-runners.md @@ -0,0 +1,50 @@ +--- +title: Controlling access to larger runners +intro: You can use policies to limit access to {% data variables.actions.hosted_runner %}s that have been added to an organization or enterprise. +product: '{% data reusables.gated-features.hosted-runners %}' +versions: + feature: 'actions-hosted-runners' +type: tutorial +shortTitle: Controlling access to {% data variables.actions.hosted_runner %}s +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + +## About runner groups + +{% data reusables.actions.about-runner-groups %} {% ifversion fpt %}For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/actions/using-github-hosted-runners/controlling-access-to-larger-runners).{% endif %} + +{% ifversion ghec or ghes or ghae %} + +## Creating a runner group for an organization + +{% data reusables.actions.hosted-runner-security-admonition %} +{% data reusables.actions.creating-a-runner-group-for-an-organization %} + +## Creating a runner group for an enterprise + +{% data reusables.actions.hosted-runner-security-admonition %} +{% data reusables.actions.creating-a-runner-group-for-an-enterprise %} + +{% endif %} + +## Changing the access policy of a runner group + +{% data reusables.actions.hosted-runner-security-admonition %} +{% data reusables.actions.changing-the-access-policy-of-a-runner-group %} + +## Changing the name of a runner group + +{% data reusables.actions.changing-the-name-of-a-runner-group %} + +{% ifversion ghec or ghes or ghae %} +## Moving a runner to a group + +{% data reusables.actions.moving-a-runner-to-a-group %} + +## Removing a runner group + +{% data reusables.actions.removing-a-runner-group %} + +{% endif %} diff --git a/content/actions/using-github-hosted-runners/index.md b/content/actions/using-github-hosted-runners/index.md index 2c05480126cb..89da172b2b9d 100644 --- a/content/actions/using-github-hosted-runners/index.md +++ b/content/actions/using-github-hosted-runners/index.md @@ -7,6 +7,8 @@ versions: ghes: '*' children: - /about-github-hosted-runners + - /using-larger-runners + - /controlling-access-to-larger-runners - /monitoring-your-current-jobs - /customizing-github-hosted-runners - /connecting-to-a-private-network diff --git a/content/actions/using-github-hosted-runners/using-larger-runners.md b/content/actions/using-github-hosted-runners/using-larger-runners.md new file mode 100644 index 000000000000..22ea0079197c --- /dev/null +++ b/content/actions/using-github-hosted-runners/using-larger-runners.md @@ -0,0 +1,135 @@ +--- +title: Using larger runners +intro: '{% data variables.product.prodname_dotcom %} offers larger runners with more RAM and CPU.' +miniTocMaxHeadingLevel: 3 +product: '{% data reusables.gated-features.hosted-runners %}' +versions: + feature: 'actions-hosted-runners' +shortTitle: Using {% data variables.actions.hosted_runner %}s +--- + +## Overview of {% data variables.actions.hosted_runner %}s + +In addition to the [standard {% data variables.product.prodname_dotcom %}-hosted runners](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources), {% data variables.product.prodname_dotcom %} also offers customers on {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %} plans a range of {% data variables.actions.hosted_runner %}s with more RAM and CPU. These runners are hosted by {% data variables.product.prodname_dotcom %} and have the runner application and other tools preinstalled. + +When you add a {% data variables.actions.hosted_runner %} to an organization, you are defining a type of machine from a selection of available hardware specifications and operating system images. {% data variables.product.prodname_dotcom %} will then create multiple instances of this runner that scale up and down to match the job demands of your organization, based on the autoscaling limits you define. + +## Architectural overview of {% data variables.actions.hosted_runner %}s + +The {% data variables.actions.hosted_runner %}s are managed at the organization level, where they are arranged into groups that can contain multiple instances of the runner. They can also be created at the enterprise level and shared with organizations in the hierarchy. Once you've created a group, you can then add a runner to the group and update your workflows to target the label assigned to the {% data variables.actions.hosted_runner %}. You can also control which repositories are permitted to send jobs to the group for processing. For more information about groups, see "[Controlling access to {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/controlling-access-to-larger-runners)." + +In the following diagram, a class of hosted runner named `ubuntu-20.04-16core` has been defined with customized hardware and operating system configuration. + +![Diagram explaining {% data variables.actions.hosted_runner %}](/assets/images/hosted-runner.png) + +1. Instances of this runner are automatically created and added to a group called `ubuntu-20.04-16core`. +2. The runners have been assigned the label `ubuntu-20.04-16core`. +3. Workflow jobs use the `ubuntu-20.04-16core` label in their `runs-on` key to indicate the type of runner they need to execute the job. +4. {% data variables.product.prodname_actions %} checks the runner group to see if your repository is authorized to send jobs to the runner. +5. The job runs on the next available instance of the `ubuntu-20.04-16core` runner. + +## Autoscaling {% data variables.actions.hosted_runner %}s + +Your {% data variables.actions.hosted_runner %}s can be configured to automatically scale to suit your needs. When jobs are submitted for processing, more machines can be automatically provisioned to run the jobs, until reaching a pre-defined maximum limit. Each machine only handles one job at a time, so these settings effectively determine the number of jobs that can be run concurrently. + +During the runner deployment process, you can configure the _Max_ option, which allows you to control your costs by setting the maximum parallel number of machines that are created in this set. A higher value here can help avoid workflows being blocked due to parallelism. + +## Networking for {% data variables.actions.hosted_runner %}s + +By default, {% data variables.actions.hosted_runner %}s receive a dynamic IP address that changes for each job run. Optionally, {% data variables.product.prodname_ghe_cloud %} customers can configure their {% data variables.actions.hosted_runner %}s to receive a static IP address from {% data variables.product.prodname_dotcom %}'s IP address pool. When enabled, instances of the {% data variables.actions.hosted_runner %} will receive an address from a range that is unique to the runner, allowing you to use this range to configure a firewall allowlist. You can use up to 10 static IP address ranges in total across all your {% data variables.actions.hosted_runner %}s. + +{% note %} + +**Note**: If runners are unused for more than 30 days, their IP address ranges are automatically removed and cannot be recovered. + +{% endnote %} + +## Planning for {% data variables.actions.hosted_runner %}s + +### Create a runner group + +Runner groups are used to collect sets of virtual machines and create a security boundary around them. You can then decide which organizations or repositories are permitted to run jobs on those sets of machines. During the {% data variables.actions.hosted_runner %} deployment process, the runner can be added to an existing group, or otherwise it will join a default group. You can create a group by following the steps in "[Controlling access to {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/controlling-access-to-larger-runners)." + +### Understanding billing + +Compared to standard {% data variables.product.prodname_dotcom %}-hosted runners, {% data variables.actions.hosted_runner %}s are billed differently. For more information, see "[Per-minute rates](/billing/managing-billing-for-github-actions/about-billing-for-github-actions#per-minute-rates)". + +## Adding a {% data variables.actions.hosted_runner %} to an enterprise + +You can add {% data variables.actions.hosted_runner %}s to an enterprise, where they can be assigned to multiple organizations. The organization admins can then control which repositories can use the runners. To add a {% data variables.actions.hosted_runner %} to an enterprise, you must be an enterprise owner. + +{% data reusables.actions.add-hosted-runner-overview %} + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.policies-tab %} +{% data reusables.enterprise-accounts.actions-tab %} +{% data reusables.enterprise-accounts.actions-runners-tab %} +{% data reusables.actions.add-hosted-runner %} +1. To allow organizations to access your {% data variables.actions.hosted_runner %}s, you specify the list of organizations that can use it. For more information, see "[Managing access to your runners](#managing-access-to-your-runners)." + +## Adding a {% data variables.actions.hosted_runner %} to an organization + +You can add a {% data variables.actions.hosted_runner %} to an organization, where the organization admins can control which repositories can use it. + +{% data reusables.actions.add-hosted-runner-overview %} + +{% data reusables.organizations.navigate-to-org %} +{% data reusables.organizations.org_settings %} +{% data reusables.organizations.settings-sidebar-actions-runners %} +{% data reusables.actions.add-hosted-runner %} +1. To allow repositories to access your {% data variables.actions.hosted_runner %}s, add them to the list of repositories that can use it. For more information, see "[Managing access to your runners](#managing-access-to-your-runners)." + +## Running jobs on your runner + +Once your runner type has been been defined, you can update your workflows to send jobs to the runner instances for processing. In this example, a runner group is populated with Ubuntu 16-core runners, which have been assigned the label `ubuntu-20.04-16core`. If you have a runner matching this label, the `check-bats-version` job then uses the `runs-on` key to target that runner whenever the job is run: + +```yaml +name: learn-github-actions +on: [push] +jobs: + check-bats-version: + runs-on: ubuntu-20.04-16core + steps: + - uses: {% data reusables.actions.action-checkout %} + - uses:{% data reusables.actions.action-setup-node %} + with: + node-version: '14' + - run: npm install -g bats + - run: bats -v +``` + +## Managing access to your runners + +{% note %} + +**Note**: Before your workflows can send jobs to {% data variables.actions.hosted_runner %}s, you must first configure permissions for the runner group. See the following sections for more information. + +{% endnote %} + +Runner groups are used to control which repositories can run jobs on your {% data variables.actions.hosted_runner %}s. You must grant access to the group from each level of the management hierarchy, depending on where you've defined the {% data variables.actions.hosted_runner %}: + +- **Runners at the enterprise level**: Configure the runner group to grant access to all the required organizations. In addition, for each organization, you must configure the group to specify which repositories are allowed access. +- **Runners at the organization level**: Configure the runner group by specifying which repositories are allowed access. + +For example, the following diagram has a runner group named `grp-ubuntu-20.04-16core` at the enterprise level. Before the repository named `octo-repo` can use the runners in the group, you must first configure the group at the enterprise level to allow access from the `octo-org` organization; you must then configure the group at the organization level to allow access from `octo-repo`: + +![Diagram explaining {% data variables.actions.hosted_runner %} groups](/assets/images/hosted-runner-mgmt.png) + +### Allowing repositories to access a runner group + +This procedure demonstrates how to configure group permissions at the enterprise and organization levels: + +{% data reusables.actions.runner-groups-navigate-to-repo-org-enterprise %} +{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %} + - For runner groups in an enterprise: under **Organization access**, modify which organizations can access the runner group. + - For runner groups in an organization: under **Repository access**, modify which repositories can access the runner group. + +{% warning %} + +**Warning**: + +{% data reusables.actions.hosted-runner-security %} + +For more information, see "[Controlling access to {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/controlling-access-to-larger-runners)." + +{% endwarning %} diff --git a/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md b/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md index f636895b40d0..2de67fe8e596 100644 --- a/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md +++ b/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md @@ -51,7 +51,7 @@ For more information on workflow run artifacts, see "[Persisting workflow data u A workflow can access and restore a cache created in the current branch, the base branch (including base branches of forked repositories), or the default branch (usually `main`). For example, a cache created on the default branch would be accessible from any pull request. Also, if the branch `feature-b` has the base branch `feature-a`, a workflow triggered on `feature-b` would have access to caches created in the default branch (`main`), `feature-a`, and `feature-b`. -Access restrictions provide cache isolation and security by creating a logical boundary between different branches. For example, a cache created for the branch `feature-a` (with the base `main`) would not be accessible to a pull request for the branch `feature-c` (with the base `main`). +Access restrictions provide cache isolation and security by creating a logical boundary between different branches or tags. For example, a cache created for the branch `feature-a` (with the base `main`) would not be accessible to a pull request for the branch `feature-c` (with the base `main`). On similar lines, a cache created for the tag `release-a` (from the base `main`) would not be accessible to a workflow triggered for the tag `release-b` (with the base `main`). Multiple workflows within a repository share cache entries. A cache created for a branch within a workflow can be accessed and restored from another workflow for the same repository and branch. diff --git a/content/actions/using-workflows/reusing-workflows.md b/content/actions/using-workflows/reusing-workflows.md index bbdf28e7fee3..676a5f6f4139 100644 --- a/content/actions/using-workflows/reusing-workflows.md +++ b/content/actions/using-workflows/reusing-workflows.md @@ -23,7 +23,7 @@ topics: Rather than copying and pasting from one workflow to another, you can make workflows reusable. You and anyone with access to the reusable workflow can then call the reusable workflow from another workflow. -Reusing workflows avoids duplication. This makes workflows easier to maintain and allows you to create new workflows more quickly by building on the work of others, just as you do with actions. Workflow reuse also promotes best practice by helping you to use workflows that are well designed, have already been tested, and have been proved to be effective. Your organization can build up a library of reusable workflows that can be centrally maintained. +Reusing workflows avoids duplication. This makes workflows easier to maintain and allows you to create new workflows more quickly by building on the work of others, just as you do with actions. Workflow reuse also promotes best practice by helping you to use workflows that are well designed, have already been tested, and have been proven to be effective. Your organization can build up a library of reusable workflows that can be centrally maintained. The diagram below shows three build jobs on the left of the diagram. After each of these jobs completes successfully a dependent job called "Deploy" runs. This job calls a reusable workflow that contains three jobs: "Staging", "Review", and "Production." The "Production" deployment job only runs after the "Staging" job has completed successfully. Using a reusable workflow to run deployment jobs allows you to run those jobs for each build without duplicating code in workflows. @@ -127,7 +127,7 @@ You can define inputs and secrets, which can be passed from the caller workflow runs-on: ubuntu-latest environment: production steps: - - uses: ./.github/workflows/my-action + - uses: octo-org/my-action@v1 with: username: ${{ inputs.username }} token: ${{ secrets.envPAT }} @@ -168,12 +168,13 @@ jobs: name: Pass input and secrets to my-action runs-on: ubuntu-latest steps: - - uses: ./.github/workflows/my-action + - uses: octo-org/my-action@v1 with: username: ${{ inputs.username }} token: ${{ secrets.token }} ``` {% endraw %} + {% ifversion actions-reusable-workflow-matrix %} ## Using a matrix strategy with a reusable workflow diff --git a/content/actions/using-workflows/workflow-commands-for-github-actions.md b/content/actions/using-workflows/workflow-commands-for-github-actions.md index c86943284f24..34308f8f0300 100644 --- a/content/actions/using-workflows/workflow-commands-for-github-actions.md +++ b/content/actions/using-workflows/workflow-commands-for-github-actions.md @@ -334,6 +334,12 @@ Write-Output "::add-mask::Mona The Octocat" {% endpowershell %} +{% warning %} + +**Warning:** Make sure you register the secret with 'add-mask' before outputting it in the build logs or using it in any other workflow commands. + +{% endwarning %} + ### Example: Masking an environment variable When you print the variable `MY_NAME` or the value `"Mona The Octocat"` in the log, you'll see `"***"` instead of `"Mona The Octocat"`. diff --git a/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-dependency-review-for-your-appliance.md b/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-dependency-review-for-your-appliance.md new file mode 100644 index 000000000000..adb32e724661 --- /dev/null +++ b/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-dependency-review-for-your-appliance.md @@ -0,0 +1,52 @@ +--- +title: Configuring dependency review for your appliance +shortTitle: Configuring dependency review +intro: 'To helps users understand dependency changes when reviewing pull requests, you can enable, configure, and disable dependency review for {% data variables.product.product_location %}.' +product: '{% data reusables.gated-features.dependency-review %}' +miniTocMaxHeadingLevel: 3 +versions: + feature: dependency-review-action-ghes +type: how_to +topics: + - Advanced Security + - Enterprise + - Dependency review + - Security +--- + +{% data reusables.dependency-review.beta %} + +## About dependency review + +{% data reusables.dependency-review.feature-overview %} + +Some additional features, such as license checks, blocking of pull requests, and CI/CD integration, are available with the [dependency review action](https://github.com/actions/dependency-review-action). + +## Checking whether your license includes {% data variables.product.prodname_GH_advanced_security %} + +{% data reusables.advanced-security.check-for-ghas-license %} + +## Prerequisites for dependency review + +- A license for {% data variables.product.prodname_GH_advanced_security %}{% ifversion ghes %} (see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)").{% endif %} + +- The dependency graph enabled for the instance. Site administrators can enable the dependency graph via the management console or the administrative shell (see "[Enabling the dependency graph for your enterprise](/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise)"). + +- {% data variables.product.prodname_github_connect %} enabled to download and synchronize vulnerabilities from the {% data variables.product.prodname_advisory_database %}. This is usually configured as part of setting up {% data variables.product.prodname_dependabot %} (see "[Enabling Dependabot for your enterprise](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)"). + +## Enabling and disabling dependency review + +To enable or disable dependency review, you need to enable or disable the dependency graph for your instance. + +For more information, see "[Enabling the dependency graph for your enterprise](/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise)." + +## Running dependency review using {% data variables.product.prodname_actions %} + +{% data reusables.dependency-review.dependency-review-action-beta-note %} + +The dependency review action is included in your installation of {% data variables.product.prodname_ghe_server %}. It is available for all repositories that have {% data variables.product.prodname_GH_advanced_security %} and dependency graph enabled. + +{% data reusables.dependency-review.dependency-review-action-overview %} + +Users run the dependency review action using a {% data variables.product.prodname_actions %} workflow. If you have not already set up runners for {% data variables.product.prodname_actions %}, you must do this to enable users to run workflows. You can provision self-hosted runners at the repository, organization, or enterprise account level. For information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)" and "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)." + diff --git a/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/index.md b/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/index.md index f3ee2561000c..dcd835e93d2f 100644 --- a/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/index.md +++ b/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/index.md @@ -14,6 +14,7 @@ topics: children: - /enabling-github-advanced-security-for-your-enterprise - /configuring-code-scanning-for-your-appliance + - /configuring-dependency-review-for-your-appliance - /configuring-secret-scanning-for-your-appliance --- diff --git a/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise.md b/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise.md index f3fd1067608e..2dad20eda84e 100644 --- a/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise.md +++ b/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise.md @@ -23,7 +23,7 @@ You can enable the dependency graph via the {% data variables.enterprise.managem ## Enabling the dependency graph via the {% data variables.enterprise.management_console %} -If your {% data variables.product.product_location %} uses clustering, you cannot enable the dependency graph with the {% data variables.enterprise.management_console %} and must use the administrative shell instead. For more information, see "[Enabling the dependency graph via the administrative shell](#enabling-the-dependency-graph-via-the-administrative-shell)." +If {% data variables.product.product_location %} uses clustering, you cannot enable the dependency graph with the {% data variables.enterprise.management_console %} and must use the administrative shell instead. For more information, see "[Enabling the dependency graph via the administrative shell](#enabling-the-dependency-graph-via-the-administrative-shell)." {% data reusables.enterprise_site_admin_settings.sign-in %} {% data reusables.enterprise_site_admin_settings.access-settings %} diff --git a/content/admin/configuration/configuring-network-settings/configuring-a-hostname.md b/content/admin/configuration/configuring-network-settings/configuring-a-hostname.md index e9760a9de7b8..e400844d43f9 100644 --- a/content/admin/configuration/configuring-network-settings/configuring-a-hostname.md +++ b/content/admin/configuration/configuring-network-settings/configuring-a-hostname.md @@ -16,7 +16,9 @@ topics: --- If you configure a hostname instead of a hard-coded IP address, you will be able to change the physical hardware that {% data variables.product.product_location %} runs on without affecting users or client software. -The hostname setting in the {% data variables.enterprise.management_console %} should be set to an appropriate fully qualified domain name (FQDN) which is resolvable on the internet or within your internal network. For example, your hostname setting could be `github.companyname.com.` Web and API requests will automatically redirect to the hostname configured in the {% data variables.enterprise.management_console %}. Note that `localhost` is not a valid hostname setting. +The hostname setting in the {% data variables.enterprise.management_console %} should be set to an appropriate fully qualified domain name (FQDN) which is resolvable on the internet or within your internal network. For example, your hostname setting could be `github.companyname.com.` Web and API requests will automatically redirect to the hostname configured in the {% data variables.enterprise.management_console %}. Note that `localhost` is not a valid hostname setting. + +Hostnames must be less than 63 characters in length per [Section 2.3.4 of the Domain Names Specification RFC](https://datatracker.ietf.org/doc/html/rfc1035#section-2.3.4). After you configure a hostname, you can enable subdomain isolation to further increase the security of {% data variables.product.product_location %}. For more information, see "[Enabling subdomain isolation](/enterprise/admin/guides/installation/enabling-subdomain-isolation/)." diff --git a/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md b/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md index e83bab2bcd05..dda4d46612a8 100644 --- a/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md +++ b/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md @@ -90,6 +90,14 @@ settings to allow incoming emails](#configuring-dns-and-firewall-settings-to-all You can enforce TLS encryption for all incoming SMTP connections, which can help satisfy an ISO-27017 certification requirement. +{%- ifversion ghes = 3.6 %} +{% note %} + +**Note**: Enforcement of TLS for SMTP connections is unavailable in {% data variables.product.product_name %} 3.6.0. The feature will be available in an upcoming release. + +{% endnote %} +{%- endif %} + {% data reusables.enterprise_site_admin_settings.email-settings %} 1. Under "Authentication," select **Enforce TLS auth (recommended)**. diff --git a/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md b/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md index e074b64fd8d5..5bd322dcae97 100644 --- a/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md +++ b/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md @@ -131,46 +131,49 @@ Key | Description {% ifversion ghes %} ## Indexing -GitHub's [code search][] features are powered by [ElasticSearch][]. This section of the site admin dashboard shows you the current status of your ElasticSearch cluster and provides you with several tools to control the behavior of searching and indexing. These tools are split into the following three categories. +GitHub's search features are powered by Elasticsearch. This section of the site admin dashboard shows you the current status of your Elasticsearch cluster and provides you with several tools to control search and index behavior. - [Code Search]: https://github.com/blog/1381-a-whole-new-code-search - [ElasticSearch]: http://www.elasticsearch.org/ +For more information about code search, see "[Searching for information on {% data variables.product.prodname_dotcom %}](/search-github)." For more information about Elasticsearch, see the [Elasticsearch website](https://elastic.co). -### Code search +{% note %} -This allows you to enable or disable both search and index operations on source code. +**Note**: In normal use, site administrators do not need to create new indices or schedule repair jobs. For troubleshooting or other support purposes, {% data variables.contact.github_support %} may instruct you to run a repair job. -### Code search index repair +{% endnote %} -This controls how the code search index is repaired. You can +### Index management -- enable or disable index repair jobs -- start a new index repair job -- reset all index repair state +{% data variables.product.product_name %} reconciles the state of the search index with data on the instance automatically and regularly. -{% data variables.product.prodname_enterprise %} uses repair jobs to reconcile the state of the search index with data stored in a database (issues, pull requests, repositories, and users) and data stored in Git repositories (source code). This happens when +- Issues, pull requests, repositories, and users in the database +- Git repositories (source code) on disk -- a new search index is created; -- missing data needs to be backfilled; or -- old search data needs to be updated. +Your instance uses repair jobs to reconcile the data, and schedules a repair job in the background when the following events occur. -In other words, repair jobs are started as needed and run in the background—they are not scheduled by site admins in any way. +- A new search index is created. +- Missing data needs to be backfilled. +- Old search data needs to be updated. -Furthermore, repair jobs use a "repair offset" for parallelization. This is an offset into the database table for the record being reconciled. Multiple background jobs can synchronize work based on this offset. +You can create a new index, or you can click on an existing index in the list to manage the index. You can perform the following operations on an index. -A progress bar shows the current status of a repair job across all of its background workers. It is the percentage difference of the repair offset with the highest record ID in the database. Don't worry about the value shown in the progress bar after a repair job has completed: because it shows the difference between the repair offset and the highest record ID in the database, it will decrease as more repositories are added to {% data variables.product.product_location %} even though those repositories are actually indexed. +- Make the index searchable. +- Make the index writable. +- Update the index. +- Delete the index +- Reset the index repair state. +- Start a new index repair job. +- Enable or disable index repair jobs. -You can start a new code-search index repair job at any time. It will use a single CPU as it reconciles the search index with database and Git repository data. To minimize the effects this will have on I/O performance and reduce the chances of operations timing out, try to run a repair job during off-peak hours first. Monitor your system's load averages and CPU usage with a utility like `top`; if you don't notice any significant changes, it should be safe to run an index repair job during peak hours, as well. +A progress bar shows the current status of a repair job across background workers. The bar is the percentage difference of the repair offset with the highest record ID in the database. You can ignore the value shown in the progress bar after a repair job has completed. The progress bar shows the difference between the repair offset and the highest record ID in the database, and will decrease as more repositories are added to {% data variables.product.product_location %} even though those repositories are actually indexed. -### Issues index repair +To minimize the effects on I/O performance and reduce the chances of operations timing out, run the repair job during off-peak hours. As the job reconciles the search index with database and Git repository data, one CPU will be used. Monitor your system's load averages and CPU usage with a utility like `top`. If you don't notice any significant increase in resource consumption, it should also be safe to run an index repair job during peak hours. -This controls how the [Issues][] index is repaired. You can +Repair jobs use a "repair offset" for parallelization. This is an offset into the database table for the record being reconciled. Multiple background jobs can synchronize work based on this offset. - [Issues]: https://github.com/blog/831-issues-2-0-the-next-generation +### Code search + +This allows you to enable or disable both search and index operations on source code. -- enable or disable index repair jobs -- start a new index repair job -- reset all index repair state {% endif %} ## Reserved logins diff --git a/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md b/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md index 86fdff08dd7b..f96aca87a588 100644 --- a/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md +++ b/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md @@ -14,7 +14,7 @@ topics: - Infrastructure shortTitle: Initiate failover to appliance --- -The time required to failover depends on how long it takes to manually promote the replica and redirect traffic. The average time ranges between 2-10 minutes. +The time required to failover depends on how long it takes to manually promote the replica and redirect traffic. The average time ranges between 20-30 minutes. {% data reusables.enterprise_installation.promoting-a-replica %} diff --git a/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md b/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md index dbc7885a8181..eaf7abed76e3 100644 --- a/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md +++ b/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md @@ -83,7 +83,7 @@ You can create a runner group to manage access to the runner that you added to y {% data variables.product.product_name %} adds all new runners to a group. Runners can be in one group at a time. By default, {% data variables.product.product_name %} adds new runners to the "Default" group. -{% data reusables.actions.self-hosted-runner-groups-add-to-enterprise-first-steps %} +{% data reusables.actions.runner-groups-add-to-enterprise-first-steps %} 1. To choose a policy for organization access, under "Organization access", select the **Organization access** drop-down, and click **Selected organizations**. 1. To the right of the drop-down with the organization access policy, click {% octicon "gear" aria-label="The Gear icon" %}. 1. Select the organizations you'd like to grant access to the runner group. @@ -100,7 +100,7 @@ You can create a runner group to manage access to the runner that you added to y {% endwarning %} {%- endif %} -{% data reusables.actions.self-hosted-runner-create-group %} +{% data reusables.actions.create-runner-group %} {%- ifversion ghec or ghes > 3.3 or ghae-issue-5091 %} 1. Click the "Runners" tab. 1. In the list of runners, click the runner that you deployed in the previous section. diff --git a/content/admin/guides.md b/content/admin/guides.md index 08b0727759f3..ffe7162789f8 100644 --- a/content/admin/guides.md +++ b/content/admin/guides.md @@ -45,6 +45,7 @@ includeGuides: - /admin/configuration/configuring-built-in-firewall-rules - /admin/configuration/configuring-code-scanning-for-your-appliance - /admin/configuration/configuring-data-encryption-for-your-enterprise + - /admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-dependency-review-for-your-appliance - /admin/configuration/configuring-dns-nameservers - /admin/configuration/configuring-rate-limits - /admin/configuration/configuring-secret-scanning-for-your-appliance diff --git a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md index 33fed059661d..9b5984af19b3 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md +++ b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md @@ -146,6 +146,9 @@ The scope of the events that appear in your enterprise's audit log depend on whe {%- ifversion ghec or ghes %} | `business.set_fork_pr_workflows_policy` | The policy for workflows on private repository forks was changed. For more information, see "{% ifversion ghec %}[Enforcing policies for {% data variables.product.prodname_actions %} in an enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-fork-pull-requests-in-private-repositories){% else ifversion ghes > 2.22 %}[Enabling workflows for private repository forks](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enforcing-github-actions-policies-for-your-enterprise#enabling-workflows-for-private-repository-forks){% endif %}." {%- endif %} +{%- ifversion audit-log-sso-response-events %} +|`business.sso_response` | A SAML single sign-on (SSO) response was generated when a member attempted to authenticate with your enterprise. This event is only available via audit log streaming and the REST API. +{%- endif %} {%- ifversion ghes %} | `business.update_actions_settings` | An enterprise owner or site administrator updated {% data variables.product.prodname_actions %} policy settings for an enterprise. For more information, see "[Enforcing policies for GitHub Actions in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise)." {%- endif %} @@ -730,8 +733,8 @@ Before you'll see `git` category actions, you must enable Git events in the audi {%- ifversion fpt or ghec or ghes %} | `org.set_fork_pr_workflows_policy` | The policy for workflows on private repository forks was changed. For more information, see "[Enabling workflows for private repository forks](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#enabling-workflows-for-private-repository-forks)." {%- endif %} -{%- ifversion ghes %} -| `org.sso_response` | A SAML single sign-on response was generated when a member attempted to authenticate with an organization. +{%- ifversion ghes or audit-log-sso-response-events %} +| `org.sso_response` | A SAML single sign-on (SSO) response was generated when a member attempted to authenticate with your organization. This event is only available via audit log streaming and the REST API. {%- endif %} {%- ifversion not ghae %} | `org.transform` | A user account was converted into an organization. For more information, see "[Converting a user into an organization](/github/setting-up-and-managing-your-github-user-account/converting-a-user-into-an-organization)." diff --git a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md index daea61b47a56..b34b1c60c307 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md +++ b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md @@ -44,7 +44,8 @@ You set up the audit log stream on {% data variables.product.product_name %} by - [Amazon S3](#setting-up-streaming-to-amazon-s3) - [Azure Blob Storage](#setting-up-streaming-to-azure-blob-storage) -- [Azure Event Hubs](#setting-up-streaming-to-azure-event-hubs) +- [Azure Event Hubs](#setting-up-streaming-to-azure-event-hubs){% ifversion streaming-datadog %} +- [Datadog](#setting-up-streaming-to-datadog){% endif %} - [Google Cloud Storage](#setting-up-streaming-to-google-cloud-storage) - [Splunk](#setting-up-streaming-to-splunk) @@ -60,7 +61,7 @@ You can set up streaming to S3 with access keys or, to avoid storing long-lived #### Setting up streaming to S3 with access keys {% endif %} -To stream audit logs to Amazon's S3 endpoint, you must have a bucket and access keys. For more information, see [Creating, configuring, and working with Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) in the the AWS documentation. Make sure to block public access to the bucket to protect your audit log information. +To stream audit logs to Amazon's S3 endpoint, you must have a bucket and access keys. For more information, see [Creating, configuring, and working with Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) in the AWS documentation. Make sure to block public access to the bucket to protect your audit log information. To set up audit log streaming from {% data variables.product.prodname_dotcom %} you will need: * The name of your Amazon S3 bucket @@ -231,6 +232,32 @@ You need two pieces of information about your event hub: its instance name and t {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} +{% ifversion streaming-datadog %} +### Setting up streaming to Datadog + +To set up streaming to Datadog, you must create a client token or an API key in Datadog, then configure audit log streaming in {% data variables.product.product_name %} using the token for authentication. You do not need to create a bucket or other storage container in Datadog. + +After you set up streaming to Datadog, you can see your audit log data by filtering by "github.audit.streaming." For more information, see [Log Management](https://docs.datadoghq.com/logs/). + +1. If you don't already have a Datadog account, create one. +1. In Datadog, generate a client token or an API key, then click **Copy key**. For more information, see [API and Application Keys](https://docs.datadoghq.com/account_management/api-app-keys/) in Datadog Docs. +{% data reusables.enterprise.navigate-to-log-streaming-tab %} +1. Select the **Configure stream** dropdown menu and click **Datadog**. + + ![Screenshot of the "Configure stream" dropdown menu with "Datadog" highlighted](/assets/images/help/enterprises/audit-stream-choice-datadog.png) +1. Under "Token", paste the token you copied earlier. + + ![Screenshot of the "Token" field](/assets/images/help/enterprises/audit-stream-datadog-token.png) +1. Select the "Site" dropdown menu and click your Datadog site. To determine your Datadog site, compare your Datadog URL to the table in [Datadog sites](https://docs.datadoghq.com/getting_started/site/) in Datadog Docs. + + ![Screenshot of the "Site" dropdown menu](/assets/images/help/enterprises/audit-stream-datadog-site.png) +1. To verify that {% data variables.product.prodname_dotcom %} can connect and write to the Datadog endpoint, click **Check endpoint**. + + ![Check the endpoint](/assets/images/help/enterprises/audit-stream-check.png) +{% data reusables.enterprise.verify-audit-log-streaming-endpoint %} +1. After a few minutes, confirm that audit log data is appearing on the **Logs** tab in Datadog. If audit log data is not appearing, confirm that your token and site are correct in {% data variables.product.prodname_dotcom %}. +{% endif %} + ### Setting up streaming to Google Cloud Storage To set up streaming to Google Cloud Storage, you must create a service account in Google Cloud with the appropriate credentials and permissions, then configure audit log streaming in {% data variables.product.product_name %} using the service account's credentials for authentication. @@ -292,6 +319,10 @@ To stream audit logs to Splunk's HTTP Event Collector (HEC) endpoint you must ma Pausing the stream allows you to perform maintenance on the receiving application without losing audit data. Audit logs are stored for up to seven days on {% data variables.product.product_location %} and are then exported when you unpause the stream. +{% ifversion streaming-datadog %} +Datadog only accepts logs from up to 18 hours in the past. If you pause a stream to a Datadog endpoint for more than 18 hours, you risk losing logs that Datadog won't accept after you resume streaming. +{% endif %} + {% data reusables.enterprise.navigate-to-log-streaming-tab %} 1. Click **Pause stream**. diff --git a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md index 839a06c3090a..c16e6c9f880c 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md +++ b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md @@ -121,7 +121,7 @@ For more information about the audit log REST API, see "[Enterprise administrati The query below searches for audit log events created on Jan 1st, 2022 in the `avocado-corp` enterprise, and return the first page with a maximum of 100 items per page using [REST API pagination](/rest/overview/resources-in-the-rest-api#pagination): ```shell -curl -H "Authorization: token TOKEN" \ +curl -H "Authorization: Bearer TOKEN" \ --request GET \ "https://api.github.com/enterprises/avocado-corp/audit-log?phrase=created:2022-01-01&page=1&per_page=100" ``` @@ -133,7 +133,7 @@ You can specify multiple search phrases, such as `created` and `actor`, by separ The query below searches for audit log events for pull requests, where the event occurred on or after Jan 1st, 2022 in the `avocado-corp` enterprise, and the action was performed by the `octocat` user: ```shell -curl -H "Authorization: token TOKEN" \ +curl -H "Authorization: Bearer TOKEN" \ --request GET \ "https://api.github.com/enterprises/avocado-corp/audit-log?phrase=action:pull_request+created:>=2022-01-01+actor:octocat" ``` diff --git a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md index 69f3a5530326..75b2044c679f 100644 --- a/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md +++ b/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md @@ -81,6 +81,8 @@ You can also configure allowed IP addresses for an individual organization. For {% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %} +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} diff --git a/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md b/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md index 77c7fffea004..d3757186dbe4 100644 --- a/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md +++ b/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md @@ -44,7 +44,7 @@ The Migrations API is currently in a preview period, which means that the endpoi * Your access token for authentication. * A [list of the repositories](/free-pro-team@latest/rest/repos#list-organization-repositories) you want to migrate: ```shell - curl -H "Authorization: token GITHUB_ACCESS_TOKEN" \ + curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" \ -X POST \ -H "Accept: application/vnd.github+json" \ -d'{"lock_repositories":true,"repositories":["orgname/reponame", "orgname/reponame"]}' \ @@ -59,7 +59,7 @@ The Migrations API is currently in a preview period, which means that the endpoi * Your access token for authentication. * The unique `id` of the migration: ```shell - curl -H "Authorization: token GITHUB_ACCESS_TOKEN" \ + curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" \ -H "Accept: application/vnd.github+json" \ https://api.github.com/orgs/orgname/migrations/id ``` @@ -74,7 +74,7 @@ The Migrations API is currently in a preview period, which means that the endpoi * Your access token for authentication. * The unique `id` of the migration: ```shell - curl -H "Authorization: token GITHUB_ACCESS_TOKEN" \ + curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" \ -H "Accept: application/vnd.github+json" \ -L -o migration_archive.tar.gz \ https://api.github.com/orgs/orgname/migrations/id/archive @@ -84,7 +84,7 @@ The Migrations API is currently in a preview period, which means that the endpoi * Your access token for authentication. * The unique `id` of the migration: ```shell - curl -H "Authorization: token GITHUB_ACCESS_TOKEN" \ + curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" \ -X DELETE \ -H "Accept: application/vnd.github+json" \ https://api.github.com/orgs/orgname/migrations/id/archive diff --git a/content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md b/content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md index 0e8aa4600537..c614ef94ce37 100644 --- a/content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md +++ b/content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md @@ -133,7 +133,7 @@ To unlock the repositories on a {% data variables.product.prodname_dotcom_the_we * The unique `id` of the migration * The name of the repository to unlock ```shell -curl -H "Authorization: token GITHUB_ACCESS_TOKEN" -X DELETE \ +curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" -X DELETE \ -H "Accept: application/vnd.github.wyandotte-preview+json" \ https://api.github.com/orgs/orgname/migrations/id/repos/repo_name/lock ``` @@ -142,7 +142,7 @@ curl -H "Authorization: token GITHUB_ACCESS_TOKEN" -X DELETE \ After unlocking the {% data variables.product.prodname_dotcom_the_website %} organization's repositories, you should delete every repository you previously migrated using [the repository delete endpoint](/rest/repos/#delete-a-repository). You'll need your access token for authentication: ```shell -curl -H "Authorization: token GITHUB_ACCESS_TOKEN" -X DELETE \ +curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" -X DELETE \ https://api.github.com/repos/orgname/repo_name ``` diff --git a/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md b/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md index a7b0dcab0055..b7ece38d4e70 100644 --- a/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md +++ b/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md @@ -52,7 +52,7 @@ topics: {% data reusables.gpg.copy-gpg-key-id %} 10. Paste the text below, substituting in the GPG key ID you'd like to use. In this example, the GPG key ID is `3AA5C34371567BD2`: ```shell{:copy} - $ gpg --armor --export 3AA5C34371567BD2 + $ gpg --armor --export 3AA5C34371567BD2 # Prints the GPG key ID, in ASCII armor format ``` 11. Copy your GPG key, beginning with `-----BEGIN PGP PUBLIC KEY BLOCK-----` and ending with `-----END PGP PUBLIC KEY BLOCK-----`. diff --git a/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md b/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md index 5d22caf82502..ffc87c915490 100644 --- a/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md +++ b/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md @@ -1,6 +1,7 @@ --- title: About billing for GitHub Actions intro: 'If you want to use {% data variables.product.prodname_actions %} beyond the storage or minutes included in your account, you will be billed for additional usage.' +miniTocMaxHeadingLevel: 3 redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions/about-billing-for-github-actions @@ -27,6 +28,14 @@ Minutes reset every month, while storage usage does not. ### Included storage and minutes +{% ifversion actions-hosted-runners %} +{% note %} + +**Note**: Entitlement minutes cannot be used for Windows and Ubuntu runners over 2-cores. These runners will always be charged for, including in public repos. For more information, see "[Per-minute rates for runners](/billing/managing-billing-for-github-actions/about-billing-for-github-actions#per-minute-rates)." + +{% endnote %} +{% endif %} + |Product | Storage | Minutes (per month)| |------- | ------- | ---------| | {% data variables.product.prodname_free_user %} | 500 MB | 2,000 | @@ -57,15 +66,15 @@ The storage used by a repository is the total storage used by {% data variables. ### Per-minute rates -| Operating system | Per-minute rate (USD) | -|------- | ---------| -| Linux | $0.008 | -| macOS | $0.08 | -| Windows | $0.016 | - -The number of jobs you can run concurrently across all repositories in your user or organization account depends on your GitHub plan. For more information, see "[Usage limits and billing](/actions/reference/usage-limits-billing-and-administration)" for {% data variables.product.prodname_dotcom %}-hosted runners and "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)" for self-hosted runner usage limits. +{% data reusables.billing.billing-standard-runners %} +{% ifversion actions-hosted-runners %}{% data reusables.billing.billing-hosted-runners %}{% endif %} -{% data reusables.user-settings.context_switcher %} +- The number of jobs you can run concurrently across all repositories in your user or organization account depends on your GitHub plan. For more information, see "[Usage limits and billing](/actions/reference/usage-limits-billing-and-administration)" for {% data variables.product.prodname_dotcom %}-hosted runners and "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)" for self-hosted runner usage limits. +- {% data reusables.user-settings.context_switcher %} +{% ifversion actions-hosted-runners %} +- For {% data variables.actions.hosted_runner %}s, there is no additional cost for configurations that assign public static IP addresses to a {% data variables.actions.hosted_runner %}. For more information on {% data variables.actions.hosted_runner %}s, see "[Using {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/using-larger-runners)." +- Entitlement minutes cannot be used for {% data variables.actions.hosted_runner %}s. +{% endif %} ## Calculating minute and storage spending diff --git a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md index 89a7a591d444..693aff8c64ec 100644 --- a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md +++ b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md @@ -359,7 +359,7 @@ In the following example, the `+` symbol ensures that the specified additional { ## Using a custom configuration file -A custom configuration file is an alternative way to specify additional {% ifversion codeql-packs %}packs and {% endif %}queries to run. You can also use the file to disable the default queries and to specify which directories to scan during analysis. +A custom configuration file is an alternative way to specify additional {% ifversion codeql-packs %}packs and {% endif %}queries to run. You can also use the file to disable the default queries{% ifversion code-scanning-exclude-queries-from-analysis %}, exclude or include specific queries,{% endif %} and to specify which directories to scan during analysis. In the workflow file, use the `config-file` parameter of the `init` action to specify the path to the configuration file you want to use. This example loads the configuration file _./.github/codeql/codeql-config.yml_. @@ -442,6 +442,41 @@ Optionally, you can give each array element a name, as shown in the example conf If you only want to run custom queries, you can disable the default security queries by using `disable-default-queries: true`. +{% ifversion code-scanning-exclude-queries-from-analysis %} +### Excluding specific queries from analysis + +You can add `exclude` and `include` filters to your custom configuration file, to specify the queries you want to exclude or include in the analysis. + +This is useful if you want to exclude, for example: +- Specific queries from the default suites (`security`, `security-extended` and `security-and-quality`). +- Specific queries whose results do not interest you. +- All the queries that generate warnings and recommendations. + +You can use `exclude` filters similar to those in the configuration file below to exclude queries that you want to remove from the default analysis. In the example of configuration file below, both the `js/redundant-assignment` and the `js/useless-assignment-to-local` queries are excluded from analysis. + +```yaml +query-filters: + - exclude: + id: js/redundant-assignment + - exclude: + id: js/useless-assignment-to-local +``` +To find the id of a query, you can click the alert in the list of alerts in the Security tab. This opens the alert details page. The `Rule ID` field contains the query id. For more information about the alert details page, see "[About {% data variables.product.prodname_code_scanning %} alerts](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts#about-alert-details)." + +{% tip %} + +**Tips:** +- The order of the filters is important. The first filter instruction that appears after the instructions about the queries and query packs determines whether the queries are included or excluded by default. +- Subsequent instructions are executed in order and the instructions that appear later in the file take precedence over the earlier instructions. + +{% endtip %} + +You can find another example illustrating the use of these filters in the "[Example configuration files](#example-configuration-files)" section. + +For more information about using `exclude` and `include` filters in your custom configuration file, see "[Creating {% data variables.product.prodname_codeql %} query suites](https://codeql.github.com/docs/codeql-cli/creating-codeql-query-suites/#filtering-the-queries-in-a-query-suite)." For information on the query metadata you can filter on, see "[Metadata for CodeQL queries](https://codeql.github.com/docs/writing-codeql-queries/metadata-for-codeql-queries/)." + +{% endif %} + ### Specifying directories to scan For the interpreted languages that {% data variables.product.prodname_codeql %} supports (Python{% ifversion fpt or ghes > 3.3 or ghae-issue-5017 %}, Ruby{% endif %} and JavaScript/TypeScript), you can restrict {% data variables.product.prodname_code_scanning %} to files in specific directories by adding a `paths` array to the configuration file. You can exclude the files in specific directories from analysis by adding a `paths-ignore` array. diff --git a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md index c983e246ac18..5cad113a821a 100644 --- a/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md +++ b/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md @@ -33,8 +33,6 @@ In repositories where {% data variables.product.prodname_code_scanning %} is con - The **Conversation** tab of the pull request, as part of a pull request review {% endif %} - The **Files changed** tab of the pull request -{% ifversion code-scanning-pr-conversations-tab %} {% endif %} - If you have write permission for the repository, you can see any existing {% data variables.product.prodname_code_scanning %} alerts on the **Security** tab. For information about repository alerts, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)." {% ifversion fpt or ghes > 3.2 or ghae or ghec %} diff --git a/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md b/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md index daeb17e4833c..74df7049d25c 100644 --- a/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md +++ b/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md @@ -45,9 +45,15 @@ If you upload a second SARIF file for a commit with the same category and from t If you're new to SARIF and want to learn more, see Microsoft's [`SARIF tutorials`](https://github.com/microsoft/sarif-tutorials) repository. -## Preventing duplicate alerts using fingerprints +## Providing data to track {% data variables.product.prodname_code_scanning %} alerts across runs -Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the right line of code when files are edited. +Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the correct line of code when files are edited. The `ruleID` for a result has to be the same across analysis. + +### Reporting consistent filepaths + +The filepath has to be consistent across the runs to enable a computation of a stable fingerprint. If the filepaths differ for the same result, each time there is a new analysis a new alert will be created, and the old one will be closed. This will cause having multiple alerts for the same result. + +### Including data for fingerprint generation {% data variables.product.prodname_dotcom %} uses the `partialFingerprints` property in the OASIS standard to detect when two results are logically identical. For more information, see the "[partialFingerprints property](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012611)" entry in the OASIS documentation. @@ -77,6 +83,12 @@ You can check a SARIF file is compatible with {% data variables.product.prodname If you use a code analysis engine other than {% data variables.product.prodname_codeql %}, you can review the supported SARIF properties to optimize how your analysis results will appear on {% data variables.product.prodname_dotcom %}. +{% note %} + +**Note:** You must supply an explicit value for any property marked as "required". The empty string is not supported for required properties. + +{% endnote %} + Any valid SARIF 2.1.0 output file can be uploaded, however, {% data variables.product.prodname_code_scanning %} will only use the following supported properties. ### `sarifLog` object @@ -138,7 +150,7 @@ Each `result` object contains details for one alert in the codebase. Within the | `level`| **Optional.** The severity of the result. This level overrides the default severity defined by the rule. {% data variables.product.prodname_code_scanning_capc %} uses the level to filter results by severity on {% data variables.product.prodname_dotcom %}. | `message.text`| **Required.** A message that describes the result. {% data variables.product.prodname_code_scanning_capc %} displays the message text as the title of the result. Only the first sentence of the message will be displayed when visible space is limited. | `locations[]`| **Required.** The set of locations where the result was detected up to a maximum of 10. Only one location should be included unless the problem can only be corrected by making a change at every specified location. **Note:** At least one location is required for {% data variables.product.prodname_code_scanning %} to display a result. {% data variables.product.prodname_code_scanning_capc %} will use this property to decide which file to annotate with the result. Only the first value of this array is used. All other values are ignored. -| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Preventing duplicate alerts using fingerprints](#preventing-duplicate-alerts-using-fingerprints)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. +| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Providing data to track code scanning alerts across runs](#providing-data-to-track-code-scanning-alerts-across-runs)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. | `codeFlows[].threadFlows[].locations[]`| **Optional.** An array of `location` objects for a `threadFlow` object, which describes the progress of a program through a thread of execution. A `codeFlow` object describes a pattern of code execution used to detect a result. If code flows are provided, {% data variables.product.prodname_code_scanning %} will expand code flows on {% data variables.product.prodname_dotcom %} for the relevant result. For more information, see the [`location` object](#location-object). | `relatedLocations[]`| A set of locations relevant to this result. {% data variables.product.prodname_code_scanning_capc %} will link to related locations when they are embedded in the result message. For more information, see the [`location` object](#location-object). @@ -204,7 +216,7 @@ These example SARIF output files show supported properties and example values. ### Example with minimum required properties -This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties or don't include values, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. +This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties, omit values, or use an empty string, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. ```json { diff --git a/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md b/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md index 1e03a239f38e..193ee54f5aa9 100644 --- a/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md +++ b/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md @@ -58,7 +58,7 @@ For more information see the [`upload-sarif` action](https://github.com/github/c The `upload-sarif` action can be configured to run when the `push` and `scheduled` event occur. For more information about {% data variables.product.prodname_actions %} events, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." -If your SARIF file doesn't include `partialFingerprints`, the `upload-sarif` action will calculate the `partialFingerprints` field for you and attempt to prevent duplicate alerts. {% data variables.product.prodname_dotcom %} can only create `partialFingerprints` when the repository contains both the SARIF file and the source code used in the static analysis. For more information about preventing duplicate alerts, see "[About SARIF support for code scanning](/code-security/secure-coding/sarif-support-for-code-scanning#preventing-duplicate-alerts-using-fingerprints)." +If your SARIF file doesn't include `partialFingerprints`, the `upload-sarif` action will calculate the `partialFingerprints` field for you and attempt to prevent duplicate alerts. {% data variables.product.prodname_dotcom %} can only create `partialFingerprints` when the repository contains both the SARIF file and the source code used in the static analysis. For more information about preventing duplicate alerts, see "[About SARIF support for code scanning](/code-security/secure-coding/sarif-support-for-code-scanning#providing-data-to-track-code-scanning-alerts-across-runs)." {% data reusables.code-scanning.upload-sarif-alert-limit %} diff --git a/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md b/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md index 54ca86d3afa0..a9c8d47e23ff 100644 --- a/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md +++ b/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md @@ -78,7 +78,8 @@ You can display the command-line help for any command using the `--help``--command` | | Recommended. Use to specify the build command or script that invokes the build process for the codebase. Commands are run from the current folder or, where it is defined, from `--source-root`. Not needed for Python and JavaScript/TypeScript analysis. | | `--db-cluster` | | Optional. Use in multi-language codebases to generate one database for each language specified by `--language`. | `--no-run-unnecessary-builds` | | Recommended. Use to suppress the build command for languages where the {% data variables.product.prodname_codeql_cli %} does not need to monitor the build (for example, Python and JavaScript/TypeScript). -| `--source-root` | | Optional. Use if you run the CLI outside the checkout root of the repository. By default, the `database create` command assumes that the current directory is the root directory for the source files, use this option to specify a different location. | +| `--source-root` | | Optional. Use if you run the CLI outside the checkout root of the repository. By default, the `database create` command assumes that the current directory is the root directory for the source files, use this option to specify a different location. |{% ifversion fpt or ghec or ghes > 3.2 or ghae %} +| `--codescanning-config` | | Optional (Advanced). Use if you have a configuration file that specifies how to create the {% data variables.product.prodname_codeql %} databases and what queries to run in later steps. For more information, see "[Using a custom configuration file](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-a-custom-configuration-file)" and "[database create](https://codeql.github.com/docs/codeql-cli/manual/database-create/#cmdoption-codeql-database-create-codescanning-config)." |{% endif %} For more information, see [Creating {% data variables.product.prodname_codeql %} databases](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/) in the documentation for the {% data variables.product.prodname_codeql_cli %}. diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review.md index 5cf97e5410da..bd543a91a3a2 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review.md +++ b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review.md @@ -75,7 +75,7 @@ The following configuration options are available. {% endtip %} {% endif %} -This {% data variables.product.prodname_dependency_review_action %} example file illustrates how you can use these configuration options. +This {% data variables.product.prodname_dependency_review_action %} example file illustrates how you can use these configuration options. Notice that the example uses short version number for the action (`v2`) instead of a semver release number (for example, `v2.0.8`). This ensures that you use the most recent minor version of the action. ```yaml{:copy} name: 'Dependency Review' diff --git a/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md b/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md index 7e5c96aa99ed..24fca3adc862 100644 --- a/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md +++ b/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md @@ -12,25 +12,25 @@ shortTitle: Private image registry ## About private image registries and {% data variables.product.prodname_github_codespaces %} -A registry is a secure space for storing, managing, and fetching private container images. You may use one to store one or more images. There are many examples of registries, such as {% data variables.product.prodname_dotcom %} Container Registry, Azure Container Registry, or DockerHub. +A registry is a secure space for storing, managing, and fetching private container images. You may use one to store one or more images. There are many examples of registries, such as {% data variables.product.prodname_container_registry %}, {% data variables.product.prodname_npm_registry %}, Azure Container Registry, or DockerHub. -{% data variables.product.prodname_dotcom %} Container Registry can be configured to pull container images seamlessly, without having to provide any authentication credentials to {% data variables.product.prodname_github_codespaces %}. For other image registries, you must create secrets in {% data variables.product.prodname_dotcom %} to store the access details, which will allow {% data variables.product.prodname_codespaces %} to access images stored in that registry. +{% data variables.product.prodname_ghcr_and_npm_registry %} can be configured to allow container images to be pulled seamlessly into {% data variables.product.prodname_github_codespaces %} during codespace creation, without having to provide any authentication credentials. For other image registries, you must create secrets in {% data variables.product.prodname_dotcom %} to store the access details, which will allow {% data variables.product.prodname_codespaces %} to access images stored in that registry. -## Accessing images stored in {% data variables.product.prodname_dotcom %} Container Registry +## Accessing images stored in {% data variables.product.prodname_ghcr_and_npm_registry %} -{% data variables.product.prodname_dotcom %} Container Registry is the easiest way for {% data variables.product.prodname_codespaces %} to consume devcontainer container images. +{% data variables.product.prodname_ghcr_and_npm_registry %} provide the easiest way for {% data variables.product.prodname_codespaces %} to consume dev container images. -For more information, see "[Working with the Container registry](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)". +For more information, see "[Working with the Container registry](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)" and "[Working with the npm registry](/packages/working-with-a-github-packages-registry/working-with-the-npm-registry)". ### Accessing an image published to the same repository as the codespace -If you publish a container image to {% data variables.product.prodname_dotcom %} Container Registry in the same repository that the codespace is being launched in, you will automatically be able to fetch that image on codespace creation. You won't have to provide any additional credentials, unless the **Inherit access from repo** option was unselected when the container image was published. +If you publish a container image to {% data variables.product.prodname_ghcr_or_npm_registry %} in the same repository that the codespace is being launched in, you will automatically be able to fetch that image on codespace creation. You won't have to provide any additional credentials, unless the **Inherit access from repo** option was unselected when the container image was published. #### Inheriting access from the repository from which an image was published -By default, when you publish a container image to {% data variables.product.prodname_dotcom %} Container Registry, the image inherits the access setting of the repository from which the image was published. For example, if the repository is public, the image is also public. If the repository is private, the image is also private, but is accessible from the repository. +By default, when you publish a container image to {% data variables.product.prodname_ghcr_or_npm_registry %}, the image inherits the access setting of the repository from which the image was published. For example, if the repository is public, the image is also public. If the repository is private, the image is also private, but is accessible from the repository. -This behavior is controlled by the **Inherit access from repo** option. **Inherit access from repo** is selected by default when publishing via {% data variables.product.prodname_actions %}, but not when publishing directly to {% data variables.product.prodname_dotcom %} Container Registry using a Personal Access Token (PAT). +This behavior is controlled by the **Inherit access from repo** option. **Inherit access from repo** is selected by default when publishing via {% data variables.product.prodname_actions %}, but not when publishing directly to {% data variables.product.prodname_ghcr_or_npm_registry %} using a Personal Access Token (PAT). If the **Inherit access from repo** option was not selected when the image was published, you can manually add the repository to the published container image's access controls. For more information, see "[Configuring a package's access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#inheriting-access-for-a-container-image-from-a-repository)." @@ -46,13 +46,13 @@ If you want to allow a subset of an organization's repositories to access a cont ### Publishing a container image from a codespace -Seamless access from a codespace to {% data variables.product.prodname_dotcom %} Container Registry is limited to pulling container images. If you want to publish a container image from inside a codespace, you must use a personal access token (PAT) with the `write:packages` scope. +Seamless access from a codespace to {% data variables.product.prodname_ghcr_or_npm_registry %} is limited to pulling container images. If you want to publish a container image from inside a codespace, you must use a personal access token (PAT) with the `write:packages` scope. -We recommend publishing images via {% data variables.product.prodname_actions %}. For more information, see "[Publishing Docker images](/actions/publishing-packages/publishing-docker-images)." +We recommend publishing images via {% data variables.product.prodname_actions %}. For more information, see "[Publishing Docker images](/actions/publishing-packages/publishing-docker-images)" and "[Publishing Node.js packages](/actions/publishing-packages/publishing-nodejs-packages)." ## Accessing images stored in other container registries -If you are accessing a container image from a registry that isn't {% data variables.product.prodname_dotcom %} Container Registry, {% data variables.product.prodname_codespaces %} checks for the presence of three secrets, which define the server name, username, and personal access token (PAT) for a container registry. If these secrets are found, {% data variables.product.prodname_github_codespaces %} will make the registry available inside your codespace. +If you are accessing a container image from a registry that isn't {% data variables.product.prodname_ghcr_or_npm_registry %}, {% data variables.product.prodname_codespaces %} checks for the presence of three secrets, which define the server name, username, and personal access token (PAT) for a container registry. If these secrets are found, {% data variables.product.prodname_github_codespaces %} will make the registry available inside your codespace. - `<*>_CONTAINER_REGISTRY_SERVER` - `<*>_CONTAINER_REGISTRY_USER` diff --git a/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md b/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md index bf2b347536e8..a26e5f7ebdde 100644 --- a/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md +++ b/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md @@ -17,7 +17,7 @@ redirect_from: ## About the {% data variables.product.prodname_vscode_command_palette %} -The Command Palette is one of the focal features of {% data variables.product.prodname_vscode %} and is available for you to use in {% data variables.product.prodname_github_codespaces %}. The {% data variables.product.prodname_vscode_command_palette %} allows you to access many commands for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_vscode_shortname %}. For more information on using the {% data variables.product.prodname_vscode_command_palette_shortname %}, see "[User Interface](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette)" in the {% data variables.product.prodname_vscode_shortname %} documentation. +The Command Palette is one of the focal features of {% data variables.product.prodname_vscode %} and is available for you to use in {% data variables.product.prodname_github_codespaces %}. The Command Palette allows you to access many commands for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_vscode_shortname %}. For more information on using the {% data variables.product.prodname_vscode_command_palette_shortname %}, see "[User Interface](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette)" in the {% data variables.product.prodname_vscode_shortname %} documentation. ## Accessing the {% data variables.product.prodname_vscode_command_palette_shortname %} diff --git a/content/codespaces/developing-in-codespaces/getting-started-with-github-codespaces-for-machine-learning.md b/content/codespaces/developing-in-codespaces/getting-started-with-github-codespaces-for-machine-learning.md new file mode 100644 index 000000000000..b4000e433e06 --- /dev/null +++ b/content/codespaces/developing-in-codespaces/getting-started-with-github-codespaces-for-machine-learning.md @@ -0,0 +1,120 @@ +--- +title: Getting started with GitHub Codespaces for machine learning +shortTitle: Machine learning +intro: 'Learn about working on machine learning projects with {% data variables.product.prodname_github_codespaces %} and its out-of-the-box tools.' +product: '{% data reusables.gated-features.codespaces %}' +versions: + fpt: '*' + ghec: '*' +type: tutorial +topics: + - Codespaces + - Developer +--- + +## Introduction + +This guide introduces you to machine learning with {% data variables.product.prodname_github_codespaces %}. You’ll build a simple image classifier, learn about some of the tools that come preinstalled in {% data variables.product.prodname_github_codespaces %}, configure your development environment for NVIDIA CUDA, and use {% data variables.product.prodname_cli %} to open your codespace in JupyterLab. + +## Prerequisite + +You have access to {% data variables.product.prodname_github_codespaces %}. For more information, see "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-github-codespaces)." + +## Build a simple image classifier + +We'll use a Jupyter notebook to build a simple image classifier. + +Jupyter notebooks are sets of cells that you can execute one after another. The notebook we'll use includes a number of cells that build an image classifier using [PyTorch](https://pytorch.org/). Each cell is a different phase of that process: download a dataset, set up a neural network, train a model, and then test that model. + +We'll run all of the cells, in sequence, to perform all phases of building the image classifier. When we do this Jupyter saves the output back into the notebook so that you can examine the results. + +### Creating a repository and a codespace + +1. Go to the [github/codespaces-getting-started-ml](https://github.com/github/codespaces-getting-started-ml) template repository and click **Use this template**. +{% data reusables.codespaces.open-codespace-from-template-repo %} + + By default, a codespace for this repository opens in a web-based version of {% data variables.product.prodname_vscode %}. + +### Open the image classifier notebook + +The default container image that's used by {% data variables.product.prodname_github_codespaces %} includes a set of machine learning libraries that are preinstalled in your codespace. For example, Numpy, pandas, SciPy, Matplotlib, seaborn, scikit-learn, TensorFlow, Keras, PyTorch, Requests, and Plotly. For more information about the default image, see "[Introduction to dev containers](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers#using-the-default-dev-container-configuration)" and [the `devcontainers/images` repository](https://github.com/devcontainers/images/tree/main/src/codespaces#github-codespaces-default-linux-universal). + +1. In the {% data variables.product.prodname_vscode_shortname %} editor, close any "Get Started" tabs that are displayed. +1. Open the `image-classifier.ipynb` notebook file. +1. Click the Python kernel link at the top right of the editor. + + ![Screenshot of the Python kernal link](/assets/images/help/codespaces/jupyter-python-kernel-link.png) + +1. In the drop-down menu, choose the kernel in the directory `/opt/python/latest/bin/python`. + + ![Screenshot of the Python kernal drop-down menu](/assets/images/help/codespaces/jupyter-python-kernel-dropdown.png) + +### Build the image classifier + +The image classifier notebook contains all the code you need to download a dataset, train a neural network, and evaluate its performance. + +1. Click **Run All** to execute all of the notebook’s cells. + + ![Screenshot of the Run All button](/assets/images/help/codespaces/jupyter-run-all.png) + +1. Scroll down to view the output of each cell. + + ![Screenshot of Step 3 in the editor](/assets/images/help/codespaces/jupyter-notebook-step3.png) + +## Configure NVIDIA CUDA for your codespace + +Some software, such as TensorFlow, requires you to install NVIDIA CUDA to use your codespace’s GPU. Where this is the case, you can create your own custom configuration, by using a `devcontainer.json` file, and specify that CUDA should be installed. For more information on creating a custom configuration, see "[Introduction to dev containers](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers#creating-a-custom-dev-container-configuration)." + +{% note %} + +**Note**: For full details of the script that's run when you add the `nvidia-cuda` feature, see [the devcontainers/features repository](https://github.com/devcontainers/features/tree/main/src/nvidia-cuda). + +{% endnote %} + +1. Within a codespace, open the `.devcontainer/devcontainer.json` file in the editor. +1. Add a top-level `features` object with the following contents: + + ```json{:copy} + “features”: { + "ghcr.io/devcontainers/features/nvidia-cuda:1": { + "installCudnn": true + } + } + ``` + + For more information about the `features` object, see the [development containers specification](https://containers.dev/implementors/features/#devcontainer-json-properties). + + If you are using the `devcontainer.json` file from the image classifier repository you created for this tutorial, your `devcontainer.json` file will now look like this: + + ``` + { + "customizations": { + "vscode": { + "extensions": [ + "ms-python.python", + "ms-toolsai.jupyter" + ] + } + }, + “features”: { + "ghcr.io/devcontainers/features/nvidia-cuda:1": { + "installCudnn": true + } + } + } + ``` + +1. Save the change. +{% data reusables.codespaces.rebuild-command %} + The codespace container will be rebuilt. This will take several minutes. When the rebuild is complete the codespace is automatically reopened. +1. Commit the change to the repository so that CUDA will be installed in any new codespaces you create from this repository in future. + +## Open your codespace in JupyterLab + +The default container image that's used by {% data variables.product.prodname_github_codespaces %} includes JupyterLab, the web-based Jupyter IDE. You can use {% data variables.product.prodname_cli %} to open your codespace in JupyterLab without having to install anything else on your codespace. + +1. In the terminal, enter the {% data variables.product.prodname_cli %} command `gh cs jupyter`. +1. Choose the codespace you want to open. + + ![Screenshot of opening a codespace from the terminal](/assets/images/help/codespaces/open-codespace-in-jupyter.png) + diff --git a/content/codespaces/developing-in-codespaces/index.md b/content/codespaces/developing-in-codespaces/index.md index e67f1aa1b7a7..c2468004c75c 100644 --- a/content/codespaces/developing-in-codespaces/index.md +++ b/content/codespaces/developing-in-codespaces/index.md @@ -18,6 +18,7 @@ children: - /forwarding-ports-in-your-codespace - /default-environment-variables-for-your-codespace - /connecting-to-a-private-network + - /getting-started-with-github-codespaces-for-machine-learning - /using-github-codespaces-in-visual-studio-code - /using-github-codespaces-with-github-cli --- diff --git a/content/codespaces/getting-started/deep-dive.md b/content/codespaces/getting-started/deep-dive.md index f22981969a98..b4afca5e51ba 100644 --- a/content/codespaces/getting-started/deep-dive.md +++ b/content/codespaces/getting-started/deep-dive.md @@ -73,7 +73,7 @@ As you develop in your codespace, it will save any changes to your files every f ### Closing or stopping your codespace -To stop your codespace you can [use the {% data variables.product.prodname_vscode_command_palette %}](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces#suspending-or-stopping-a-codespace) (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)). If you exit your codespace without running the stop command (for example, closing the browser tab), or if you leave the codespace running without interaction, the codespace and its running processes will continue until a window of inactivity occurs, after which the codespace will stop. By default, the window of inactivity is 30 minutes. +To stop your codespace you can [use the {% data variables.product.prodname_vscode_command_palette %}](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces#suspending-or-stopping-a-codespace) (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)). If you exit your codespace without running the stop command (for example, closing the browser tab), or if you leave the codespace running without interaction, the codespace and its running processes will continue until a window of inactivity occurs, after which the codespace will stop. By default, the window of inactivity is 30 minutes. When you close or stop your codespace, all uncommitted changes are preserved until you connect to the codespace again. diff --git a/content/codespaces/getting-started/quickstart.md b/content/codespaces/getting-started/quickstart.md index a98c560b7b02..de00a18f409d 100644 --- a/content/codespaces/getting-started/quickstart.md +++ b/content/codespaces/getting-started/quickstart.md @@ -25,12 +25,7 @@ For more information on exactly how {% data variables.product.prodname_github_co ## Creating your codespace 1. Navigate to the [template repository](https://github.com/github/haikus-for-codespaces) and select **Use this template**. - -1. Choose an owner for the new repository, enter a repository name, select your preferred privacy setting, and click **Create repository from template**. - -1. Navigate to the main page of the newly created repository. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click **Create codespace on main**. - - ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) +{% data reusables.codespaces.open-codespace-from-template-repo %} ## Running the application diff --git a/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md b/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md index 04b6b16f6553..75aed3dcf398 100644 --- a/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md +++ b/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md @@ -155,9 +155,9 @@ You can add features to your predefined container configuration to customize whi You can add some of the most common features by selecting them when configuring your predefined container. For more information on the available features, see the [script library](https://github.com/microsoft/vscode-dev-containers/tree/main/script-library#scripts) in the `vscode-dev-containers` repository. -1. Access the Command Palette (`Shift + Command + P` / `Ctrl + Shift + P`), then start typing "configure". Select **Codespaces: Configure Devcontainer Features**. +1. Access the Command Palette (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)), then start typing "configure". Select **Codespaces: Configure Devcontainer Features**. - ![The Configure Devcontainer Features command in the command palette](/assets/images/help/codespaces/codespaces-configure-features.png) + ![The Configure Devcontainer Features command in the Command Palette](/assets/images/help/codespaces/codespaces-configure-features.png) 1. Update your feature selections, then click **OK**. @@ -165,7 +165,7 @@ You can add some of the most common features by selecting them when configuring 1. To apply the changes, in the bottom right corner of the screen, click **Rebuild now**. For more information about rebuilding your container, see "[Applying changes to your configuration](#applying-configuration-changes-to-a-codespace)." - !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/rebuild-prompt.png) + !["Codespaces: Rebuild Container" in the Command Palette](/assets/images/help/codespaces/rebuild-prompt.png) ## Creating a custom dev container configuration diff --git a/content/codespaces/troubleshooting/github-codespaces-logs.md b/content/codespaces/troubleshooting/github-codespaces-logs.md index 9e69b8ca68f0..737333eefc98 100644 --- a/content/codespaces/troubleshooting/github-codespaces-logs.md +++ b/content/codespaces/troubleshooting/github-codespaces-logs.md @@ -28,7 +28,7 @@ These logs contain detailed information about the codespace, the container, the {% webui %} 1. If you are using {% data variables.product.prodname_codespaces %} in the browser, ensure that you are connected to the codespace you want to debug. -1. Open the {% data variables.product.prodname_vscode %} Command Palette (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) and type **Export logs**. Select **Codespaces: Export Logs** from the list to download the logs. +1. Open the {% data variables.product.prodname_vscode_command_palette_shortname %} (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)) and type **Export logs**. Select **Codespaces: Export Logs** from the list to download the logs. 1. Define where to save the zip archive of logs then click **Save** (desktop) or click **OK** (web). 1. If you are using {% data variables.product.prodname_codespaces %} in the browser, right-click on the zip archive of logs from the Explorer view and select **Download…** to download them to your local machine. @@ -36,7 +36,7 @@ These logs contain detailed information about the codespace, the container, the {% vscode %} -1. Open the {% data variables.product.prodname_vscode %} Command Palette (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) and type **Export logs**. Select **Codespaces: Export Logs** from the list to download the logs. +1. Open the {% data variables.product.prodname_vscode_command_palette_shortname %} (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)) and type **Export logs**. Select **Codespaces: Export Logs** from the list to download the logs. 1. Define where to save the zip archive of logs then click **Save** (desktop) or click **OK** (web). {% endvscode %} @@ -55,7 +55,7 @@ These logs contain information about the container, dev container, and their con {% webui %} 1. Connect to the codespace you want to debug. -2. Open the {% data variables.product.prodname_vscode_command_palette %} (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) and type **Creation logs**. Select **Codespaces: View Creation Log** from the list to open the `creation.log` file. +2. Open the {% data variables.product.prodname_vscode_command_palette_shortname %} (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)) and type **Creation logs**. Select **Codespaces: View Creation Log** from the list to open the `creation.log` file. If you want to share the log with support, you can copy the text from the creation log into a text editor and save the file locally. @@ -63,7 +63,7 @@ If you want to share the log with support, you can copy the text from the creati {% vscode %} -Open the Command Palette (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) and type **Creation logs**. Select **Codespaces: View Creation Log** from the list to open the `creation.log` file. +Open the {% data variables.product.prodname_vscode_command_palette_shortname %} (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)) and type **Creation logs**. Select **Codespaces: View Creation Log** from the list to open the `creation.log` file. If you want to share the log with support, you can copy the text from the creation log into a text editor and save the file locally. diff --git a/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md b/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md index 1b7b2db9d6df..8bc14670e823 100644 --- a/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md +++ b/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md @@ -1,5 +1,5 @@ --- -title: Troubleshooting creation and deletion of Codespaces +title: Troubleshooting creation and deletion of codespaces intro: 'This article provides troubleshooting steps for common issues you may experience when creating or deleting a codespace, including storage and configuration issues.' product: '{% data reusables.gated-features.codespaces %}' versions: @@ -16,6 +16,8 @@ shortTitle: Creation and deletion ### No access to create a codespace {% data variables.product.prodname_codespaces %} are not available for all repositories. If the "Open with Codespaces" button is missing, {% data variables.product.prodname_github_codespaces %} may not be available for that repository. For more information, see "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces)." +You can't create a codespace for a private repository that is owned by an organization, unless you have write access to the repository or the organization has enabled forking for it. + If you believe your organization has [enabled {% data variables.product.prodname_codespaces %}](/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization#about-enabling-codespaces-for-your-organization), make sure that an organization owner or billing manager has set the spending limit for {% data variables.product.prodname_codespaces %}. For more information, see "[Managing your spending limit for {% data variables.product.prodname_codespaces %}](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces)." ### Codespace does not open when created diff --git a/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md b/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md index d5a3127bb435..94ee61efa034 100644 --- a/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md +++ b/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md @@ -18,7 +18,7 @@ redirect_from: Codespaces are set to stop after 30 minutes without any activity. If you try to interact with a codespace after it has stopped, you may see a `503 service unavailable` error. - If a **Start** button is shown in {% data variables.product.prodname_vscode %} or in your browser window, click **Start** to reconnect to the codespace. -- Reset your codespace by reloading the window. From the [command palette](/codespaces/codespaces-reference/using-the-command-palette-in-codespaces#accessing-the-command-palette) in {% data variables.product.prodname_vscode %}, click **Developer: Reload Window**. +- Reset your codespace by reloading the window. From the [Command Palette](/codespaces/codespaces-reference/using-the-command-palette-in-codespaces#accessing-the-command-palette) in {% data variables.product.prodname_vscode %}, click **Developer: Reload Window**. ## Browser cannot connect diff --git a/content/developers/apps/building-github-apps/authenticating-with-github-apps.md b/content/developers/apps/building-github-apps/authenticating-with-github-apps.md index a31ac9c75de9..e25b98006d25 100644 --- a/content/developers/apps/building-github-apps/authenticating-with-github-apps.md +++ b/content/developers/apps/building-github-apps/authenticating-with-github-apps.md @@ -149,13 +149,19 @@ To authenticate with an installation access token, include it in the Authorizati ```shell $ curl -i \ --H "Authorization: token YOUR_INSTALLATION_ACCESS_TOKEN" \ +-H "Authorization: Bearer YOUR_INSTALLATION_ACCESS_TOKEN" \ -H "Accept: application/vnd.github+json" \ {% data variables.product.api_url_pre %}/installation/repositories ``` `YOUR_INSTALLATION_ACCESS_TOKEN` is the value you must replace. +{% note %} + +**Note:** {% data reusables.getting-started.bearer-vs-token %} + +{% endnote %} + ## Accessing API endpoints as an installation For a list of REST API endpoints that are available for use by {% data variables.product.prodname_github_apps %} using an installation access token, see "[Available Endpoints](/rest/overview/endpoints-available-for-github-apps)." diff --git a/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md b/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md index 389890bfaaa8..050d5d7a514f 100644 --- a/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md +++ b/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md @@ -107,13 +107,13 @@ By default, the response takes the following form. The response parameters `expi The user's access token allows the GitHub App to make requests to the API on behalf of a user. - Authorization: token OAUTH-TOKEN + Authorization: Bearer OAUTH-TOKEN GET {% data variables.product.api_url_code %}/user For example, in curl you can set the Authorization header like this: ```shell -curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre %}/user +curl -H "Authorization: Bearer OAUTH-TOKEN" {% data variables.product.api_url_pre %}/user ``` ## Device flow @@ -132,12 +132,12 @@ The device flow allows you to authorize users for a headless app, such as a CLI Once you have an OAuth token for a user, you can check which installations that user can access. - Authorization: token OAUTH-TOKEN + Authorization: Bearer OAUTH-TOKEN GET /user/installations You can also check which repositories are accessible to a user for an installation. - Authorization: token OAUTH-TOKEN + Authorization: Bearer OAUTH-TOKEN GET /user/installations/:installation_id/repositories More details can be found in: [List app installations accessible to the user access token](/rest/apps#list-app-installations-accessible-to-the-user-access-token) and [List repositories accessible to the user access token](/rest/apps#list-repositories-accessible-to-the-user-access-token). diff --git a/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md b/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md index d0e1dd45920b..52e151947999 100644 --- a/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md +++ b/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md @@ -23,6 +23,8 @@ When an organization has an allow list, third-party applications that connect vi ## Adding an IP address allow list to a {% data variables.product.prodname_github_app %} +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.apps.settings-step %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} diff --git a/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md b/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md index ca89fbc56b21..151c640b90ce 100644 --- a/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md +++ b/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md @@ -47,7 +47,7 @@ Rate limits for {% data variables.product.prodname_github_apps %} and {% data va {% ifversion fpt or ghec %} -{% data variables.product.prodname_github_apps %} that are installed on an organization or a repository within an enterprise on {% data variables.product.product_location %} are subject to a limit of 15,000 requests per hour. +{% data variables.product.prodname_github_apps %} that are installed on an organization within an enterprise on {% data variables.product.product_location %} are subject to a limit of 15,000 requests per hour per organization that has installed the app. {% endif %} diff --git a/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md b/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md index 134182eb65f1..16619daebe73 100644 --- a/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md +++ b/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md @@ -106,13 +106,13 @@ Accept: application/xml The access token allows you to make requests to the API on a behalf of a user. - Authorization: token OAUTH-TOKEN + Authorization: Bearer OAUTH-TOKEN GET {% data variables.product.api_url_code %}/user For example, in curl you can set the Authorization header like this: ```shell -curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre %}/user +curl -H "Authorization: Bearer OAUTH-TOKEN" {% data variables.product.api_url_pre %}/user ``` ## Device flow diff --git a/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md b/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md index b0be653f27f1..e1e253fc5f4b 100644 --- a/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md +++ b/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md @@ -27,7 +27,7 @@ If your {% data variables.product.prodname_oauth_app %} doesn't have access to a Check headers to see what OAuth scopes you have, and what the API action accepts: ```shell -$ curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre %}/users/codertocat -I +$ curl -H "Authorization: Bearer OAUTH-TOKEN" {% data variables.product.api_url_pre %}/users/codertocat -I HTTP/2 200 X-OAuth-Scopes: repo, user X-Accepted-OAuth-Scopes: user diff --git a/content/developers/overview/github-developer-program.md b/content/developers/overview/github-developer-program.md index bd0fb16722ae..b6caacc82fa5 100644 --- a/content/developers/overview/github-developer-program.md +++ b/content/developers/overview/github-developer-program.md @@ -23,9 +23,9 @@ Email partnerships@github.com to re ## Have an integration that works with GitHub? Awesome! We'd love to have you be part of the program. Here’s how you can spread the word:

-* [Let us know about your integration](https://support.github.com/contact?tags=rr-general-technical&form[subject]=New+GitHub+Integration) -* Use the [Octocat or GitHub logo](https://github.com/logos) to identify that your product works with GitHub -* Post a video or a blog on your website about your integration +* [Let us know about your integration](https://support.github.com/contact?tags=rr-general-technical&form[subject]=New+GitHub+Integration). +* Use the [Octocat or GitHub logo](https://github.com/logos) to identify that your product works with GitHub. +* Post a video or a blog on your website about your integration. ## Ready to join the GitHub Developer Program? diff --git a/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md b/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md index df2281c42d4a..4bfb12f6f5b6 100644 --- a/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md +++ b/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md @@ -37,12 +37,12 @@ $ export SECRET_TOKEN=your_token ## Validating payloads from GitHub -When your secret token is set, {% data variables.product.product_name %} uses it to create a hash signature with each payload. This hash signature is included with the headers of each request as `X-Hub-Signature-256`. +When your secret token is set, {% data variables.product.product_name %} uses it to create a hash signature with each payload. This hash signature is included with the headers of each request as `x-hub-signature-256`. {% ifversion fpt or ghes or ghec %} {% note %} -**Note:** For backward-compatibility, we also include the `X-Hub-Signature` header that is generated using the SHA-1 hash function. If possible, we recommend that you use the `X-Hub-Signature-256` header for improved security. The example below demonstrates using the `X-Hub-Signature-256` header. +**Note:** For backward-compatibility, we also include the `x-hub-signature` header that is generated using the SHA-1 hash function. If possible, we recommend that you use the `x-hub-signature-256` header for improved security. The example below demonstrates using the `x-hub-signature-256` header. {% endnote %} {% endif %} diff --git a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-to-github-classroom.md b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-to-github-classroom.md index ca03572759d8..1b80c3756a8d 100644 --- a/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-to-github-classroom.md +++ b/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-to-github-classroom.md @@ -24,23 +24,22 @@ To configure an LMS to connect to {% data variables.product.prodname_classroom % ## Supported LMSes -{% data variables.product.prodname_classroom %} supports import of roster data from LMSes that implement Learning Tools Interoperability (LTI) standards. +{% note %} -- LTI version 1.0 and/or 1.1 -- LTI Names and Roles Provisioning 1.X +**Note:** {% data variables.product.prodname_classroom %} previously supported import of roster data from LMSes that implement Learning Tools Interoperability (LTI) versions 1.0 and 1.1. On June 30, 2022, the Instructional Management System (IMS) Global Learning Consortium [ended support for LTI versions 1.0 and 1.1](https://www.imsglobal.org/lti-security-announcement-and-deprecation-schedule). In the interest of keeping sensitive student information safe and secure, {% data variables.product.company_short %} has temporarily disabled importing roster data from LTI-compliant LMSes.

-Using LTI helps keep your information safe and secure. LTI is an industry-standard protocol and GitHub Classroom's use of LTI is certified by the Instructional Management System (IMS) Global Learning Consortium. For more information, see [Learning Tools Interoperability](https://www.imsglobal.org/activity/learning-tools-interoperability) and [About IMS Global Learning Consortium](http://www.imsglobal.org/aboutims.html) on the IMS Global Learning Consortium website. +Support for the latest version of Learning Tools Interoperability, [LTI 1.3](https://www.imsglobal.org/activity/learning-tools-interoperability), is currently being worked on and will be made available in {% data variables.product.prodname_classroom %} very soon. + +{% endnote %} + +LTI is an industry-standard protocol and GitHub Classroom's use of LTI is certified by the Instructional Management System (IMS) Global Learning Consortium. For more information, see [Learning Tools Interoperability](https://www.imsglobal.org/activity/learning-tools-interoperability) and [About IMS Global Learning Consortium](http://www.imsglobal.org/aboutims.html) on the IMS Global Learning Consortium website. {% data variables.product.company_short %} has tested import of roster data from the following LMSes into {% data variables.product.prodname_classroom %}. -- Canvas - Google Classroom -- Moodle -- Sakai -Currently, {% data variables.product.prodname_classroom %} doesn't support import of roster data from Blackboard or Brightspace. -## Generating configuration credentials for your classroom +## Connecting to Google Classroom {% data reusables.classroom.sign-into-github-classroom %} {% data reusables.classroom.click-classroom-in-list %} @@ -48,90 +47,16 @@ Currently, {% data variables.product.prodname_classroom %} doesn't support impor 1. If your classroom already has a roster, you can either update the roster or delete the roster and create a new roster. - For more information about deleting and creating a roster, see "[Deleting a roster for a classroom](/education/manage-coursework-with-github-classroom/manage-classrooms#deleting-a-roster-for-a-classroom)" and "[Creating a roster for your classroom](/education/manage-coursework-with-github-classroom/manage-classrooms#creating-a-roster-for-your-classroom)." - For more information about updating a roster, see "[Adding students to the roster for your classroom](/education/manage-coursework-with-github-classroom/manage-classrooms#adding-students-to-the-roster-for-your-classroom)." -1. In the list of LMSes, click your LMS. If your LMS is not supported, click **Other LMS**. - ![List of LMSes](/assets/images/help/classroom/classroom-settings-click-lms.png) -1. Read about connecting your LMS, then click **Connect to _LMS_**. -1. Copy the "Consumer Key", "Shared Secret", and "Launch URL" for the connection to the classroom. - ![Copy credentials](/assets/images/help/classroom/classroom-copy-credentials.png) - -## Configuring a generic LMS - -You must configure the privacy settings for your LMS to allow external tools to receive roster information. - -1. Navigate to your LMS. -1. Configure an external tool. -1. Provide the configuration credentials you generated in {% data variables.product.prodname_classroom %}. - - Consumer key - - Shared secret - - Launch URL (sometimes called "tool URL" or similar) - -## Configuring Canvas - -You can configure {% data variables.product.prodname_classroom %} as an external app for Canvas to import roster data into your classroom. For more information about Canvas, see the [Canvas website](https://www.instructure.com/canvas/). - -1. Sign into [Canvas](https://www.instructure.com/canvas/#login). -1. Select the Canvas course to integrate with {% data variables.product.prodname_classroom %}. -1. In the left sidebar, click **Settings**. -1. Click the **Apps** tab. -1. Click **View app configurations**. -1. Click **+App**. -1. Select the **Configuration Type** drop-down menu, and click **By URL**. -1. Paste the configuration credentials from {% data variables.product.prodname_classroom %}. For more information, see "[Generating configuration credentials for your classroom](#generating-configuration-credentials-for-your-classroom)." - - | Field in Canvas app configuration | Value or setting | - | :- | :- | - | **Consumer Key** | Consumer key from {% data variables.product.prodname_classroom %} | - | **Shared Secret** | Shared secret from {% data variables.product.prodname_classroom %} | - | **Allow this tool to access the IMS Names and Role Provisioning Service** | Enabled | - | **Configuration URL** | Launch URL from {% data variables.product.prodname_classroom %} | - - {% note %} - - **Note**: If you don't see a checkbox in Canvas labeled "Allow this tool to access the IMS Names and Role Provisioning Service", then your Canvas administrator must contact Canvas support to enable membership service configuration for your Canvas account. Without enabling this feature, you won't be able to sync the roster from Canvas. For more information, see [How do I contact Canvas Support?](https://community.canvaslms.com/t5/Canvas-Basics-Guide/How-do-I-contact-Canvas-Support/ta-p/389767) on the Canvas website. - - {% endnote %} - -1. Click **Submit**. -1. In the left sidebar, click **Home**. -1. To prompt Canvas to send a confirmation email, in the left sidebar, click **GitHub Classroom**. Follow the instructions in the email to finish linking {% data variables.product.prodname_classroom %}. - -## Configuring Moodle - -You can configure {% data variables.product.prodname_classroom %} as an activity for Moodle to import roster data into your classroom. For more information about Moodle, see the [Moodle website](https://moodle.org). - -You must be using Moodle version 3.0 or greater. - -1. Sign into [Moodle](https://moodle.org/login/). -1. Select the Moodle course to integrate with {% data variables.product.prodname_classroom %}. -1. Click **Turn editing on**. -1. Wherever you'd like {% data variables.product.prodname_classroom %} to be available in Moodle, click **Add an activity or resource**. -1. Choose **External tool** and click **Add**. -1. In the "Activity name" field, type "GitHub Classroom". -1. In the **Preconfigured tool** field, to the right of the drop-down menu, click **+**. -1. Under "External tool configuration", paste the configuration credentials from {% data variables.product.prodname_classroom %}. For more information, see "[Generating configuration credentials for your classroom](#generating-configuration-credentials-for-your-classroom)." - - | Field in Moodle app configuration | Value or setting | - | :- | :- | - | **Tool name** | {% data variables.product.prodname_classroom %} - _YOUR CLASSROOM NAME_

**Note**: You can use any name, but we suggest this value for clarity. | - | **Tool URL** | Launch URL from {% data variables.product.prodname_classroom %} | - | **LTI version** | LTI 1.0/1.1 | - | **Default launch container** | New window | - | **Consumer key** | Consumer key from {% data variables.product.prodname_classroom %} | - | **Shared secret** | Shared secret from {% data variables.product.prodname_classroom %} | - -1. Scroll to and click **Services**. -1. To the right of "IMS LTI Names and Role Provisioning", select the drop-down menu and click **Use this service to retrieve members' information as per privacy settings**. -1. Scroll to and click **Privacy**. -1. To the right of **Share launcher's name with tool** and **Share launcher's email with tool**, select the drop-down menus to click **Always**. -1. At the bottom of the page, click **Save changes**. -1. In the **Preconfigure tool** menu, click **GitHub Classroom - _YOUR CLASSROOM NAME_**. -1. Under "Common module settings", to the right of "Availability", select the drop-down menu and click **Hide from students**. -1. At the bottom of the page, click **Save and return to course**. -1. Navigate to anywhere you chose to display {% data variables.product.prodname_classroom %}, and click the {% data variables.product.prodname_classroom %} activity. - -## Importing a roster from your LMS - -For more information about importing the roster from your LMS into {% data variables.product.prodname_classroom %}, see "[Manage classrooms](/education/manage-coursework-with-github-classroom/manage-classrooms#creating-a-roster-for-your-classroom)." +1. In the list of LMSes, click Google Classroom. + ![Google Classroom](/assets/images/help/classroom/classroom-settings-click-google-classroom.png) +1. Sign in to Google, then select the Classroom to link to. + + +## Connecting to Canvas, Moodle, Sakai, and other LMSes + +Connecting to other LMSes is temporarily unavailable as {% data variables.product.company_short %} updates to Learning Tools Interoperability (LTI) version 1.3. For more information, see "[Supported LMSes](#supported-lmses)." + +In the meantime, you may manually input your roster for your class. For more information about manually importing the roster from your LMS into {% data variables.product.prodname_classroom %}, see "[Manage classrooms](/education/manage-coursework-with-github-classroom/manage-classrooms#creating-a-roster-for-your-classroom)." ## Disconnecting your LMS diff --git a/content/get-started/quickstart/fork-a-repo.md b/content/get-started/quickstart/fork-a-repo.md index 600c30dca484..9d3c9526b65c 100644 --- a/content/get-started/quickstart/fork-a-repo.md +++ b/content/get-started/quickstart/fork-a-repo.md @@ -118,7 +118,7 @@ Right now, you have a fork of the Spoon-Knife repository, but you do not have th > Cloning into `Spoon-Knife`... > remote: Counting objects: 10, done. > remote: Compressing objects: 100% (8/8), done. - > remove: Total 10 (delta 1), reused 10 (delta 1) + > remote: Total 10 (delta 1), reused 10 (delta 1) > Unpacking objects: 100% (10/10), done. ``` diff --git a/content/graphql/guides/migrating-graphql-global-node-ids.md b/content/graphql/guides/migrating-graphql-global-node-ids.md index 34d985e126bc..aa6502c079d6 100644 --- a/content/graphql/guides/migrating-graphql-global-node-ids.md +++ b/content/graphql/guides/migrating-graphql-global-node-ids.md @@ -32,7 +32,7 @@ Here is an example request using cURL: ``` $ curl \ - -H "Authorization: token $GITHUB_TOKEN" \ + -H "Authorization: Bearer $GITHUB_TOKEN" \ -H "X-Github-Next-Global-ID: 1" \ https://api.github.com/graphql \ -d '{ "query": "{ node(id: \"MDQ6VXNlcjM0MDczMDM=\") { id } }" }' diff --git a/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md b/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md index c54635daf379..3e15a0797b36 100644 --- a/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md +++ b/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md @@ -70,7 +70,7 @@ You can find the node ID of an organization project if you know the organization ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"query{organization(login: \"ORGANIZATION\") {projectV2(number: NUMBER){id}}}"}' ``` {% endcurl %} @@ -94,7 +94,7 @@ You can also find the node ID of all projects in your organization. The followin ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"{organization(login: \"ORGANIZATION\") {projectsV2(first: 20) {nodes {id title}}}}"}' ``` {% endcurl %} @@ -125,7 +125,7 @@ You can find the node ID of a user project if you know the project number. Repla ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"query{user(login: \"USER\") {projectV2(number: NUMBER){id}}}"}' ``` {% endcurl %} @@ -149,7 +149,7 @@ You can also find the node ID for all of your projects. The following example wi ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"{user(login: \"USER\") {projectsV2(first: 20) {nodes {id title}}}}"}' ``` {% endcurl %} @@ -180,7 +180,7 @@ The following example will return the ID, name, settings, and configuration for ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2Field { id name } ... on ProjectV2IterationField { id name configuration { iterations { startDate id }}} ... on ProjectV2SingleSelectField { id name options { id name }}}}}}}"}' ``` {% endcurl %} @@ -284,7 +284,7 @@ If you just need the name and ID of a field, and do not need information about i ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2FieldCommon { id name }}}}}}"}' ``` {% endcurl %} @@ -354,7 +354,7 @@ The following example will return the first 20 issues, pull requests, and draft ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { items(first: 20) { nodes{ id fieldValues(first: 8) { nodes{ ... on ProjectV2ItemFieldTextValue { text field { ... on ProjectV2FieldCommon { name }}} ... on ProjectV2ItemFieldDateValue { date field { ... on ProjectV2FieldCommon { name } } } ... on ProjectV2ItemFieldSingleSelectValue { name field { ... on ProjectV2FieldCommon { name }}}}} content{ ... on DraftIssue { title body } ...on Issue { title assignees(first: 10) { nodes{ login }}} ...on PullRequest { title assignees(first: 10) { nodes{ login }}}}}}}}}"}' ``` {% endcurl %} @@ -446,7 +446,7 @@ The following example will add an issue or pull request to your project. Replace ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"mutation {addProjectV2ItemById(input: {projectId: \"PROJECT_ID\" contentId: \"CONTENT_ID\"}) {item {id}}}"}' ``` {% endcurl %} @@ -488,8 +488,8 @@ The following example will add a draft issue to your project. Replace `PROJECT_I ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ - --data '{"query":"mutation {addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) {item {id}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) {projectItem {id}}}"}' ``` {% endcurl %} @@ -498,7 +498,7 @@ curl --request POST \ gh api graphql -f query=' mutation { addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) { - item { + projectItem { id } } @@ -512,7 +512,7 @@ The response will contain the node ID of the newly created draft issue. { "data": { "addProjectV2ItemById": { - "item": { + "projectItem": { "id": "PVTI_lADOANN5s84ACbL0zgBbxFc" } } @@ -528,7 +528,7 @@ The following example will update your project's settings. Replace `PROJECT_ID` ```shell curl --request POST \ --url https://api.github.com/graphql \ ---header 'Authorization: token TOKEN' \ +--header 'Authorization: Bearer TOKEN' \ --data '{"query":"mutation { updateProjectV2(input: { projectId: \"PROJECT_ID\", title: \"Project title\", public: false, readme: \"# Project README\n\nA long description\", shortDescription: \"A short description\"}) { projectV2 { id, title, readme, shortDescription }}}"}' ``` {% endcurl %} @@ -565,7 +565,7 @@ The following example will update the value of a text field for an item. Replace ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { text: "Updated text" }}) { projectV2Item { id }}}"}' ``` {% endcurl %} @@ -619,7 +619,7 @@ The following example will update the value of a single select field for an item ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { singleSelectOptionId: "OPTION_ID" }}) { projectV2Item { id }}}"}' ``` {% endcurl %} @@ -659,7 +659,7 @@ The following example will update the value of an iteration field for an item. ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { singleSelectOptionId: "OPTION_ID" }}) { projectV2Item { id }}}"}' ``` {% endcurl %} @@ -694,7 +694,7 @@ The following example will delete an item from a project. Replace `PROJECT_ID` w ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"mutation {deleteProjectV2Item(input: {projectId: \"PROJECT_ID\" itemId: \"ITEM_ID\"}) {deletedItemId}}"}' ``` {% endcurl %} diff --git a/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md b/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md index 7e46a5395cf2..cfd6821b286c 100644 --- a/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md +++ b/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md @@ -23,7 +23,7 @@ To transfer an open issue to another repository, you must have write access to t {% endnote %} -When you transfer an issue, comments, labels and assignees are retained. The issue's milestones are not retained. This issue will stay on any user-owned or organization-wide project boards and be removed from any repository project boards. For more information, see "[About project boards](/articles/about-project-boards)." +When you transfer an issue, comments and assignees are retained. Labels and milestones are also retained if they're present in the target repository, with labels matching by name and milestones matching by both name and due date. This issue will stay on any user-owned or organization-wide project boards and be removed from any repository project boards. For more information, see "[About project boards](/articles/about-project-boards)." People or teams who are mentioned in the issue will receive a notification letting them know that the issue has been transferred to a new repository. The original URL redirects to the new issue's URL. People who don't have read permissions in the new repository will see a banner letting them know that the issue has been transferred to a new repository that they can't access. diff --git a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md index 7072ee723b05..be572c181610 100644 --- a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md @@ -38,6 +38,8 @@ You can also configure allowed IP addresses for the organizations in an enterpri {% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %} +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} diff --git a/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md b/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md index 36d4f7a49f83..ca48cc9a2a2b 100644 --- a/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md +++ b/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md @@ -1,6 +1,6 @@ --- title: Enabling or disabling GitHub Discussions for an organization -intro: 'You can use {% data variables.product.prodname_discussions %} in a organization as a place for your organization to have conversations that aren''t specific to a single repository within your organization.' +intro: 'You can use {% data variables.product.prodname_discussions %} in an organization as a place for your organization to have conversations that aren''t specific to a single repository within your organization.' permissions: 'Organization owners can enable {% data variables.product.prodname_discussions %} for their organization.' versions: feature: discussions diff --git a/content/packages/index.md b/content/packages/index.md index 7999a46e7fbc..135fbcf6bc3c 100644 --- a/content/packages/index.md +++ b/content/packages/index.md @@ -18,6 +18,7 @@ featuredLinks: guideCards: - '{% ifversion docker-ghcr-enterprise-migration %}/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry{% endif %}' - '{% ifversion fpt or ghec or ghes > 3.4 %}/packages/working-with-a-github-packages-registry/working-with-the-container-registry{% else %}/packages/working-with-a-github-packages-registry/working-with-the-docker-registry{% endif %}' + - '{% ifversion packages-npm-v2 %}/packages/working-with-a-github-packages-registry/working-with-the-npm-registry{% endif %}' - /packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry changelog: label: packages diff --git a/content/packages/learn-github-packages/about-permissions-for-github-packages.md b/content/packages/learn-github-packages/about-permissions-for-github-packages.md index 7b27d7693674..18235d4ef4ce 100644 --- a/content/packages/learn-github-packages/about-permissions-for-github-packages.md +++ b/content/packages/learn-github-packages/about-permissions-for-github-packages.md @@ -18,20 +18,22 @@ The permissions for packages are either repository-scoped or user/organization-s A repository-scoped package inherits the permissions and visibility of the repository that owns the package. You can find a package scoped to a repository by going to the main page of the repository and clicking the **Packages** link to the right of the page. {% ifversion fpt or ghec %}For more information, see "[Connecting a repository to a package](/packages/learn-github-packages/connecting-a-repository-to-a-package)."{% endif %} -The {% data variables.product.prodname_registry %} registries below use repository-scoped permissions: +The {% data variables.product.prodname_registry %} registries below **only** use repository-scoped permissions: {% ifversion not fpt or ghec %}- Docker registry (`docker.pkg.github.com`){% endif %} - - npm registry + {% ifversion packages-npm-v2 %}{% else %}- npm registry{% endif %} - RubyGems registry - Apache Maven registry - NuGet registry +{% ifversion packages-npm-v2 %}For {% data variables.product.prodname_ghcr_and_npm_registry %}, you can choose to allow packages to be scoped to a user, an organization, or linked to a repository.{% endif %} + {% ifversion fpt or ghec %} ## Granular permissions for user/organization-scoped packages Packages with granular permissions are scoped to a personal user or organization account. You can change the access control and visibility of the package separately from a repository that is connected (or linked) to a package. -Currently, only the {% data variables.product.prodname_container_registry %} offers granular permissions for your container image packages. +Currently, the {% data variables.product.prodname_ghcr_and_npm_registry %} offer granular permissions for your container image packages. ## Visibility and access permissions for container images diff --git a/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md b/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md index 9105c5e7bc70..3c340349607f 100644 --- a/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md +++ b/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md @@ -15,7 +15,7 @@ shortTitle: Access control & visibility Packages with granular permissions are scoped to a personal user or organization account. You can change the access control and visibility of a package separately from the repository that it is connected (or linked) to. -Currently, you can only use granular permissions with the {% data variables.product.prodname_container_registry %}. Granular permissions are not supported in our other package registries, such as the npm registry.{% ifversion docker-ghcr-enterprise-migration %} For more information about migration to the {% data variables.product.prodname_container_registry %}, see "[Migrating to the {% data variables.product.prodname_container_registry %} from the Docker registry](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)."{% endif %} +Currently, you can only use granular permissions with the {% data variables.product.prodname_ghcr_and_npm_registry %}. Granular permissions are not supported in our other package registries, such as the RubyGems registry.{% ifversion docker-ghcr-enterprise-migration %} For more information about migration to the {% data variables.product.prodname_container_registry %}, see "[Migrating to the {% data variables.product.prodname_container_registry %} from the Docker registry](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)."{% endif %} For more information about permissions for repository-scoped packages, packages-related scopes for PATs, or managing permissions for your actions workflows, see "[About permissions for GitHub Packages](/packages/learn-github-packages/about-permissions-for-github-packages)." @@ -105,7 +105,7 @@ To further customize access to your container image, see "[Configuring access to {% ifversion fpt or ghec %} ## Ensuring {% data variables.product.prodname_codespaces %} access to your package -By default, a codespace can seamlessly access certain packages in the {% data variables.product.prodname_dotcom %} Container Registry, such as those published in the same repository with the **Inherit access** option selected. For more information on which access is automatically configured, see "[Accessing images stored in {% data variables.product.prodname_dotcom %} Container Registry](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry#accessing-images-stored-in-github-container-registry)." +By default, a codespace can seamlessly access certain packages in the {% data variables.product.prodname_ghcr_and_npm_registry %}, such as those published in the same repository with the **Inherit access** option selected. For more information on which access is automatically configured, see "[Allowing your codespace to access a private image registry](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry#accessing-images-stored-in-container-registry-and-npm-registry)." Otherwise, to ensure that a codespace has access to your package, you must grant access to the repository where the codespace is being launched. diff --git a/content/packages/learn-github-packages/deleting-and-restoring-a-package.md b/content/packages/learn-github-packages/deleting-and-restoring-a-package.md index d4e95b815915..456eca256555 100644 --- a/content/packages/learn-github-packages/deleting-and-restoring-a-package.md +++ b/content/packages/learn-github-packages/deleting-and-restoring-a-package.md @@ -23,12 +23,12 @@ On {% data variables.product.prodname_dotcom %} if you have the required access, - an entire private package - an entire public package, if there's not more than 5000 downloads of any version of the package - a specific version of a private package -- a specific version of a public package, if the package version doesn't have more than 5000 downloads +- a specific version of a public package, if the package version doesn't have more than 5,000 downloads {% note %} **Note:** -- You cannot delete a public package if any version of the package has more than 5000 downloads. In this scenario, contact [GitHub support](https://support.github.com/contact?tags=docs-packages) for further assistance. +- You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact [GitHub support](https://support.github.com/contact?tags=docs-packages) for further assistance. - When deleting public packages, be aware that you may break projects that depend on your package. {% endnote %} @@ -46,7 +46,7 @@ You can use the REST API to manage your packages. For more information, see the {% endif %} -For packages that inherit their permissions and access from repositories, you can use GraphQL to delete a specific package version.{% ifversion fpt or ghec %} The {% data variables.product.prodname_registry %} GraphQL API does not support containers or Docker images that use the package namespace `https://ghcr.io/OWNER/PACKAGE-NAME`.{% endif %} For more information about GraphQL support, see "[Deleting a version of a repository-scoped package with GraphQL](#deleting-a-version-of-a-repository-scoped-package-with-graphql)." +For packages that inherit their permissions and access from repositories, you can use GraphQL to delete a specific package version.{% data reusables.package_registry.no-graphql-to-delete-packages %} For more information about GraphQL support, see "[Deleting a version of a repository-scoped package with GraphQL](#deleting-a-version-of-a-repository-scoped-package-with-graphql)." {% endif %} @@ -54,18 +54,19 @@ For packages that inherit their permissions and access from repositories, you ca For packages that inherit their access permissions from repositories, you can delete a package if you have admin permissions to the repository. -Repository-scoped packages on {% data variables.product.prodname_registry %} include these packages: -- npm -- RubyGems -- maven -- Gradle -- NuGet -{% ifversion not fpt or ghec %}- Docker images at `docker.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`{% endif %} +The {% data variables.product.prodname_registry %} registries below **only** use repository-scoped permissions: + + {% ifversion not fpt or ghec %}- Docker images at `docker.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`{% endif %} + {% ifversion packages-npm-v2 %}{% else %}- npm{% endif %} + - RubyGems registry + - Apache Maven registry + - NuGet registry + +{% ifversion packages-npm-v2 %}For {% data variables.product.prodname_ghcr_and_npm_registry %}, you can choose to allow packages to be scoped to a user, an organization, or linked to a repository.{% endif %} {% ifversion fpt or ghec %} -To delete a package that has granular permissions separate from a repository, such as container images stored at `https://ghcr.io/OWNER/PACKAGE-NAME`, you must have admin access to the package. -For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)." +To delete a package that has granular permissions separate from a repository, such as container images stored at `https://ghcr.io/OWNER/PACKAGE-NAME` or `https://npm.pkg.github.com/OWNER/PACKAGE-NAME`, you must have admin access to the package. For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)." {% endif %} @@ -89,9 +90,7 @@ To delete a version of a repository-scoped package, you must have admin permissi For packages that inherit their permissions and access from repositories, you can use the GraphQL to delete a specific package version. -{% ifversion fpt or ghec %} -For containers or Docker images at `ghcr.io`, GraphQL is not supported but you can use the REST API. For more information, see the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." -{% endif %} +{% data reusables.package_registry.no-graphql-to-delete-packages %}{% ifversion fpt or ghec %} You can however use the REST API. For more information, see the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)."{% endif %} Use the `deletePackageVersion` mutation in the GraphQL API. You must use a token with the `read:packages`, `delete:packages`, and `repo` scopes. For more information about tokens, see "[About {% data variables.product.prodname_registry %}](/packages/publishing-and-managing-packages/about-github-packages#authenticating-to-github-packages)." diff --git a/content/packages/learn-github-packages/introduction-to-github-packages.md b/content/packages/learn-github-packages/introduction-to-github-packages.md index fc5090006ea3..5450ffcff9f3 100644 --- a/content/packages/learn-github-packages/introduction-to-github-packages.md +++ b/content/packages/learn-github-packages/introduction-to-github-packages.md @@ -51,7 +51,7 @@ For more information about the configuration of {% data variables.product.prodna | | | |--------------------|--------------------| -| Permissions | {% ifversion fpt or ghec %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_container_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted.

For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} | +| Permissions | {% ifversion fpt or ghec %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_ghcr_and_npm_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted.

For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} | | Visibility | {% data reusables.package_registry.public-or-private-packages %} | For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)." @@ -101,7 +101,9 @@ For more information about Docker and the {% data variables.product.prodname_con ## Managing packages {% ifversion fpt or ghec %} -You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. For more information, see the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." +You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." + +{% data reusables.package_registry.no-graphql-to-delete-packages %} {% endif %} {% ifversion ghes %} @@ -112,7 +114,9 @@ You can delete a private or public package in the {% data variables.product.prod You can delete a version of a package in the {% data variables.product.product_name %} user interface or using the GraphQL API. {% endif %} -When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and "[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." +When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. + +For more information, see {% ifversion ghes or ghae %}"[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and {% endif %}"[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." You can configure webhooks to subscribe to package-related events, such as when a package is published or updated. For more information, see the "[`package` webhook event](/webhooks/event-payloads/#package)." diff --git a/content/packages/learn-github-packages/viewing-packages.md b/content/packages/learn-github-packages/viewing-packages.md index 47234169426f..4c67fda41ee2 100644 --- a/content/packages/learn-github-packages/viewing-packages.md +++ b/content/packages/learn-github-packages/viewing-packages.md @@ -21,17 +21,17 @@ versions: ## About package views -Your ability to view a package depends on several factors. By default, you can view all packages you have published. +Your ability to view a package depends on several factors. By default, you can view all packages you have published. -Repository-scoped packages inherit their permissions and visibility from the repository that owns the package. The registries below use this type of permissions:{% ifversion not fpt or ghec %} +Repository-scoped packages inherit their permissions and visibility from the repository that owns the package. The registries below **only** use this type of permissions:{% ifversion not fpt or ghec %} - Docker registry (`docker.pkg.github.com`){% endif %} -- npm registry +{% ifversion packages-npm-v2 %}{% else %}- npm registry{% endif %} - RubyGems registry - Apache Maven registry - NuGet registry {% ifversion fpt or ghec %} -The Container registry offers you the option of granular permissions and visibility settings that can be customized for each package owned by a personal user or organization account. You can choose to use granular permissions or connect the package to a repository and inherit it's permissions. For more information, see "[Connecting a repository to a package](/packages/learn-github-packages/connecting-a-repository-to-a-package)." +The {% data variables.product.prodname_ghcr_and_npm_registry %} offer you the option of granular permissions and visibility settings that can be customized for each package owned by a personal user or organization account. You can choose to use granular permissions or connect the package to a repository and inherit it's permissions. For more information, see "[Connecting a repository to a package](/packages/learn-github-packages/connecting-a-repository-to-a-package)." {% endif %} For more information, see "[About permissions for GitHub Packages](/packages/learn-github-packages/about-permissions-for-github-packages){% ifversion fpt or ghec %}" and "[Configuring a package's access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility){% endif %}." diff --git a/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md b/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md index abf40d843570..6b3f8fc7cddc 100644 --- a/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md +++ b/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md @@ -24,9 +24,9 @@ shortTitle: Publish & install with Actions You can extend the CI and CD capabilities of your repository by publishing or installing packages as part of your workflow. {% ifversion fpt or ghec %} -### Authenticating to the {% data variables.product.prodname_container_registry %} +### Authenticating to the {% data variables.product.prodname_ghcr_and_npm_registry %} -{% data reusables.package_registry.authenticate_with_pat_for_container_registry %} +{% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} {% endif %} @@ -40,7 +40,7 @@ You can reference the `GITHUB_TOKEN` in your workflow file using the {% raw %}`{ {% note %} -**Note:** Repository-owned packages include RubyGems, npm, Apache Maven, NuGet, {% ifversion fpt or ghec %}and Gradle. {% else %}Gradle, and Docker packages that use the package namespace `docker.pkg.github.com`.{% endif %} +**Note:** Some registries, such as RubyGems, {% ifversion packages-npm-v2 %}{% else %}npm, {% endif %}Apache Maven, NuGet, {% ifversion fpt or ghec %}and Gradle{% else %}Gradle, and Docker packages that use the package namespace `docker.pkg.github.com`{% endif %}, only allow repository-owned packages. With {% data variables.product.prodname_ghcr_and_npm_registry_full %} you can choose to allow packages to be owned by a user, an organization, or linked to a repository. {% endnote %} @@ -49,11 +49,11 @@ When you enable GitHub Actions, GitHub installs a GitHub App on your repository. {% data variables.product.prodname_registry %} allows you to push and pull packages through the `GITHUB_TOKEN` available to a {% data variables.product.prodname_actions %} workflow. {% ifversion fpt or ghec %} -## About permissions and package access for {% data variables.product.prodname_container_registry %} +## About permissions and package access for {% data variables.product.prodname_ghcr_and_npm_registry %} -The {% data variables.product.prodname_container_registry %} (`ghcr.io`) allows users to create and administer containers as free-standing resources at the organization level. Containers can be owned by an organization or personal account and you can customize access to each of your containers separately from repository permissions. +The {% data variables.product.prodname_ghcr_and_npm_registry_full %} allows users to create and administer packages as free-standing resources at the organization level. Packages can be owned by an organization or personal account and you can customize access to each of your packages separately from repository permissions. -All workflows accessing the {% data variables.product.prodname_container_registry %} should use the `GITHUB_TOKEN` instead of a personal access token. For more information about security best practices, see "[Security hardening for GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)." +All workflows accessing the {% data variables.product.prodname_ghcr_and_npm_registry %} should use the `GITHUB_TOKEN` instead of a personal access token. For more information about security best practices, see "[Security hardening for GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)." ## Default permissions and access settings for containers modified through workflows @@ -484,9 +484,9 @@ Installing packages hosted by {% data variables.product.prodname_registry %} thr {% data reusables.package_registry.actions-configuration %} {% ifversion fpt or ghec %} -## Upgrading a workflow that accesses `ghcr.io` +## Upgrading a workflow that accesses a registry using a PAT -The {% data variables.product.prodname_container_registry %} supports the `GITHUB_TOKEN` for easy and secure authentication in your workflows. If your workflow is using a personal access token (PAT) to authenticate to `ghcr.io`, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. +The {% data variables.product.prodname_ghcr_and_npm_registry %} support the `GITHUB_TOKEN` for easy and secure authentication in your workflows. If your workflow is using a personal access token (PAT) to authenticate to the registry, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. For more information about the `GITHUB_TOKEN`, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)." @@ -504,9 +504,9 @@ Using the `GITHUB_TOKEN` instead of a PAT, which includes the `repo` scope, incr {% endnote %} 1. Optionally, using the "role" drop-down menu, select the default access level that you'd like the repository to have to your container image. ![Permission access levels to give to repositories](/assets/images/help/package-registry/repository-permission-options-for-package-access-through-actions.png) -1. Open your workflow file. On the line where you log in to `ghcr.io`, replace your PAT with {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. +1. Open your workflow file. On the line where you log in to the registry, replace your PAT with {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. -For example, this workflow publishes a Docker image using {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} to authenticate. +For example, this workflow publishes a Docker image to the {% data variables.product.prodname_container_registry %} and uses {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} to authenticate. ```yaml{:copy} name: Demo Push diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md index 02708a404d0d..98ac905c0ad4 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md @@ -42,7 +42,9 @@ When installing or publishing a Docker image, the {% data variables.product.prod ## Authenticating to the {% data variables.product.prodname_container_registry %} -{% data reusables.package_registry.authenticate_with_pat_for_container_registry %} +{% ifversion fpt or ghec or ghes > 3.4 %} +To authenticate to the {% data variables.product.prodname_container_registry %} (`ghcr.io`) within a {% data variables.product.prodname_actions %} workflow, use the `GITHUB_TOKEN` for the best security and experience. {% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} +{% endif %} {% ifversion ghes %}Ensure that you replace `HOSTNAME` with {% data variables.product.product_location_enterprise %} hostname or IP address in the examples below.{% endif %} diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md index 993e933de3bb..8007cd2b6f96 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md @@ -21,6 +21,8 @@ shortTitle: npm registry {% data reusables.package_registry.admins-can-configure-package-types %} +{% ifversion packages-npm-v2 %} +{% else %} ## Limits for published npm versions If you publish over 1,000 npm package versions to {% data variables.product.prodname_registry %}, you may see performance issues and timeouts occur during usage. @@ -28,12 +30,17 @@ If you publish over 1,000 npm package versions to {% data variables.product.prod In the future, to improve performance of the service, you won't be able to publish more than 1,000 versions of a package on {% data variables.product.prodname_dotcom %}. Any versions published before hitting this limit will still be readable. If you reach this limit, consider deleting package versions or contact Support for help. When this limit is enforced, our documentation will be updated with a way to work around this limit. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" or "[Contacting Support](/packages/learn-github-packages/about-github-packages#contacting-support)." +{% endif %} ## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} -{% data reusables.package_registry.authenticate-packages-github-token %} +{% ifversion packages-npm-v2 %} +{% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} + +You can also choose to give access permissions to packages independently for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_actions %}. For more information, see "[Ensuring Codespaces access to your package](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-codespaces-access-to-your-package) and [Ensuring workflow access to your package](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-workflow-access-to-your-package)." +{% endif %} ### Authenticating with a personal access token @@ -94,12 +101,24 @@ $ npm login --scope=@OWNER --registry=https://HOSTNAME/_regist {% endnote %} +{% ifversion packages-npm-v2 %} +The {% data variables.product.prodname_registry %} registry stores npm packages within your organization or personal account, and allows you to associate a package with a repository. You can choose whether to inherit permissions from a repository, or set granular permissions independently of a repository. +{% endif %} + By default, {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the name field of the *package.json* file. For example, you would publish a package named `@my-org/test` to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. If you're running [npm v8.5.3](https://github.com/npm/cli/releases/tag/v8.5.3) or later, you can add a summary for the package listing page by including a *README.md* file in your package directory. For more information, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" and "[How to create Node.js Modules](https://docs.npmjs.com/getting-started/creating-node-modules)" in the npm documentation. You can publish multiple packages to the same {% data variables.product.prodname_dotcom %} repository by including a `URL` field in the *package.json* file. For more information, see "[Publishing multiple packages to the same repository](#publishing-multiple-packages-to-the-same-repository)." +{% ifversion fpt or ghec %} +When a package is published, it isn't automatically linked to a repository. You can however choose to link your published package to a repository using the user interface or command line. For more information, see "[Connecting a repository to a package](/packages/learn-github-packages/connecting-a-repository-to-a-package)." +{% endif %} + You can set up the scope mapping for your project using either a local *.npmrc* file in the project or using the `publishConfig` option in the *package.json*. {% data variables.product.prodname_registry %} only supports scoped npm packages. Scoped packages have names with the format of `@owner/name`. Scoped packages always begin with an `@` symbol. You may need to update the name in your *package.json* to use the scoped name. For example, `"name": "@codertocat/hello-world-npm"`. +{% ifversion packages-npm-v2 %} +When you first publish a package, the default visibility is private. When a package is linked to repository, the package visibility is dependent on the repository's visibility. To change the visibility or set access permissions, see "[Configuring a package's access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." +{% endif %} + {% data reusables.package_registry.viewing-packages %} ### Publishing a package using a local *.npmrc* file diff --git a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md index b844e2251b6e..05e0b384b9e5 100644 --- a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md +++ b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md @@ -47,7 +47,7 @@ To set up a `www` or custom subdomain, such as `www.example.com` or `blog.exampl {% data reusables.pages.sidebar-pages %} 4. Under "Custom domain", type your custom domain, then click **Save**. If you are publishing your site from a branch, this will create a commit that adds a `CNAME` file to the root of your source branch. If you are publishing your site with a custom {% data variables.product.prodname_actions %} workflow , no `CNAME` file is created. For more information about your publishing source, see "[Configuring a publishing source for your GitHub Pages site](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." ![Save custom domain button](/assets/images/help/pages/save-custom-subdomain.png) -5. Navigate to your DNS provider and create a `CNAME` record that points your subdomain to the default domain for your site. For example, if you want to use the subdomain `www.example.com` for your user site, create a `CNAME` record that points `www.example.com` to `.github.io`. If you want to use the subdomain `www.anotherexample.com` for your organization site, create a `CNAME` record that points `www.anotherexample.com` to `.github.io`. The `CNAME` record should always point to `.github.io` or `.github.io`, excluding the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} +5. Navigate to your DNS provider and create a `CNAME` record that points your subdomain to the default domain for your site. For example, if you want to use the subdomain `www.example.com` for your user site, create a `CNAME` record that points `www.example.com` to `.github.io`. If you want to use the subdomain `another.example.com` for your organization site, create a `CNAME` record that points `another.example.com` to `.github.io`. The `CNAME` record should always point to `.github.io` or `.github.io`, excluding the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} {% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %} {% data reusables.command_line.open_the_multi_os_terminal %} diff --git a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md index 8292f2f1bc45..82b840cc6e43 100644 --- a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md @@ -17,7 +17,7 @@ shortTitle: Merge PR automatically --- ## About auto-merge -If you enable auto-merge for a pull request, the pull request will merge automatically when all required reviews are met and status checks have passed. Auto-merge prevents you from waiting around for requirements to be met, so you can move on to other tasks. +If you enable auto-merge for a pull request, the pull request will merge automatically when all required reviews are met and all required status checks have passed. Auto-merge prevents you from waiting around for requirements to be met, so you can move on to other tasks. Before you can use auto-merge with a pull request, auto-merge must be enabled for the repository. For more information, see "[Managing auto-merge for pull requests in your repository](/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository)." diff --git a/content/rest/apps/installations.md b/content/rest/apps/installations.md index 52384aab04ca..3f06ce80d640 100644 --- a/content/rest/apps/installations.md +++ b/content/rest/apps/installations.md @@ -17,4 +17,4 @@ versions: An _installation_ refers to any user or organization account that has installed the app. For information on how to authenticate as an installation and limit access to specific repositories, see "[Authenticating as an installation](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)." -To list all GitHub App installations for an organization, see "[List app installations for an organization](/rest/reference/orgs#list-app-installations-for-an-organization)." +To list all GitHub App installations for an organization, see "[List app installations for an organization](/rest/orgs/orgs#list-app-installations-for-an-organization)." diff --git a/content/rest/guides/getting-started-with-the-checks-api.md b/content/rest/guides/getting-started-with-the-checks-api.md index 2c60bf90f864..7388ae96bbd6 100644 --- a/content/rest/guides/getting-started-with-the-checks-api.md +++ b/content/rest/guides/getting-started-with-the-checks-api.md @@ -41,7 +41,7 @@ A check run is an individual test that is part of a check suite. Each run includ ![Check runs workflow](/assets/images/check_runs.png) -If a check run is in a incomplete state for more than 14 days, then the check run's `conclusion` becomes `stale` and appears on {% data variables.product.prodname_dotcom %} as stale with {% octicon "issue-reopened" aria-label="The issue-reopened icon" %}. Only {% data variables.product.prodname_dotcom %} can mark check runs as `stale`. For more information about possible conclusions of a check run, see the [`conclusion` parameter](/rest/reference/checks#create-a-check-run--parameters). +If a check run is in an incomplete state for more than 14 days, then the check run's `conclusion` becomes `stale` and appears on {% data variables.product.prodname_dotcom %} as stale with {% octicon "issue-reopened" aria-label="The issue-reopened icon" %}. Only {% data variables.product.prodname_dotcom %} can mark check runs as `stale`. For more information about possible conclusions of a check run, see the [`conclusion` parameter](/rest/reference/checks#create-a-check-run--parameters). As soon as you receive the [`check_suite`](/webhooks/event-payloads/#check_suite) webhook, you can create the check run, even if the check is not complete. You can update the `status` of the check run as it completes with the values `queued`, `in_progress`, or `completed`, and you can update the `output` as more details become available. A check run can contain timestamps, a link to more details on your external site, detailed annotations for specific lines of code, and information about the analysis performed. diff --git a/content/rest/guides/getting-started-with-the-rest-api.md b/content/rest/guides/getting-started-with-the-rest-api.md index dd9545f30b92..8c54d89f60fc 100644 --- a/content/rest/guides/getting-started-with-the-rest-api.md +++ b/content/rest/guides/getting-started-with-the-rest-api.md @@ -166,7 +166,7 @@ curl --request GET \ {% note %} -**Note:** In most cases, you can use `Authorization: Bearer` or `Authorization: token`. JSON web tokens (JWTs) will only work with `Authorization: Bearer`. +**Note:** {% data reusables.getting-started.bearer-vs-token %} {% endnote %} diff --git a/content/rest/overview/other-authentication-methods.md b/content/rest/overview/other-authentication-methods.md index b75ab9852500..d8147fdb5d4f 100644 --- a/content/rest/overview/other-authentication-methods.md +++ b/content/rest/overview/other-authentication-methods.md @@ -86,10 +86,16 @@ If you have two-factor authentication enabled, make sure you understand how to [ {% endnote %} +{% note %} + +**Note:** {% data reusables.getting-started.bearer-vs-token %} + +{% endnote %} + If you're using the API to access an organization that enforces [SAML SSO][saml-sso] for authentication, you'll need to create a personal access token (PAT) and [authorize the token][allowlist] for that organization. Visit the URL specified in `X-GitHub-SSO` to authorize the token for the organization. ```shell -$ curl -v -H "Authorization: token TOKEN" {% data variables.product.api_url_pre %}/repos/octodocs-test/test +$ curl -v -H "Authorization: Bearer TOKEN" {% data variables.product.api_url_pre %}/repos/octodocs-test/test > X-GitHub-SSO: required; url=https://github.com/orgs/octodocs-test/sso?authorization_request=AZSCKtL4U8yX1H3sCQIVnVgmjmon5fWxks5YrqhJgah0b2tlbl9pZM4EuMz4 { @@ -101,7 +107,7 @@ $ curl -v -H "Authorization: token TOKEN" {% data variables.product.api When requesting data that could come from multiple organizations (for example, [requesting a list of issues created by the user][user-issues]), the `X-GitHub-SSO` header indicates which organizations require you to authorize your personal access token: ```shell -$ curl -v -H "Authorization: token TOKEN" {% data variables.product.api_url_pre %}/user/issues +$ curl -v -H "Authorization: Bearer TOKEN" {% data variables.product.api_url_pre %}/user/issues > X-GitHub-SSO: partial-results; organizations=21955855,20582480 ``` diff --git a/content/rest/overview/resources-in-the-rest-api.md b/content/rest/overview/resources-in-the-rest-api.md index 19c7f3d34e50..033f0ccd7897 100644 --- a/content/rest/overview/resources-in-the-rest-api.md +++ b/content/rest/overview/resources-in-the-rest-api.md @@ -91,7 +91,7 @@ $ curl -u "username" {% data variables.product.api_url_pre %} ### OAuth2 token (sent in a header) ```shell -$ curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre %} +$ curl -H "Authorization: Bearer OAUTH-TOKEN" {% data variables.product.api_url_pre %} ``` {% note %} @@ -100,6 +100,12 @@ Note: GitHub recommends sending OAuth tokens using the Authorization header. {% endnote %} +{% note %} + +**Note:** {% data reusables.getting-started.bearer-vs-token %} + +{% endnote %} + Read [more about OAuth2](/apps/building-oauth-apps/). Note that OAuth2 tokens can be acquired using the [web application flow](/developers/apps/authorizing-oauth-apps#web-application-flow) for production applications. {% ifversion fpt or ghes or ghec %} diff --git a/content/rest/overview/troubleshooting.md b/content/rest/overview/troubleshooting.md index e7394d5a9c7d..72a862387a6c 100644 --- a/content/rest/overview/troubleshooting.md +++ b/content/rest/overview/troubleshooting.md @@ -55,13 +55,13 @@ curl -u my_user:my_password https://api.github.com/user/repos Instead, use a [personal access token](/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) when testing endpoints or doing local development: ```bash -curl -H 'Authorization: token my_access_token' https://api.github.com/user/repos +curl -H 'Authorization: Bearer my_access_token' https://api.github.com/user/repos ``` For OAuth Apps, you should use the [web application flow](/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to generate an OAuth token to use in the API call's header: ```bash -curl -H 'Authorization: token my-oauth-token' https://api.github.com/user/repos +curl -H 'Authorization: Bearer my-oauth-token' https://api.github.com/user/repos ``` ## Timeouts diff --git a/content/rest/quickstart.md b/content/rest/quickstart.md index b8bf64cd3255..7c56fcf40206 100644 --- a/content/rest/quickstart.md +++ b/content/rest/quickstart.md @@ -284,7 +284,7 @@ jobs: {% note %} - **Note:** In most cases, you can use `Authorization: Bearer` or `Authorization: token`. JSON web tokens (JWTs) only work with `Authorization: Bearer`. + **Note:** {% data reusables.getting-started.bearer-vs-token %} {% endnote %} diff --git a/content/rest/teams/external-groups.md b/content/rest/teams/external-groups.md index 2ac2295d45d6..fd5644a84b0c 100644 --- a/content/rest/teams/external-groups.md +++ b/content/rest/teams/external-groups.md @@ -19,7 +19,7 @@ To use this API, the authenticated user must be a team maintainer or an owner of **Notes:** -- The external groups API is only available for organizations that are part of a enterprise using {% data variables.product.prodname_emus %}. For more information, see "[About Enterprise Managed Users](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)." +- The external groups API is only available for organizations that are part of an enterprise using {% data variables.product.prodname_emus %}. For more information, see "[About Enterprise Managed Users](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)." - If your organization uses team synchronization, you can use the Team Synchronization API. For more information, see "[Team synchronization API](#team-synchronization)." {% endnote %} diff --git a/content/rest/users/index.md b/content/rest/users/index.md index 326247f9613c..9fee33defb7a 100644 --- a/content/rest/users/index.md +++ b/content/rest/users/index.md @@ -19,5 +19,6 @@ children: - /followers - /gpg-keys - /keys + - /ssh-signing-keys --- diff --git a/content/rest/users/ssh-signing-keys.md b/content/rest/users/ssh-signing-keys.md new file mode 100644 index 000000000000..33f57a42788a --- /dev/null +++ b/content/rest/users/ssh-signing-keys.md @@ -0,0 +1,13 @@ +--- +title: SSH signing keys +intro: '' +versions: + fpt: '*' + ghes: '>=3.7' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + diff --git a/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md b/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md index c615e7b850b8..6a879606ec02 100644 --- a/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md +++ b/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md @@ -21,9 +21,9 @@ When you use GitHub, you may be given access to lots of additional products and By using the Additional Products and Features, you also agree to the applicable GitHub Terms for Additional Products and Features listed below. A violation of these GitHub Terms for Additional Products and Features is a violation of the Agreement. Capitalized terms not defined here have the meaning given in the Agreement. **For Enterprise users** -- **GitHub Enterprise Cloud** users may have access to the following Additional Products and Features: Actions, Advanced Security, Advisory Database, Codespaces, Dependabot Preview, GitHub Enterprise Importer, Learning Lab, Packages, and Pages. +- **GitHub Enterprise Cloud** users may have access to the following Additional Products and Features: Actions, Advanced Security, Advisory Database, Codespaces, Dependabot Preview, GitHub Enterprise Importer, Packages, and Pages. -- **GitHub Enterprise Server** users may have access to the following Additional Products and Features: Actions, Advanced Security, Advisory Database, Connect, Dependabot Preview, GitHub Enterprise Importer, Learning Lab, Packages, Pages, and SQL Server Images. +- **GitHub Enterprise Server** users may have access to the following Additional Products and Features: Actions, Advanced Security, Advisory Database, Connect, Dependabot Preview, GitHub Enterprise Importer, Packages, Pages, and SQL Server Images. - **GitHub AE** users may have access to the following Additional Products and Features: Actions, Advanced Security, Advisory Database, Connect, Dependabot Preview, GitHub Enterprise Importer, Packages and Pages. @@ -106,19 +106,6 @@ GitHub Copilot (i) may, depending on your preferred telemetry settings, collect ## GitHub Enterprise Importer Importer is a framework for exporting data from other sources to be imported to the GitHub platform. Importer is provided “AS-IS”. -## Learning Lab -GitHub Learning Lab offers free interactive courses that are built into GitHub with instant automated feedback and help. - -*Course Materials.* GitHub owns course materials that it provides and grants you a worldwide, non-exclusive, limited-term, non-transferable, royalty-free license to copy, maintain, use and run such course materials for your internal business purposes associated with Learning Lab use. - -Open source license terms may apply to portions of source code provided in the course materials. - -You own course materials that you create and grant GitHub a worldwide, non-exclusive, perpetual, non-transferable, royalty-free license to copy, maintain, use, host, and run such course materials. - -The use of GitHub course materials and creation and storage of your own course materials do not constitute joint ownership to either party's respective intellectual property. - -Use of Personal Data is governed by the [GitHub Privacy Statement](/github/site-policy/github-privacy-statement). - ## npm npm is a software package hosting service that allows you to host your software packages privately or publicly and use packages as dependencies in your projects. npm is the registry of record for the JavaScript ecosystem. The npm public registry is free to use but customers are billed if they want to publish private packages or manage private packages using teams. The [npm documentation](https://docs.npmjs.com/) includes details about the limitation of account types and how to manage [private packages](https://docs.npmjs.com/about-private-packages) and [organizations](https://docs.npmjs.com/organizations). Acceptable use of the npm registry is outlined in the [open-source terms](https://www.npmjs.com/policies/open-source-terms). There are supplementary terms for both the npm [solo](https://www.npmjs.com/policies/solo-plan) and [org](https://www.npmjs.com/policies/orgs-plan) plans. The npm [Terms of Use](https://www.npmjs.com/policies/terms) apply to your use of npm. diff --git a/content/site-policy/privacy-policies/github-privacy-statement.md b/content/site-policy/privacy-policies/github-privacy-statement.md index 57bde0b8b59f..ab5843b28462 100644 --- a/content/site-policy/privacy-policies/github-privacy-statement.md +++ b/content/site-policy/privacy-policies/github-privacy-statement.md @@ -15,7 +15,7 @@ topics: - Legal --- -Effective date: May 31, 2022 +Effective date: September 1, 2022 Thanks for entrusting GitHub Inc. or GitHub B.V. (“GitHub”, “we”, "us" or "our") with your source code, your projects, and your personal data. This Privacy Statement explains our practices regarding the collection, use, and disclosure of your data, including any personal data we collect and process in connection with our website and any applications, software, products, and services provided by GitHub, including any Beta Previews (collectively “Service”). @@ -25,7 +25,7 @@ All capitalized terms have their definition in [GitHub’s Terms of Service](/gi ## The short version -We use your personal information as this Privacy Statement describes. No matter where you are, where you live, or what your citizenship is, we provide the same high standard of privacy protection to all our users around the world, regardless of their country of origin or location. +We use your personal information as this Privacy Statement describes. No matter where you are, where you live, or what your citizenship is, you have the same high standard of privacy protection when using GitHub's products as all our users around the world, regardless of their country of origin or location. To see our Privacy Notice to residents of California, please go to [GitHub's Notice about the California Consumer Privacy Act](#githubs-notice-to-california-residents) or scroll down. @@ -34,12 +34,12 @@ To see our Privacy Notice to residents of California, please go to [GitHub's Not | Section | What can you find there? | |---|---| -| [Who is responsible for the processing of your information](#who-is-responsible-for-the-processing-of-your-information) | Subject to limited exceptions, GitHub is the controller and entity responsible for the processing of your personal data in connection with the Website or Service. | +| [Who is responsible for the processing of your information](#who-is-responsible-for-the-processing-of-your-information) | Subject to limited exceptions, GitHub is the controller and entity responsible for the processing of your personal data in connection with the Website or Service if you are in North America. For individuals outside North America the data controller is GitHub B.V. | | [What information GitHub collects](#what-information-github-collects) | GitHub collects information directly from you for your registration, payment, transactions, and user profile. We also automatically collect from you your usage information, cookies, and device information, subject, where necessary, to your consent. GitHub may also collect personal data from third parties. We only collect the minimum amount of personal data necessary from you, unless you choose to provide more.| | [How GitHub uses your information](#how-github-uses-your-information) | In this section, we describe the ways in which we use your information, including to provide you the Service, to communicate with you, for security and compliance purposes, and to improve our Website or Service or develop new features and functionality of our Website or Service. We also describe the legal basis upon which we process your information, where legally required. | | [How we share the information we collect](#how-we-share-the-information-we-collect) | We may share your information with third parties under one of the following circumstances: with your consent, with our service providers, for security purposes, to comply with our legal obligations, or when there is a change of control or sale of corporate entities or business units. We do not sell your personal information and we do not host advertising on GitHub. | | [Your choices regarding our processing of your personal data](#your-choices-regarding-our-processing-of-your-personal-data) | We provide ways for you to access, alter, or delete your personal information. | -| [Cookies](#cookies) | We only use strictly necessary cookies to provide, secure, and improve our Website or Service or develop new features and functionality of our Website or Service. We offer a page that makes this very transparent. We do not send any information to third-party analytics services. | +| [Cookies](#cookies) | Except for cookies used on our Enterprise Marketing Pages, we only use strictly necessary cookies to provide, secure, and improve our Website or Service or develop new features and functionality of our Website or Service.

As described below, we may use non-essential cookies on certain pages of our website to support our enterprise marketing efforts and market our products and services to enterprise customers, for example on resources.github.com (collectively “Enterprise Marketing Pages”).

We offer a [page](https://github.com/privacy/cookies) that makes all uses of cookies very transparent. | | [How GitHub secures your information](#how-github-secures-your-information) | We take all measures reasonably necessary to protect the confidentiality, integrity, and availability of your personal data on GitHub and to protect the resilience of our servers. | | [Communication preferences](#communication-preferences) | We communicate with you by email. You can control the way we contact you in your account settings, or by contacting us. | | [Resolving complaints](#resolving-complaints) | In the unlikely event that we are unable to resolve a privacy concern quickly and thoroughly, we provide a path of dispute resolution. | @@ -122,13 +122,14 @@ We may use your information to provide, administer, analyze, manage, and operate - Personalization of our Service by understanding you and your preferences to enhance your experience and enjoyment using our Service. - Provide customer support and respond to your questions. - Deliver promotional communications with you about new services, features, offers, promotions, and other information about our Service. +- Personalize and measure the effectiveness of enterprise business ads, promotional communications or marketing you receive related to the Enterprise Marketing Pages. - Send you information, including confirmations, invoices, technical notices, updates, security alerts, support and administrative messages. We combine data we collect from different sources for these purposes and to give you a more seamless, consistent, and personalized experience. ## How we share the information we collect -We share personal data with your consent or as necessary to complete your transactions or provide the services you have requested or authorized. In addition, we may share each of the categories of your personal data described above with the types of third parties described below for the following business purposes: +We share personal data as described below, including with your consent or as necessary to complete your transactions or provide the services you have requested or authorized. In addition, we may share each of the categories of your personal data described above with the types of third parties described below for the following business purposes: ### Public information You may select options available through our Service to publicly display and share your name and/or username and certain other information, such as your profile, demographic data, content and files, or geolocation data. For example, if you would like your email address to remain private, even when you’re commenting on public repositories, [you can adjust your setting for your email address to be private in your user profile](https://github.com/settings/emails). You can also [update your local Git configuration to use your private email address](/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address). Please see more about email addresses in commit messages [here](/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address). @@ -144,10 +145,10 @@ You can enable or add third-party applications, known as "Developer Products" to You may indicate, through your actions on GitHub, that you are willing to share your personal data. If you collaborate on or become a member of an organization, then its Account owners may receive your personal data. When you accept an invitation to an organization, you will be notified of the types of information owners may be able to see (for more information, see [About Organization Membership](/github/setting-up-and-managing-your-github-user-account/about-organization-membership)). Please contact the Account owners for more information about how they might process your personal data in their Organization and the ways for you to access, update, alter, or delete your personal data stored in the Account. ### Service providers -We share your personal data with service providers who process the information on our behalf to provide or improve our Service. For example, our service providers may perform payment processing, customer support ticketing, network data transmission, security, and other similar services. While GitHub processes all personal data in the United States, our service providers may process data outside of the United States or the European Union. Such processing by service providers will be in compliance with applicable law including any relevant transfer mechanism. +We share your personal data with service providers who process the information on our behalf to provide or improve our Service. For example, our service providers may perform payment processing, customer support ticketing, network data transmission, web analytics, marketing operations, security, and other similar services. While GitHub processes all personal data in the United States, our service providers may process data outside of the United States or the European Union. Such processing by service providers will be in compliance with applicable law including any relevant transfer mechanism. ### Affiliates - We enable access to personal data across our subsidiaries, affiliates, and related companies, for example, where we share common data systems or where access is needed to operate and provide the Service. + We enable access to personal data across our subsidiaries, affiliates, and related companies, for example, where we share common data systems, when affiliates provide services on our behalf, or where access is needed to operate and provide the Service. ### For security purposes We will disclose personal data if we believe it is necessary to: @@ -173,7 +174,7 @@ You can learn more about the CCPA and how we comply with it [here](#githubs-noti ## Your choices regarding our processing of your personal data We provide choices about the personal data we collect about you. The choices you make will not apply to any personal data associated with an Organization under your Account. -Access, correction, and deletion. If you're a GitHub user, you may access, update, alter, or delete your basic user profile information by [editing your user profile](https://github.com/settings/profile) or contacting [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://enterprise.githubsupport.com/hc/en-us). You can control the information we collect about you by limiting what information is in your profile, by keeping your information current, or by contacting [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://enterprise.githubsupport.com/hc/en-us). +Access, correction, and deletion. If you're a GitHub user, you may access, update, alter, or delete your basic user profile information by [editing your user profile](https://github.com/settings/profile) or contacting [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://enterprise.githubsupport.com/hc/en-us). You can control the information we collect about you by limiting what information is in your profile, by keeping your information current, by changing your cookie preferences, or by contacting [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://enterprise.githubsupport.com/hc/en-us). We retain and use your information as described in this Privacy Statement, but barring legal requirements, we will delete your full profile within 90 days of your request. After an account has been deleted, certain data, such as contributions to other Users' repositories and comments in others' issues, will remain. However, we will delete or de-identify your personal data, including your username and email address, from the author field of issues, pull requests, and comments by associating them with a ghost user. That said, the email address you have provided via your Git commit settings will always be associated with your commits in the Git system. If you choose to make your email address private, you should also update your Git commit settings. We are unable to change or delete data in the Git commit history — the Git software is designed to maintain a record — but we do enable you to control what information you put in that record. @@ -214,13 +215,65 @@ We rely on different lawful bases for collecting and processing personal data ab ### Cookies and tracking technologies -GitHub uses cookies to provide, secure and improve our Service or to develop new features and functionality of our Service. For example, we use them to keep you logged in, remember your preferences, identify your device for security purposes, compile statistical reports, and provide information for future development of GitHub. We use our own cookies and do not use any third-party service providers in this context. If you disable your browser or device’s ability to accept these cookies, you will not be able to log in or use our Service. We provide more information about [cookies on GitHub](/github/site-policy/github-subprocessors-and-cookies#cookies-on-github) on our [GitHub Subprocessors and Cookies](/github/site-policy/github-subprocessors-and-cookies) page that describes the cookies we set, the needs we have for those cookies, and the expiration of such cookies. +GitHub uses cookies to provide, secure and improve our Service or to develop new features and functionality of our Service. For example, we use them to (i) keep you logged in, (ii) remember your preferences, (iii) identify your device for security and fraud purposes, including as needed to maintain the integrity of our Service, (iv) compile statistical reports, and (v) provide information and insight for future development of GitHub. We provide more information about [cookies on GitHub](https://github.com/privacy/cookies) that describes the cookies we set, the needs we have for those cookies, and the expiration of such cookies. + +For Enterprise Marketing Pages, we may also use non-essential cookies to (i) gather information about enterprise users’ interests and online activities to personalize their experiences, including by making the ads, content, recommendations, and marketing seen or received more relevant and (ii) serve and measure the effectiveness of targeted advertising and other marketing efforts. If you disable the non-essential cookies on the Enterprise Marketing Pages, the ads, content, and marketing you see may be less relevant. Our emails to users may contain a pixel tag, which is a small, clear image that can tell us whether or not you have opened an email and what your IP address is. We use this pixel tag to make our email communications more effective and to make sure we are not sending you unwanted email. -### DNT +The length of time a cookie will stay on your browser or device depends on whether it is a “persistent” or “session” cookie. Session cookies will only stay on your device until you stop browsing. Persistent cookies stay until they expire or are deleted. The expiration time or retention period applicable to persistent cookies depends on the purpose of the cookie collection and tool used. You may be able to delete cookie data as described here. + +#### What are cookies and similar technologies? + +We use cookies and similar technologies, such as web beacons, local storage, and mobile analytics, to operate and provide our Services. When visiting Enterprise Marketing Pages, like resources.github.com, these and additional cookies, like advertising IDs, may be used for sales and marketing purposes. + +Cookies are small text files stored by your browser on your device. A cookie can later be read when your browser connects to a web server in the same domain that placed the cookie. The text in a cookie contains a string of numbers and letters that may uniquely identify your device and can contain other information as well. This allows the web server to recognize your browser over time, each time it connects to that web server. + +Web beacons are electronic images (also called “single-pixel” or “clear GIFs”) that are contained within a website or email. When your browser opens a webpage or email that contains a web beacon, it automatically connects to the web server that hosts the image (typically operated by a third party). This allows that web server to log information about your device and to set and read its own cookies. In the same way, third-party content on our websites (such as embedded videos, plug-ins, or ads) results in your browser connecting to the third-party web server that hosts that content. + +Mobile identifiers for analytics can be accessed and used by apps on mobile devices in much the same way that websites access and use cookies. When visiting Enterprise Marketing pages, like resources.github.com, on a mobile device these may allow us and our third-party analytics and advertising partners to collect data for sales and marketing purposes. + +We may also use so-called “flash cookies” (also known as “Local Shared Objects” or “LSOs”) to collect and store information about your use of our Services. Flash cookies are commonly used for advertisements and videos. + +#### How do we and our partners use cookies and similar technologies? + +The GitHub Services use cookies and similar technologies for a variety of purposes, including to store your preferences and settings, enable you to sign-in, analyze how our Services perform, track your interaction with the Services, develop inferences, combat fraud, and fulfill other legitimate purposes. Some of these cookies and technologies may be provided by third parties, including service providers and advertising partners. For example, our analytics and advertising partners may use these technologies in our Services to collect personal information (such as the pages you visit, the links you click on, and similar usage information, identifiers, and device information) related to your online activities over time and across Services for various purposes, including targeted advertising. GitHub will place non-essential cookies on pages where we market products and services to enterprise customers, for example, on resources.github.com. + +We and/or our partners also share the information we collect or infer with third parties for these purposes. + +The table below provides additional information about how we use different types of cookies: + +| Purpose | Description | +|:---|:---| +| Required Cookies | GitHub uses required cookies to perform essential website functions and to provide the services. For example, cookies are used to log you in, save your language preferences, provide a shopping cart experience, improve performance, route traffic between web servers, detect the size of your screen, determine page load times, improve user experience, and for audience measurement. These cookies are necessary for our websites to work. | +| Analytics | We allow third parties to use analytics cookies to understand how you use our websites so we can make them better. For example, cookies are used to gather information about the pages you visit and how many clicks you need to accomplish a task. We also use some analytics cookies to provide personalized advertising. | +| Social Media | GitHub and third parties use social media cookies to show you ads and content based on your social media profiles and activity on GitHub’s websites. This ensures that the ads and content you see on our websites and on social media will better reflect your interests. This also enables third parties to develop and improve their products, which they may use on websites that are not owned or operated by GitHub. | +| Advertising | In addition, GitHub and third parties use advertising cookies to show you new ads based on ads you've already seen. Cookies also track which ads you click or purchases you make after clicking an ad. This is done both for payment purposes and to show you ads that are more relevant to you. For example, cookies are used to detect when you click an ad and to show you ads based on your social media interests and website browsing history. | + +#### What are your cookie choices and controls? + + You have several options to disable non-essential cookies: + + 1. **Specifically on GitHub Enterprise Marketing Pages** + + Any GitHub page that serves non-essential cookies will have a link in the page’s footer to cookie settings. You can express your preferences at any time by clicking on that linking and updating your settings. + + Some users will also be able to manage non-essential cookies via a cookie consent banner, including the options to accept, manage, and reject all non-essential cookies. + 2. **Generally for all websites** + + You can control the cookies you encounter on the web using a variety of widely-available tools. For example: + - If your browser sends a [Do Not Track](https://en.wikipedia.org/wiki/Do_Not_Track) (DNT) signal, GitHub will not set non-essential cookies and will not load third party resources which set non-essential cookies. + - Many browsers provide cookie controls which may limit the types of cookies you encounter online. Check out the documentation for your browser to learn more. + - If you enable a browser extension designed to block tracking, such as [Privacy Badger](https://en.wikipedia.org/wiki/Privacy_Badger), non-essential cookies set by a website or third parties may be disabled. + - If you enable a browser extension designed to block unwanted content, such as [uBlock Origin](https://en.wikipedia.org/wiki/UBlock_Origin), non-essential cookies will be disabled to the extent that content that sets non-essential cookies will be blocked. + - Advertising controls. Our advertising partners may participate in associations that provide simple ways to opt out of ad targeting, which you can access at: + - United States: [NAI](http://optout.networkadvertising.org) and [DAA](http://optout.aboutads.info/) + - Canada: [Digital Advertising Alliance of Canada](https://youradchoices.ca/) + - Europe: [European Digital Advertising Alliance](http://www.youronlinechoices.com/) + + These choices are specific to the browser you are using. If you access our Services from other devices or browsers, take these actions from those systems to ensure your choices apply to the data collected when you use those systems. + -"[Do Not Track](https://www.eff.org/issues/do-not-track)" (DNT) is a privacy preference you can set in your browser if you do not want online services to collect and share certain kinds of information about your online activity from third party tracking services. GitHub responds to browser DNT signals and follows the [W3C standard for responding to DNT signals](https://www.w3.org/TR/tracking-dnt/). If you would like to set your browser to signal that you would not like to be tracked, please check your browser's documentation for how to enable that signal. There are also good applications that block online tracking, such as [Privacy Badger](https://privacybadger.org/). ## Retention of personal data We retain personal data for as long as necessary to provide the services and fulfill the transactions you have requested, comply with our legal obligations, resolve disputes, enforce our agreements, and other legitimate and lawful business purposes. Because these needs can vary for different data types in the context of different services, actual retention periods can vary significantly based on criteria such as user expectations or consent, the sensitivity of the data, the availability of automated controls that enable users to delete data, and our legal or contractual obligations. For example, we may retain your personal data for longer periods, where necessary, subject to applicable law, for security purposes. @@ -244,15 +297,22 @@ GitHub processes personal data both inside and outside of the United States and ### Resolving complaints If you have concerns about the way GitHub is handling your personal data, please let us know immediately. We want to help. You may contact us by filling out the [Privacy contact form](https://support.github.com/contact/privacy). You may also email us directly at **(privacy [at] github [dot] com)** with the subject line "Privacy Concerns." We will respond promptly — within 45 days at the latest. -You may also contact our Data Protection Officer directly. - -| Our United States HQ | Our EU Office | -|---|---| -| GitHub Data Protection Officer | GitHub BV | -| 88 Colin P. Kelly Jr. St. | Vijzelstraat 68-72 | -| San Francisco, CA 94107 | 1017 HL Amsterdam | -| United States | The Netherlands | -| **privacy [at] github [dot] com** | **privacy [at] github [dot] com** | +You may also contact our Data Protection Officer directly at at **github [at]dp-officer [dot] com** + +**If you are in North America:**
+GitHub Data Protection Officer
+88 Colin P. Kelly Jr. St.
+San Francisco, CA 94107
+United States
+**privacy [at] github [dot] com**
+ +**If you are outside of North America:**
+Github Data Protection Officer
+c/o DP Dock DPO Services GmbH,
+Attn: GitHub BV, Gut Projensdorf,
+24161 Altenholz, Germany
+github@dp-officer.com cc: **privacy [at] github [dot] com**
+CC: GitHub BV, Vijzelstraat 68-72, 1017 HL Amsterdam, The Netherlands ### Dispute resolution process diff --git a/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md b/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md index 359529b876b7..fe406b940e7c 100644 --- a/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md +++ b/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md @@ -14,74 +14,23 @@ topics: - Legal --- -Effective date: **April 2, 2021** +Effective date: **September 1, 2022** -{% note %} - -**Note:** Changes to the list of cookies on this page are currently pending. - -{% endnote %} GitHub provides a great deal of transparency regarding how we use your data, how we collect your data, and with whom we share your data. To that end, we provide this page, which details [our subprocessors](#github-subprocessors), and how we use [cookies](#cookies-on-github). ## GitHub Subprocessors -When we share your information with third party subprocessors, such as our vendors and service providers, we remain responsible for it. We work very hard to maintain your trust when we bring on new vendors, and we require all vendors to enter into data protection agreements with us that restrict their processing of Users' Personal Information (as defined in the [Privacy Statement](/articles/github-privacy-statement/)). You can sign up to receive subprocessor list updates [here](https://www.github.com/privacy/subprocessors). +When we share your information with third party subprocessors, such as our vendors and service providers, we remain responsible for it. We work very hard to maintain your trust when we bring on new vendors, and we require all vendors to enter into data protection agreements with us that restrict their processing of Users' Personal Information (as defined in the [Privacy Statement](/articles/github-privacy-statement/)). -| Name of Subprocessor | Description of Processing | Location of Processing | Corporate Location -|:---|:---|:---|:---| -| Automattic | Blogging service | United States | United States | -| AWS Amazon | Data hosting | United States | United States | -| Braintree (PayPal) | Subscription credit card payment processor | United States | United States | -| Clearbit | Marketing data enrichment service | United States | United States | -| Discourse | Community forum software provider | United States | United States | -| Eloqua | Marketing campaign automation | United States | United States | -| Google Apps | Internal company infrastructure | United States | United States | -| MailChimp | Customer ticketing mail services provider | United States | United States | -| Mailgun | Transactional mail services provider | United States | United States | -| Microsoft | Microsoft Services | United States | United States | -| Nexmo | SMS notification provider | United States | United States | -| Salesforce.com | Customer relations management | United States | United States | -| Sentry.io | Application monitoring provider | United States | United States | -| Stripe | Payment provider | United States | United States | -| Twilio & Twilio Sendgrid | SMS notification provider & transactional mail service provider | United States | United States | -| Zendesk | Customer support ticketing system | United States | United States | -| Zuora | Corporate billing system | United States | United States | +When we bring on a new subprocessor who handles our Users' Personal Information, or remove a subprocessor, or we change how we use a subprocessor, we will update the list of subprocessors. You can view the current list of subprocessors, and sign up to receive subprocessor list updates, at [https://www.github.com/privacy/subprocessors](https://www.github.com/privacy/subprocessors). -When we bring on a new subprocessor who handles our Users' Personal Information, or remove a subprocessor, or we change how we use a subprocessor, we will update this page. If you have questions or concerns about a new subprocessor, we'd be happy to help. Please contact us via {% data variables.contact.contact_privacy %}. +If you have questions or concerns about a new subprocessor, we'd be happy to help. Please contact us via {% data variables.contact.contact_privacy %}. ## Cookies on GitHub GitHub uses cookies to provide and secure our websites, as well as to analyze the usage of our websites, in order to offer you a great user experience. Please take a look at our [Privacy Statement](/github/site-policy/github-privacy-statement#our-use-of-cookies-and-tracking) if you’d like more information about cookies, and on how and why we use them. -Since the number and names of cookies may change, the table below may be updated from time to time. - -| Service Provider | Cookie Name | Description | Expiration* | -|:---|:---|:---|:---| -| GitHub | `app_manifest_token` | This cookie is used during the App Manifest flow to maintain the state of the flow during the redirect to fetch a user session. | five minutes | -| GitHub | `color_mode` | This cookie is used to indicate the user selected theme preference. | session | -| GitHub | `_device_id` | This cookie is used to track recognized devices for security purposes. | one year | -| GitHub | `dotcom_user` | This cookie is used to signal to us that the user is already logged in. | one year | -| GitHub | `_gh_ent` | This cookie is used for temporary application and framework state between pages like what step the customer is on in a multiple step form. | two weeks | -| GitHub | `_gh_sess` | This cookie is used for temporary application and framework state between pages like what step the user is on in a multiple step form. | session | -| GitHub | `gist_oauth_csrf` | This cookie is set by Gist to ensure the user that started the oauth flow is the same user that completes it. | deleted when oauth state is validated | -| GitHub | `gist_user_session` | This cookie is used by Gist when running on a separate host. | two weeks | -| GitHub | `has_recent_activity` | This cookie is used to prevent showing the security interstitial to users that have visited the app recently. | one hour | -| GitHub | `__Host-gist_user_session_same_site` | This cookie is set to ensure that browsers that support SameSite cookies can check to see if a request originates from GitHub. | two weeks | -| GitHub | `__Host-user_session_same_site` | This cookie is set to ensure that browsers that support SameSite cookies can check to see if a request originates from GitHub. | two weeks | -| GitHub | `logged_in` | This cookie is used to signal to us that the user is already logged in. | one year | -| GitHub | `marketplace_repository_ids` | This cookie is used for the marketplace installation flow. | one hour | -| GitHub | `marketplace_suggested_target_id` | This cookie is used for the marketplace installation flow. | one hour | -| GitHub | `_octo` | This cookie is used for session management including caching of dynamic content, conditional feature access, support request metadata, and first party analytics. | one year | -| GitHub | `org_transform_notice` | This cookie is used to provide notice during organization transforms. | one hour | -| GitHub | `private_mode_user_session` | This cookie is used for Enterprise authentication requests. | two weeks | -| GitHub | `saml_csrf_token` | This cookie is set by SAML auth path method to associate a token with the client. | until user closes browser or completes authentication request | -| GitHub | `saml_csrf_token_legacy` | This cookie is set by SAML auth path method to associate a token with the client. | until user closes browser or completes authentication request | -| GitHub | `saml_return_to` | This cookie is set by the SAML auth path method to maintain state during the SAML authentication loop. | until user closes browser or completes authentication request | -| GitHub | `saml_return_to_legacy` | This cookie is set by the SAML auth path method to maintain state during the SAML authentication loop. | until user closes browser or completes authentication request | -| GitHub | `tz` | This cookie allows us to customize timestamps to your time zone. | session | -| GitHub | `user_session` | This cookie is used to log you in. | two weeks | - -_*_ The **expiration** dates for the cookies listed below generally apply on a rolling basis. +You can view the current list of cookies on GitHub, and sign up to receive cookie list updates, at [https://github.com/privacy/cookies](https://github.com/privacy/cookies). (!) Please note while we limit our use of third party cookies to those necessary to provide external functionality when rendering external content, certain pages on our website may set other third party cookies. For example, we may embed content, such as videos, from another site that sets a cookie. While we try to minimize these third party cookies, we can’t always control what cookies this third party content sets. diff --git a/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md b/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md index dabf0fcdcbe4..bb966aba1b43 100644 --- a/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md +++ b/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md @@ -25,7 +25,7 @@ shortTitle: Sponsor a contributor You can sponsor an account on behalf of your personal account to invest in projects that you personally benefit from. You can sponsor an account on behalf of your organization for many reasons. - Sustaining specific libraries that your organization's work depends on -- Investing in the ecosystem you rely on as a organization (such as blockchain) +- Investing in the ecosystem you rely on as an organization (such as blockchain) - Developing brand awareness as an organization that values open source - Thanking open source developers for building libraries that complement the product your organization offers diff --git a/contributing/content-style-guide.md b/contributing/content-style-guide.md index 72c51cb96528..c50374f2b8e3 100644 --- a/contributing/content-style-guide.md +++ b/contributing/content-style-guide.md @@ -93,6 +93,15 @@ schedule: - cron: "40 19 * * *" ``` +### File and directory names + +Use inline codeblocks to refer to file and directory names. If a file type generally follows a specific capitalization convention, such as all caps for README files, use the established convention. + +- **Use:** In your `README.md` file, add info about your repository. +- **Use:** In your `.github/workflows/` directory, create the `example-workflow.yml` file. +- **Avoid:** In your _.github/workflows/_ directory, create the `example-workflow.yml` file. +- **Avoid:** Delete the **example.js** file. + ### Indentation In YAML examples, such as actions and workflow files, use two spaces to indent lines within nested lists and block sequences. @@ -500,29 +509,11 @@ Format checkbox names in bold and omit the word “checkbox.” To describe choo - **Use:** Select **Enable for all new repositories**. - **Avoid:** Check the “Enable for all new repositories” checkbox. -### Directory names - -Use sentence style capitalization. You can use internal capital letters in directory and folder names for readability. Format directory names in bold if you direct someone to select, type, or otherwise interact with the name. - -- **Use:** In your .github/workflows directory, create a new file. -- **Use:** Select your **.github/workflows** directory. -- **Avoid:** In your *.github/workflows* directory, select the workflow you wish to edit. -- **Avoid:** In your `.github/workflows` directory, select the workflow you wish to edit. - ### Dynamic text Use capital letters to indicate text that changes in the user interface or that the user needs to supply in a command or code snippet. - **Use:** Click **Add USERNAME to REPONAME**. -### File names - -Use title style capitalization. If a file type generally follows a different capitalization convention, such as all caps for README files, use the established convention. You can use internal capital letters in file names for readability. Format file names in bold if you direct someone to select, type, or otherwise interact with the name. - -- **Use:** In your README.md file, add info about your repository. -- **Use:** Enter **MyWorkflow.yml**. -- **Avoid:** In your *README.md* file, add info about your repository. -- **Avoid:** In your `README.md` file, add info about your repository. - ### Lists and list items Format lists and clickable list items in bold. To describe interacting with a list, such as a dropdown menu or UI element that expands, regardless of whether the list name is a word or an octicon, write "select." To describe choosing a list item, write "click." diff --git a/contributing/self-review.md b/contributing/self-review.md index 7dc65b407ffc..348d344213aa 100644 --- a/contributing/self-review.md +++ b/contributing/self-review.md @@ -1,13 +1,16 @@ ### Self review - You should always review your own PR first. - For content changes, make sure that you: + - [ ] Confirm that the changes meet the user experience and goals outlined in the content design plan (if there is one). + - [ ] Compare your pull request's source changes to staging to confirm that the output matches the source and that everything is rendering as expected. This helps spot issues like typos, content that doesn't follow the style guide, or content that isn't rendering due to versioning problems. Remember that lists and tables can be tricky. + - [ ] Review the content for technical accuracy. + - [ ] Review the entire pull request using the [localization checklist](localization-checklist.md). +This comment has been minimized. +Show comment +This comment has been minimized. +Show comment + Reply… -- [ ] Confirm that the changes meet the user experience and goals outlined in the content design plan (if there is one). -- [ ] Compare your pull request's source changes to staging to confirm that the output matches the source and that everything is rendering as expected. This helps spot issues like typos, content that doesn't follow the style guide, or content that isn't rendering due to versioning problems. Remember that lists and tables can be tricky. -- [ ] Review the content for technical accuracy. -- [ ] Review the entire pull request using the [localization checklist](localization-checklist.md). -- [ ] Copy-edit the changes for grammar, spelling, and adherence to the [style guide](https://github.com/github/docs/blob/main/contributing/content-style-guide.md). -- [ ] Check new or updated Liquid statements to confirm that versioning is correct. -- [ ] If there are any failing checks in your PR, troubleshoot them until they're all passing. + - [ ] Copy-edit the changes for grammar, spelling, and adherence to the [style guide](https://github.com/github/docs/blob/main/contributing/content-style-guide.md). + - [ ] Check new or updated Liquid statements to confirm that versioning is correct. + - [ ] If there are any failing checks in your PR, troubleshoot them until they're all passing. diff --git a/data/features/actions-hosted-runners.yml b/data/features/actions-hosted-runners.yml new file mode 100644 index 000000000000..d7b08dee7465 --- /dev/null +++ b/data/features/actions-hosted-runners.yml @@ -0,0 +1,5 @@ +# Reference: #6458 +# Larger GitHub-hosted runners +versions: + fpt: '*' + ghec: '*' diff --git a/data/features/audit-log-sso-response-events.yml b/data/features/audit-log-sso-response-events.yml new file mode 100644 index 000000000000..53f67d03b1c5 --- /dev/null +++ b/data/features/audit-log-sso-response-events.yml @@ -0,0 +1,6 @@ +# Documentation for adding business.sso_response and org.sso_repsonse + +versions: + ghec: '*' + ghes: '>=3.8' + ghae: 'issue-7939' diff --git a/data/features/code-scanning-exclude-queries-from-analysis.yml b/data/features/code-scanning-exclude-queries-from-analysis.yml new file mode 100644 index 000000000000..ee8634cf6b1c --- /dev/null +++ b/data/features/code-scanning-exclude-queries-from-analysis.yml @@ -0,0 +1,7 @@ +# Issue 7617 +# Users can easily exclude CodeQL queries from code scanning analyses - [GA] +versions: + fpt: '*' + ghec: '*' + ghes: '>3.6' + ghae: 'issue-7617' diff --git a/data/features/dependency-review-action-ghes.yml b/data/features/dependency-review-action-ghes.yml new file mode 100644 index 000000000000..5ce8fa024aa2 --- /dev/null +++ b/data/features/dependency-review-action-ghes.yml @@ -0,0 +1,4 @@ +# Reference: Issue #7753 Dependency review action has shipped with GHES 3.6 and needs admin docs +versions: + ghes: '>3.5' + ghae: 'issue-7753' diff --git a/data/features/packages-npm-v2.yml b/data/features/packages-npm-v2.yml new file mode 100644 index 000000000000..aaebb7fbfcd2 --- /dev/null +++ b/data/features/packages-npm-v2.yml @@ -0,0 +1,5 @@ +# Issue 7039 +# npm Package Registry Improvements (v2) GA +versions: + fpt: '*' + ghec: '*' diff --git a/data/features/streaming-datadog.yml b/data/features/streaming-datadog.yml new file mode 100644 index 000000000000..9c099525c1de --- /dev/null +++ b/data/features/streaming-datadog.yml @@ -0,0 +1,4 @@ +# Reference #7495 +# Documentation for audit log streaming to a Datadog endpoint +versions: + ghec: '*' diff --git a/data/graphql/ghae/schema.docs-ghae.graphql b/data/graphql/ghae/schema.docs-ghae.graphql index 57ecfac539a5..21eb506999e9 100644 --- a/data/graphql/ghae/schema.docs-ghae.graphql +++ b/data/graphql/ghae/schema.docs-ghae.graphql @@ -16035,6 +16035,41 @@ type MergeBranchPayload { mergeCommit: Commit } +""" +The possible default commit messages for merges. +""" +enum MergeCommitMessage { + """ + Default to a blank commit message. + """ + BLANK + + """ + Default to the pull request's body. + """ + PR_BODY + + """ + Default to the pull request's title. + """ + PR_TITLE +} + +""" +The possible default commit titles for merges. +""" +enum MergeCommitTitle { + """ + Default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + """ + MERGE_MESSAGE + + """ + Default to the pull request's title. + """ + PR_TITLE +} + """ Autogenerated input type of MergePullRequest """ @@ -32457,6 +32492,16 @@ type Repository implements Node & ProjectOwner & RepositoryInfo & Starrable & Su """ mergeCommitAllowed: Boolean! + """ + How the default commit message will be generated when merging a pull request. + """ + mergeCommitMessage: MergeCommitMessage! + + """ + How the default commit title will be generated when merging a pull request. + """ + mergeCommitTitle: MergeCommitTitle! + """ Returns a single milestone from the current repository by number. """ @@ -32888,6 +32933,16 @@ type Repository implements Node & ProjectOwner & RepositoryInfo & Starrable & Su """ squashMergeAllowed: Boolean! + """ + How the default commit message will be generated when squash merging a pull request. + """ + squashMergeCommitMessage: SquashMergeCommitMessage! + + """ + How the default commit title will be generated when squash merging a pull request. + """ + squashMergeCommitTitle: SquashMergeCommitTitle! + """ Whether a squash merge commit can use the pull request title as default. """ @@ -35828,6 +35883,41 @@ type SmimeSignature implements GitSignature { wasSignedByGitHub: Boolean! } +""" +The possible default commit messages for squash merges. +""" +enum SquashMergeCommitMessage { + """ + Default to a blank commit message. + """ + BLANK + + """ + Default to the branch's commit messages. + """ + COMMIT_MESSAGES + + """ + Default to the pull request's body. + """ + PR_BODY +} + +""" +The possible default commit titles for squash merges. +""" +enum SquashMergeCommitTitle { + """ + Default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + """ + COMMIT_OR_PR_TITLE + + """ + Default to the pull request's title. + """ + PR_TITLE +} + """ Ways in which star connections can be ordered. """ diff --git a/data/graphql/ghec/schema.docs.graphql b/data/graphql/ghec/schema.docs.graphql index 9331ff1fd0a9..240e5bea5b56 100644 --- a/data/graphql/ghec/schema.docs.graphql +++ b/data/graphql/ghec/schema.docs.graphql @@ -18295,6 +18295,41 @@ type MergeBranchPayload { mergeCommit: Commit } +""" +The possible default commit messages for merges. +""" +enum MergeCommitMessage { + """ + Default to a blank commit message. + """ + BLANK + + """ + Default to the pull request's body. + """ + PR_BODY + + """ + Default to the pull request's title. + """ + PR_TITLE +} + +""" +The possible default commit titles for merges. +""" +enum MergeCommitTitle { + """ + Default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + """ + MERGE_MESSAGE + + """ + Default to the pull request's title. + """ + PR_TITLE +} + """ Autogenerated input type of MergePullRequest """ @@ -39705,6 +39740,16 @@ type Repository implements Node & PackageOwner & ProjectOwner & ProjectV2Recent """ mergeCommitAllowed: Boolean! + """ + How the default commit message will be generated when merging a pull request. + """ + mergeCommitMessage: MergeCommitMessage! + + """ + How the default commit title will be generated when merging a pull request. + """ + mergeCommitTitle: MergeCommitTitle! + """ Returns a single milestone from the current repository by number. """ @@ -40302,6 +40347,16 @@ type Repository implements Node & PackageOwner & ProjectOwner & ProjectV2Recent """ squashMergeAllowed: Boolean! + """ + How the default commit message will be generated when squash merging a pull request. + """ + squashMergeCommitMessage: SquashMergeCommitMessage! + + """ + How the default commit title will be generated when squash merging a pull request. + """ + squashMergeCommitTitle: SquashMergeCommitTitle! + """ Whether a squash merge commit can use the pull request title as default. """ @@ -44792,6 +44847,41 @@ enum SponsorshipPrivacy { PUBLIC } +""" +The possible default commit messages for squash merges. +""" +enum SquashMergeCommitMessage { + """ + Default to a blank commit message. + """ + BLANK + + """ + Default to the branch's commit messages. + """ + COMMIT_MESSAGES + + """ + Default to the pull request's body. + """ + PR_BODY +} + +""" +The possible default commit titles for squash merges. +""" +enum SquashMergeCommitTitle { + """ + Default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + """ + COMMIT_OR_PR_TITLE + + """ + Default to the pull request's title. + """ + PR_TITLE +} + """ Ways in which star connections can be ordered. """ diff --git a/data/graphql/schema.docs.graphql b/data/graphql/schema.docs.graphql index 9331ff1fd0a9..240e5bea5b56 100644 --- a/data/graphql/schema.docs.graphql +++ b/data/graphql/schema.docs.graphql @@ -18295,6 +18295,41 @@ type MergeBranchPayload { mergeCommit: Commit } +""" +The possible default commit messages for merges. +""" +enum MergeCommitMessage { + """ + Default to a blank commit message. + """ + BLANK + + """ + Default to the pull request's body. + """ + PR_BODY + + """ + Default to the pull request's title. + """ + PR_TITLE +} + +""" +The possible default commit titles for merges. +""" +enum MergeCommitTitle { + """ + Default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + """ + MERGE_MESSAGE + + """ + Default to the pull request's title. + """ + PR_TITLE +} + """ Autogenerated input type of MergePullRequest """ @@ -39705,6 +39740,16 @@ type Repository implements Node & PackageOwner & ProjectOwner & ProjectV2Recent """ mergeCommitAllowed: Boolean! + """ + How the default commit message will be generated when merging a pull request. + """ + mergeCommitMessage: MergeCommitMessage! + + """ + How the default commit title will be generated when merging a pull request. + """ + mergeCommitTitle: MergeCommitTitle! + """ Returns a single milestone from the current repository by number. """ @@ -40302,6 +40347,16 @@ type Repository implements Node & PackageOwner & ProjectOwner & ProjectV2Recent """ squashMergeAllowed: Boolean! + """ + How the default commit message will be generated when squash merging a pull request. + """ + squashMergeCommitMessage: SquashMergeCommitMessage! + + """ + How the default commit title will be generated when squash merging a pull request. + """ + squashMergeCommitTitle: SquashMergeCommitTitle! + """ Whether a squash merge commit can use the pull request title as default. """ @@ -44792,6 +44847,41 @@ enum SponsorshipPrivacy { PUBLIC } +""" +The possible default commit messages for squash merges. +""" +enum SquashMergeCommitMessage { + """ + Default to a blank commit message. + """ + BLANK + + """ + Default to the branch's commit messages. + """ + COMMIT_MESSAGES + + """ + Default to the pull request's body. + """ + PR_BODY +} + +""" +The possible default commit titles for squash merges. +""" +enum SquashMergeCommitTitle { + """ + Default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + """ + COMMIT_OR_PR_TITLE + + """ + Default to the pull request's title. + """ + PR_TITLE +} + """ Ways in which star connections can be ordered. """ diff --git a/data/learning-tracks/admin.yml b/data/learning-tracks/admin.yml index a7aa266e929f..23816673a1ff 100644 --- a/data/learning-tracks/admin.yml +++ b/data/learning-tracks/admin.yml @@ -120,6 +120,7 @@ configure_github_advanced_security: - /admin/advanced-security/about-licensing-for-github-advanced-security - /admin/advanced-security/enabling-github-advanced-security-for-your-enterprise - /admin/advanced-security/configuring-code-scanning-for-your-appliance + - /admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-dependency-review-for-your-appliance - /admin/advanced-security/configuring-secret-scanning-for-your-appliance - /admin/policies/enforcing-policies-for-advanced-security-in-your-enterprise diff --git a/data/release-notes/enterprise-server/3-2/18.yml b/data/release-notes/enterprise-server/3-2/18.yml new file mode 100644 index 000000000000..818d03df01cb --- /dev/null +++ b/data/release-notes/enterprise-server/3-2/18.yml @@ -0,0 +1,16 @@ +date: '2022-08-30' +sections: + bugs: + - Duplicate administrative SSH keys could appear in both the Management Console and the `/home/admin/.ssh/authorized_keys` file. + - In some cases, background tasks could stall due to a library that was used concurrently despite not being thread-safe. + changes: + - Generation of support bundles is faster as a result of parallelized log sanitization. For more information about support bundles, see "[Providing data to GitHub Support](/support/contacting-github-support/providing-data-to-github-support)." + known_issues: + - On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user. + - Custom firewall rules are removed during the upgrade process. + - Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository. + - Issues cannot be closed if they contain a permalink to a blob in the same repository, where the blob's file path is longer than 255 characters. + - When "Users can search GitHub.com" is enabled with {% 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. + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/data/release-notes/enterprise-server/3-3/13.yml b/data/release-notes/enterprise-server/3-3/13.yml new file mode 100644 index 000000000000..7072e70f1237 --- /dev/null +++ b/data/release-notes/enterprise-server/3-3/13.yml @@ -0,0 +1,23 @@ +date: '2022-08-30' +sections: + bugs: + - After unlocking a repository for temporary access, a site administrator was unable to manage settings for security products in the repository. + - Duplicate administrative SSH keys could appear in both the Management Console and the `/home/admin/.ssh/authorized_keys` file. + - In some cases, running `ghe-cluster-config-apply` could replicate an empty configuration to existing nodes in a cluster. + - In some cases, configuration runs started with `ghe-config-apply` did not complete, or returned a `Container count mismatch` error. + - After updating a self-signed TLS certificate on a GitHub Enterprise Server instance, UI elements on some pages in the web interface did not appear. + - In some cases, background tasks could stall due to a library that was used concurrently despite not being thread-safe. + changes: + - Generation of support bundles is faster as a result of parallelized log sanitization. For more information about support bundles, see "[Providing data to GitHub Support](/support/contacting-github-support/providing-data-to-github-support)." + - The enterprise audit log now includes more user-generated events, such as `project.create`. The REST API also returns additional user-generated events, such as `repo.create`. For more information, see "[Accessing the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)" and "[Using the audit log API for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise#querying-the-audit-log-rest-api)." + known_issues: + - After upgrading to {% data variables.product.prodname_ghe_server %} 3.3, {% data variables.product.prodname_actions %} may fail to start automatically. To resolve this issue, connect to the appliance via SSH and run the `ghe-actions-start` command. + - On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user. + - Custom firewall rules are removed during the upgrade process. + - Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository. + - Issues cannot be closed if they contain a permalink to a blob in the same repository, where the blob's file path is longer than 255 characters. + - When "Users can search GitHub.com" is enabled with {% 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. + - '{% data variables.product.prodname_actions %} storage settings cannot be validated and saved in the {% data variables.enterprise.management_console %} when "Force Path Style" is selected, and must instead be configured with the `ghe-actions-precheck` command line utility.' + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/data/release-notes/enterprise-server/3-4/8.yml b/data/release-notes/enterprise-server/3-4/8.yml new file mode 100644 index 000000000000..6353897f97ff --- /dev/null +++ b/data/release-notes/enterprise-server/3-4/8.yml @@ -0,0 +1,26 @@ +date: '2022-08-30' +sections: + bugs: + - After unlocking a repository for temporary access, a site administrator was unable to manage settings for security products in the repository. + - Duplicate administrative SSH keys could appear in both the Management Console and the `/home/admin/.ssh/authorized_keys` file. + - The site admin page for individual users at http(s)://HOSTNAME/stafftools/users/USERNAME/admin contained functionality not intended for GitHub Enterprise Server. + - In some cases, running `ghe-cluster-config-apply` could replicate an empty configuration to existing nodes in a cluster. + - In some cases, configuration runs started with `ghe-config-apply` did not complete, or returned a `Container count mismatch` error. + - After updating a self-signed TLS certificate on a GitHub Enterprise Server instance, UI elements on some pages in the web interface did not appear. + - In some cases, background tasks could stall due to a library that was used concurrently despite not being thread-safe. + changes: + - Generation of support bundles is faster as a result of parallelized log sanitization. For more information about support bundles, see "[Providing data to GitHub Support](/support/contacting-github-support/providing-data-to-github-support)." + - APIs that contain the `organization` or `org` route now accept either the organization's slug or ID. Previously, the APIs only accepted slugs, which caused `Link` headers for GitHub Advanced Security endpoints to be inaccessible. For more information, see "[Organizations](https://docs.github.com/rest/orgs/orgs)" in the REST API documentation. + - The enterprise audit log now includes more user-generated events, such as `project.create`. The REST API also returns additional user-generated events, such as `repo.create`. For more information, see "[Accessing the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)" and "[Using the audit log API for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise#querying-the-audit-log-rest-api)." + known_issues: + - On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user. + - Custom firewall rules are removed during the upgrade process. + - Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository. + - Issues cannot be closed if they contain a permalink to a blob in the same repository, where the blob's file path is longer than 255 characters. + - When "Users can search GitHub.com" is enabled with {% 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. + - | + After registering a self-hosted runner with the `--ephemeral` parameter on more than one level (for example, both enterprise and organization), the runner may get stuck in an idle state and require re-registration. [Updated: 2022-06-17] + - After upgrading to {% data variables.product.prodname_ghe_server %} 3.4, releases may appear to be missing from repositories. This can occur when the required Elasticsearch index migrations have not successfully completed. + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/data/release-notes/enterprise-server/3-5/5.yml b/data/release-notes/enterprise-server/3-5/5.yml new file mode 100644 index 000000000000..1864d8e9991a --- /dev/null +++ b/data/release-notes/enterprise-server/3-5/5.yml @@ -0,0 +1,27 @@ +date: '2022-08-30' +sections: + bugs: + - After unlocking a repository for temporary access, a site administrator was unable to manage settings for security products in the repository. + - Duplicate administrative SSH keys could appear in both the Management Console and the `/home/admin/.ssh/authorized_keys` file. + - The site admin page for individual users at http(s)://HOSTNAME/stafftools/users/USERNAME/admin contained functionality not intended for GitHub Enterprise Server. + - In some cases, running `ghe-cluster-config-apply` could replicate an empty configuration to existing nodes in a cluster. + - In some cases, configuration runs started with `ghe-config-apply` did not complete, or returned a `Container count mismatch` error. + - After updating a self-signed TLS certificate on a GitHub Enterprise Server instance, UI elements on some pages in the web interface did not appear. + - The site admin bar at the top of the web interface contained a broken link to the SHA for the currently running version of the application. + - In some cases, background tasks could stall due to a library that was used concurrently despite not being thread-safe. + - Alerts from secret scanning for GitHub Advanced Security customers were missing in the web UI and REST API if a site administrator did not upgrade directly to GitHub Enterprise Server 3.4. The alerts are now visible. + - When a user forked a repository into an organization, a long list of organizations would not render properly. + changes: + - Generation of support bundles is faster as a result of parallelized log sanitization. For more information about support bundles, see "[Providing data to GitHub Support](/support/contacting-github-support/providing-data-to-github-support)." + - APIs that contain the `organization` or `org` route now accept either the organization's slug or ID. Previously, the APIs only accepted slugs, which caused `Link` headers for GitHub Advanced Security endpoints to be inaccessible. For more information, see "[Organizations](https://docs.github.com/rest/orgs/orgs)" in the REST API documentation. + - The enterprise audit log now includes more user-generated events, such as `project.create`. The REST API also returns additional user-generated events, such as `repo.create`. For more information, see "[Accessing the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)" and "[Using the audit log API for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise#querying-the-audit-log-rest-api)." + - In some cases, cache replicas could reject some Git operations on recently updated repositories. For more information about repository caching, see "[About repository caching](/admin/enterprise-management/caching-repositories/about-repository-caching)." + known_issues: + - On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user. + - Custom firewall rules are removed during the upgrade process. + - Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository. + - Issues cannot be closed if they contain a permalink to a blob in the same repository, where the blob's file path is longer than 255 characters. + - When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. + - The {% data variables.product.prodname_registry %} npm registry no longer returns a time value in metadata responses. This was done to allow for substantial performance improvements. We continue to have all the data necessary to return a time value as part of the metadata response and will resume returning this value in the future once we have solved the existing performance issues. + - Resource limits that are specific to processing pre-receive hooks may cause some pre-receive hooks to fail. + - Actions services need to be restarted after restoring an appliance from a backup taken on a different host. diff --git a/data/release-notes/enterprise-server/3-6/0.yml b/data/release-notes/enterprise-server/3-6/0.yml index 399fb51fc11e..5b99481bd55a 100644 --- a/data/release-notes/enterprise-server/3-6/0.yml +++ b/data/release-notes/enterprise-server/3-6/0.yml @@ -28,7 +28,9 @@ sections: # https://github.com/github/releases/issues/2341 - | - You can require TLS encryption for incoming SMTP connections to your instance. For more information, see "[Configuring email for notifications](/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications)." + You can require TLS encryption for incoming SMTP connections to your instance. For more information, see "[Configuring email for notifications](/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications#enforcing-tls-for-smtp-connections)." + + - **Note**: This feature is unavailable in GitHub Enterprise Server 3.6.0. The feature will be available in an upcoming release. [Updated: 2022-08-26] - heading: Audit logs notes: @@ -294,4 +296,4 @@ sections: - In a repository's settings, enabling the option to allow users with read access to create discussions does not enable this functionality. - In some cases, users cannot convert existing issues to discussions. - Custom patterns for secret scanning have `.*` as an end delimiter, specifically in the "After secret" field. This delimiter causes inconsistencies in scans for secrets across repositories, and you may notice gaps in a repository's history where no scans completed. Incremental scans may also be impacted. To prevent issues with scans, modify the end of the pattern to remove the `.*` delimiter. - - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' \ No newline at end of file + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/data/release-notes/enterprise-server/3-6/1.yml b/data/release-notes/enterprise-server/3-6/1.yml new file mode 100644 index 000000000000..f31b9cb734b2 --- /dev/null +++ b/data/release-notes/enterprise-server/3-6/1.yml @@ -0,0 +1,33 @@ +date: '2022-08-30' +sections: + bugs: + - After unlocking a repository for temporary access, a site administrator was unable to manage settings for security products in the repository. + - Duplicate administrative SSH keys could appear in both the Management Console and the `/home/admin/.ssh/authorized_keys` file. + - The site admin page for individual users at http(s)://HOSTNAME/stafftools/users/USERNAME/admin contained functionality not intended for GitHub Enterprise Server. + - In some cases, running `ghe-cluster-config-apply` could replicate an empty configuration to existing nodes in a cluster. + - In some cases, configuration runs started with `ghe-config-apply` did not complete, or returned a `Container count mismatch` error. + - After updating a self-signed TLS certificate on a GitHub Enterprise Server instance, UI elements on some pages in the web interface did not appear. + - In some cases, background tasks could stall due to a library that was used concurrently despite not being thread-safe. + - The site admin bar at the top of the web interface contained a broken link to the SHA for the currently running version of the application. + - Organization owners were unable to set the level of access required to create discussions. + - Discussions users were incorrectly directed to the community guidelines for GitHub.com. + - In some cases, users were incorrectly instructed to verify their email before creating a discussion. + - Alerts from secret scanning for GitHub Advanced Security customers were missing in the web UI and REST API if a site administrator did not upgrade directly to GitHub Enterprise Server 3.4. The alerts are now visible. + changes: + - Generation of support bundles is faster as a result of parallelized log sanitization. For more information about support bundles, see "[Providing data to GitHub Support](/support/contacting-github-support/providing-data-to-github-support)." + - APIs that contain the `organization` or `org` route now accept either the organization's slug or ID. Previously, the APIs only accepted slugs, which caused `Link` headers for GitHub Advanced Security endpoints to be inaccessible. For more information, see "[Organizations](https://docs.github.com/rest/orgs/orgs)" in the REST API documentation. + - The enterprise audit log now includes more user-generated events, such as `project.create`. The REST API also returns additional user-generated events, such as `repo.create`. For more information, see "[Accessing the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)" and "[Using the audit log API for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise#querying-the-audit-log-rest-api)." + - In some cases, cache replicas could reject some Git operations on recently updated repositories. For more information about repository caching, see "[About repository caching](/admin/enterprise-management/caching-repositories/about-repository-caching)." + - You can now configure the global announcement banner to be dismissable using the REST API. For more information, see "[Customizing user messages for your enterprise](/admin/user-management/managing-users-in-your-enterprise/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner)." + known_issues: + - On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user. + - Custom firewall rules are removed during the upgrade process. + - Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository. + - Issues cannot be closed if they contain a permalink to a blob in the same repository, where the blob's file path is longer than 255 characters. + - When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results. + - The {% data variables.product.prodname_registry %} npm registry no longer returns a time value in metadata responses. This was done to allow for substantial performance improvements. We continue to have all the data necessary to return a time value as part of the metadata response and will resume returning this value in the future once we have solved the existing performance issues. + - Resource limits that are specific to processing pre-receive hooks may cause some pre-receive hooks to fail. + - Actions services need to be restarted after restoring an instance from a backup taken on a different host. + - In a repository's settings, enabling the option to allow users with read access to create discussions does not enable this functionality. + - In some cases, users cannot convert existing issues to discussions. + - Custom patterns for secret scanning have `.*` as an end delimiter, specifically in the "After secret" field. This delimiter causes inconsistencies in scans for secrets across repositories, and you may notice gaps in a repository's history where no scans completed. Incremental scans may also be impacted. To prevent issues with scans, modify the end of the pattern to remove the `.*` delimiter. diff --git a/data/reusables/actions/about-runner-groups.md b/data/reusables/actions/about-runner-groups.md new file mode 100644 index 000000000000..a2d79bdc09f6 --- /dev/null +++ b/data/reusables/actions/about-runner-groups.md @@ -0,0 +1,18 @@ +{% ifversion fpt %} +{% note %} + +**Note:** All organizations have a single default runner group. Only enterprise accounts and organizations owned by enterprise accounts can create and manage additional runner groups. + +{% endnote %} + +Runner groups are used to control access to runners. Organization admins can configure access policies that control which repositories in an organization have access to the runner group. + +If you use {% data variables.product.prodname_ghe_cloud %}, you can create additional runner groups; enterprise admins can configure access policies that control which organizations in an enterprise have access to the runner group; and organization admins can assign additional granular repository access policies to the enterprise runner group. +{% endif -%} +{% ifversion ghec or ghes or ghae %} + +{% data reusables.actions.runner-group-enterprise-overview %} + +When new runners are created, they are automatically assigned to the default group. Runners can only be in one group at a time. You can move runners from the default group to another group. For more information, see "[Moving a runner to a group](#moving-a-runner-to-a-group)." + +{% endif %} \ No newline at end of file diff --git a/data/reusables/actions/actions-billing.md b/data/reusables/actions/actions-billing.md index 249d4b339abf..453bd9ef77d0 100644 --- a/data/reusables/actions/actions-billing.md +++ b/data/reusables/actions/actions-billing.md @@ -1 +1 @@ -{% data variables.product.prodname_actions %} usage is free for both public repositories and self-hosted runners. For private repositories, each {% data variables.product.prodname_dotcom %} account receives a certain amount of free minutes and storage, depending on the product used with the account. Any usage beyond the included amounts is controlled by spending limits. +{% data variables.product.prodname_actions %} usage is free for standard {% data variables.product.prodname_dotcom %}-hosted runners in public repositories, and for self-hosted runners. For private repositories, each {% data variables.product.prodname_dotcom %} account receives a certain amount of free minutes and storage for use with {% data variables.product.prodname_dotcom %}-hosted runners, depending on the product used with the account. Any usage beyond the included amounts is controlled by spending limits. diff --git a/data/reusables/actions/add-hosted-runner-overview.md b/data/reusables/actions/add-hosted-runner-overview.md new file mode 100644 index 000000000000..bdd66230ca0a --- /dev/null +++ b/data/reusables/actions/add-hosted-runner-overview.md @@ -0,0 +1,3 @@ +You can choose an operating system and a hardware configuration from the list of available options. When new instances of this runner are deployed through autoscaling, they'll use the same operating system and hardware configuration you've defined here. + +You can also define the labels that identify the runner, which is how your workflows will be able to send jobs to the runners for processing (using `runs-on`). New runners are automatically assigned to the default group, or you can choose which group the runners must join during the runner creation process. In addition, you can modify the runner's group membership after you've registered the runner. For more information, see "[Controlling access to {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/controlling-access-to-larger-runners)." \ No newline at end of file diff --git a/data/reusables/actions/add-hosted-runner.md b/data/reusables/actions/add-hosted-runner.md new file mode 100644 index 000000000000..d533864a2e21 --- /dev/null +++ b/data/reusables/actions/add-hosted-runner.md @@ -0,0 +1,11 @@ +1. Click **New runner**, then click **{% octicon "mark-github" aria-label="New hosted runner" %} New Github-hosted runner**. +1. Complete the required details to configure your new runner: + + - **Name**: Enter a name for your new runner. For easier identification, this should indicate its hardware and operating configuration, such as `ubuntu-20.04-16core`. + - **Runner image**: Choose an operating system from the available options. Once you've selected an operating system, you will be able to choose a specific version. + - **Runner size**: Choose a hardware configuration from the drop-down list of available options. + - **Auto-scaling**: Choose the maximum number of runners that can be active at any time. + - **Runner group**: Choose the group that your runner will be a member of. This group will host multiple instances of your runner, as they scale up and down to suit demand. + - **Networking**: Only for {% data variables.product.prodname_ghe_cloud %}: Choose whether a static IP address range will be assigned to instances of the {% data variables.actions.hosted_runner %}. You can use up to 10 static IP addresses in total. + +1. Click **Create runner**. \ No newline at end of file diff --git a/data/reusables/actions/automatically-adding-a-runner-to-a-group.md b/data/reusables/actions/automatically-adding-a-runner-to-a-group.md new file mode 100644 index 000000000000..c76b2a5efc1c --- /dev/null +++ b/data/reusables/actions/automatically-adding-a-runner-to-a-group.md @@ -0,0 +1,11 @@ +You can use the configuration script to automatically add a new runner to a group. For example, this command registers a new runner and uses the `--runnergroup` parameter to add it to a group named `rg-runnergroup`. + +```sh +./config.sh --url $org_or_enterprise_url --token $token --runnergroup rg-runnergroup +``` + +The command will fail if the runner group doesn't exist: + +``` +Could not find any self-hosted runner group named "rg-runnergroup". +``` \ No newline at end of file diff --git a/data/reusables/actions/changing-the-access-policy-of-a-runner-group.md b/data/reusables/actions/changing-the-access-policy-of-a-runner-group.md new file mode 100644 index 000000000000..f0234d5b88a0 --- /dev/null +++ b/data/reusables/actions/changing-the-access-policy-of-a-runner-group.md @@ -0,0 +1,38 @@ +{% comment %} + +Always include a security admonition above this procedure. This is either one of the following, depending on whether the context is self-hosted runners or larger runners. + +{% data reusables.actions.self-hosted-runner-security-admonition %} +{% data reusables.actions.hosted-runner-security-admonition %} + +{% endcomment %} + +For runner groups in an enterprise, you can change what organizations in the enterprise can access a runner group{% ifversion restrict-groups-to-workflows %} or restrict what workflows a runner group can run{% endif %}. For runner groups in an organization, you can change what repositories in the organization can access a runner group{% ifversion restrict-groups-to-workflows %} or restrict what workflows a runner group can run{% endif %}. + +### Changing what organizations or repositories can access a runner group + +{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %} +{% data reusables.actions.runner-groups-navigate-to-repo-org-enterprise %} +{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %} +1. For runner groups in an enterprise, under **Organization access**, modify what organizations can access the runner group. For runner groups in an organization, under **Repository access**, modify what repositories can access the runner group. + +{% elsif ghae or ghes < 3.4 %} +{% data reusables.actions.configure-runner-group-access %} +{% endif %} + +{% ifversion restrict-groups-to-workflows %} +### Changing what workflows can access a runner group +You can configure a runner group to run either selected workflows or all workflows. For example, you might use this setting to protect secrets that are stored on runners or to standardize deployment workflows by restricting a runner group to run only a specific reusable workflow. This setting cannot be overridden if you are configuring an organization's runner group that was shared by an enterprise. +{% data reusables.actions.runner-groups-navigate-to-repo-org-enterprise %} +{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %} +1. Under **Workflow access**, select the dropdown menu and click **Selected workflows**. +1. Click {% octicon "gear" aria-label="the gear icon" %}. +1. Enter a comma separated list of the workflows that can access the runner group. Use the full path, including the repository name and owner. Pin the workflow to a branch, tag, or full SHA. For example: `octo-org/octo-repo/.github/workflows/build.yml@v2, octo-org/octo-repo/.github/workflows/deploy.yml@d6dc6c96df4f32fa27b039f2084f576ed2c5c2a5, monalisa/octo-test/.github/workflows/test.yml@main`. + + Only jobs directly defined within the selected workflows will have access to the runner group. + + Organization-owned runner groups cannot access workflows from a different organization in the enterprise; instead, you must create an enterprise-owned runner group. + +1. Click **Save**. + +{% endif %} \ No newline at end of file diff --git a/data/reusables/actions/changing-the-name-of-a-runner-group.md b/data/reusables/actions/changing-the-name-of-a-runner-group.md new file mode 100644 index 000000000000..0c97c37769aa --- /dev/null +++ b/data/reusables/actions/changing-the-name-of-a-runner-group.md @@ -0,0 +1,9 @@ +{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %} +{% data reusables.actions.runner-groups-navigate-to-repo-org-enterprise %} +{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %} +1. Change the runner group name. + +{% elsif ghae or ghes < 3.4 %} +{% data reusables.actions.configure-runner-group %} +1. Change the runner group name. +{% endif %} \ No newline at end of file diff --git a/data/reusables/actions/self-hosted-runner-configure-runner-group-access.md b/data/reusables/actions/configure-runner-group-access.md similarity index 84% rename from data/reusables/actions/self-hosted-runner-configure-runner-group-access.md rename to data/reusables/actions/configure-runner-group-access.md index 98b6a96c01ba..42999d8e42f6 100644 --- a/data/reusables/actions/self-hosted-runner-configure-runner-group-access.md +++ b/data/reusables/actions/configure-runner-group-access.md @@ -1,4 +1,4 @@ -{% data reusables.actions.self-hosted-runner-configure-runner-group %} +{% data reusables.actions.configure-runner-group %} 1. Modify your policy options. {% ifversion not ghae %} diff --git a/data/reusables/actions/self-hosted-runner-configure-runner-group.md b/data/reusables/actions/configure-runner-group.md similarity index 100% rename from data/reusables/actions/self-hosted-runner-configure-runner-group.md rename to data/reusables/actions/configure-runner-group.md diff --git a/data/reusables/actions/self-hosted-runner-create-group.md b/data/reusables/actions/create-runner-group.md similarity index 100% rename from data/reusables/actions/self-hosted-runner-create-group.md rename to data/reusables/actions/create-runner-group.md diff --git a/data/reusables/actions/creating-a-runner-group-for-an-enterprise.md b/data/reusables/actions/creating-a-runner-group-for-an-enterprise.md new file mode 100644 index 000000000000..e1c66d708e06 --- /dev/null +++ b/data/reusables/actions/creating-a-runner-group-for-an-enterprise.md @@ -0,0 +1,28 @@ +{% comment %} + +Always include a security admonition above this procedure. This is either one of the following, depending on whether the context is self-hosted runners or larger runners. + +{% data reusables.actions.self-hosted-runner-security-admonition %} +{% data reusables.actions.hosted-runner-security-admonition %} + +{% endcomment %} + +Enterprises can add their runners to groups for access management. Enterprises can create groups of runners that are accessible to specific organizations in the enterprise account{% ifversion restrict-groups-to-workflows %} or to specific workflows{% endif %}. Organization owners can then assign additional granular repository{% ifversion restrict-groups-to-workflows %} or workflow{% endif %} access policies to the enterprise runner groups. For information about how to create a runner group with the REST API, see the enterprise endpoints in the [{% data variables.product.prodname_actions %} REST API](/rest/reference/actions#self-hosted-runner-groups). + +Runners are automatically assigned to the default group when created, and can only be members of one group at a time. You can assign the runner to a specific group during the registration process, or you can later move the runner from the default group to a custom group. + +When creating a group, you must choose a policy that defines which organizations have access to the runner group. + +{% data reusables.actions.runner-groups-add-to-enterprise-first-steps %} +1. To choose a policy for organization access, select the **Organization access** drop-down, and click a policy. You can configure a runner group to be accessible to a specific list of organizations, or all organizations in the enterprise.{% ifversion ghes %} By default, only private repositories can access runners in a runner group, but you can override this.{% endif %} + + {%- ifversion ghec or ghes %} + + ![Add runner group options](/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png) + {%- elsif ghae %} + + ![Add runner group options](/assets/images/help/settings/actions-enterprise-account-add-runner-group-options-ae.png) + {%- endif %} +{% data reusables.actions.runner-group-assign-policy-workflow %} +1. Click **Save group** to create the group and apply the policy. + diff --git a/data/reusables/actions/creating-a-runner-group-for-an-organization.md b/data/reusables/actions/creating-a-runner-group-for-an-organization.md new file mode 100644 index 000000000000..91fa89d19587 --- /dev/null +++ b/data/reusables/actions/creating-a-runner-group-for-an-organization.md @@ -0,0 +1,38 @@ +{% comment %} + +Always include a security admonition above this procedure. This is either one of the following, depending on whether the context is self-hosted runners or larger runners. + +{% data reusables.actions.self-hosted-runner-security-admonition %} +{% data reusables.actions.hosted-runner-security-admonition %} + +{% endcomment %} + +All organizations have a single default runner group. Organizations within an enterprise account can create additional groups. Organization admins can allow individual repositories access to a runner group. For information about how to create a runner group with the REST API, see "[Self-hosted runner groups](/rest/reference/actions#self-hosted-runner-groups)." + +Runners are automatically assigned to the default group when created, and can only be members of one group at a time. You can move a runner from the default group to any group you create. + +When creating a group, you must choose a policy that defines which repositories{% ifversion restrict-groups-to-workflows %} and workflows{% endif %} have access to the runner group. + +{% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %} +{% data reusables.organizations.navigate-to-org %} +{% data reusables.organizations.org_settings %} +{% data reusables.organizations.settings-sidebar-actions-runner-groups %} +1. In the "Runner groups" section, click **New runner group**. +1. Enter a name for your runner group. + {% data reusables.actions.runner-group-assign-policy-repo %} +{% data reusables.actions.runner-group-assign-policy-workflow %}{%- ifversion restrict-groups-to-workflows %} Organization-owned runner groups cannot access workflows from a different organization in the enterprise; instead, you must create an enterprise-owned runner group.{% endif %} +{% data reusables.actions.create-runner-group %} +{% elsif ghae or ghes < 3.4 %} +{% data reusables.organizations.navigate-to-org %} +{% data reusables.organizations.org_settings %} +{% data reusables.organizations.settings-sidebar-actions-runner-groups %} +1. Under {% ifversion ghes or ghae %}"Runners"{% endif %}, click **Add new**, and then **New group**. + + ![Add runner group](/assets/images/help/settings/actions-org-add-runner-group.png) +1. Enter a name for your runner group, and assign a policy for repository access. + + You can configure a runner group to be accessible to a specific list of repositories, or to all repositories in the organization.{% ifversion ghec or ghes %} By default, only private repositories can access runners in a runner group, but you can override this. This setting can't be overridden if configuring an organization's runner group that was shared by an enterprise.{% endif %} + + ![Add runner group options](/assets/images/help/settings/actions-org-add-runner-group-options.png) +1. Click **Save group** to create the group and apply the policy. +{% endif %} \ No newline at end of file diff --git a/data/reusables/actions/hosted-runner-security-admonition.md b/data/reusables/actions/hosted-runner-security-admonition.md new file mode 100644 index 000000000000..8c33797d55d7 --- /dev/null +++ b/data/reusables/actions/hosted-runner-security-admonition.md @@ -0,0 +1,5 @@ +{% warning %} + +**Warning**: {% data reusables.actions.hosted-runner-security %} + +{% endwarning %} \ No newline at end of file diff --git a/data/reusables/actions/hosted-runner-security.md b/data/reusables/actions/hosted-runner-security.md new file mode 100644 index 000000000000..ed12d189db73 --- /dev/null +++ b/data/reusables/actions/hosted-runner-security.md @@ -0,0 +1,3 @@ +We recommend that you only use {% data variables.actions.hosted_runner %}s with private repositories: +- Forks of your repository can potentially run dangerous code on your {% data variables.actions.hosted_runner %} by creating a pull request that executes the code in a workflow. +- You could incur unexpected costs if you allow forked repositories to run jobs on your {% data variables.actions.hosted_runner %}s. \ No newline at end of file diff --git a/data/reusables/actions/jobs/section-running-jobs-in-a-container.md b/data/reusables/actions/jobs/section-running-jobs-in-a-container.md index 7c9ff2e3fab9..fc6f5e5404c6 100644 --- a/data/reusables/actions/jobs/section-running-jobs-in-a-container.md +++ b/data/reusables/actions/jobs/section-running-jobs-in-a-container.md @@ -2,6 +2,12 @@ Use `jobs..container` to create a container to run any steps in a job th If you do not set a `container`, all steps will run directly on the host specified by `runs-on` unless a step refers to an action configured to run in a container. +{% note %} + +**Note:** The default shell for `run` steps inside a container is `sh` instead of `bash`. This can be overridden with [`jobs..defaults.run`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_iddefaultsrun) or [`jobs..steps[*].shell`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell). + +{% endnote %} + ### Example: Running a job within a container ```yaml{:copy} diff --git a/data/reusables/actions/moving-a-runner-to-a-group.md b/data/reusables/actions/moving-a-runner-to-a-group.md new file mode 100644 index 000000000000..9686c85aa30e --- /dev/null +++ b/data/reusables/actions/moving-a-runner-to-a-group.md @@ -0,0 +1,15 @@ +If you don't specify a runner group during the registration process, your new runners are automatically assigned to the default group, and can then be moved to another group. + +{% data reusables.actions.self-hosted-runner-navigate-to-org-enterprise %} +{% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %} +1. In the "Runners" list, click the runner that you want to configure. +2. Select the **Runner group** drop-down. +3. In "Move runner to group", choose a destination group for the runner. +{% elsif ghae or ghes < 3.4 %} +1. In the {% ifversion ghes or ghae %}"Runner groups"{% endif %} section of the settings page, locate the current group of the runner you want to move and expand the list of group members. + ![View runner group members](/assets/images/help/settings/actions-org-runner-group-members.png) +2. Select the checkbox next to the self-hosted runner, and then click **Move to group** to see the available destinations. + ![Runner group member move](/assets/images/help/settings/actions-org-runner-group-member-move.png) +3. To move the runner, click on the destination group. + ![Runner group member move](/assets/images/help/settings/actions-org-runner-group-member-move-destination.png) +{% endif %} \ No newline at end of file diff --git a/data/reusables/actions/removing-a-runner-group.md b/data/reusables/actions/removing-a-runner-group.md new file mode 100644 index 000000000000..1703d7e04418 --- /dev/null +++ b/data/reusables/actions/removing-a-runner-group.md @@ -0,0 +1,9 @@ +Runners are automatically returned to the default group when their group is removed. + +{% ifversion ghes or ghae or ghec %} +{% data reusables.actions.runner-groups-navigate-to-repo-org-enterprise %} +1. In the list of groups, to the right of the group you want to delete, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}. +2. To remove the group, click **Remove group**. +3. Review the confirmation prompts, and click **Remove this runner group**. Any runners still in this group will be automatically moved to the default group, where they will inherit the access permissions assigned to that group. + +{% endif %} \ No newline at end of file diff --git a/data/reusables/actions/runner-group-enterprise-overview.md b/data/reusables/actions/runner-group-enterprise-overview.md new file mode 100644 index 000000000000..516bccdefe90 --- /dev/null +++ b/data/reusables/actions/runner-group-enterprise-overview.md @@ -0,0 +1,3 @@ +Runner groups are used to control access to runners at the organization and enterprise level. Enterprise owners can configure access policies that control which organizations {% ifversion restrict-groups-to-workflows %}and workflows {% endif %}in an enterprise have access to the runner group. Organization owners can configure access policies that control which repositories{% ifversion restrict-groups-to-workflows %} and workflows{% endif %} in an organization have access to the runner group. + +When an enterprise owner grants access to a runner group, organization owners can see the runner group listed in the organization's runner settings. The organization owners can then assign additional granular repository{% ifversion restrict-groups-to-workflows %} and workflow{% endif %} access policies to the enterprise runner group. \ No newline at end of file diff --git a/data/reusables/actions/self-hosted-runner-groups-add-to-enterprise-first-steps.md b/data/reusables/actions/runner-groups-add-to-enterprise-first-steps.md similarity index 100% rename from data/reusables/actions/self-hosted-runner-groups-add-to-enterprise-first-steps.md rename to data/reusables/actions/runner-groups-add-to-enterprise-first-steps.md diff --git a/data/reusables/actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md b/data/reusables/actions/runner-groups-navigate-to-repo-org-enterprise.md similarity index 89% rename from data/reusables/actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md rename to data/reusables/actions/runner-groups-navigate-to-repo-org-enterprise.md index 4819bd92eb97..b4680b1ee5ec 100644 --- a/data/reusables/actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md +++ b/data/reusables/actions/runner-groups-navigate-to-repo-org-enterprise.md @@ -1,9 +1,9 @@ {% ifversion fpt %} -1. Navigate to the main page of the repository or organization where your self-hosted runner groups are located. +1. Navigate to the main page of the repository or organization where your runner groups are located. 2. Click {% octicon "gear" aria-label="The Settings gear" %} **Settings**. {% data reusables.organizations.settings-sidebar-actions-runner-groups %} {% elsif ghec or ghes or ghae %} -1. Navigate to where your self-hosted runner groups are located: +1. Navigate to where your runner groups are located: * **In an organization**: navigate to the main page and click {% octicon "gear" aria-label="The Settings gear" %} **Settings**. * **If using an enterprise-level group**: diff --git a/data/reusables/actions/self-hosted-runner-add-to-enterprise.md b/data/reusables/actions/self-hosted-runner-add-to-enterprise.md index ac0187078c1a..d328def7f768 100644 --- a/data/reusables/actions/self-hosted-runner-add-to-enterprise.md +++ b/data/reusables/actions/self-hosted-runner-add-to-enterprise.md @@ -3,7 +3,7 @@ {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} {% data reusables.enterprise-accounts.actions-runners-tab %} -1. Click **New runner**. +{% ifversion actions-hosted-runners %}1. Click **New runner**, then click **New self-hosted runner**.{% else %}1. Click **New runner**.{% endif %} {% data reusables.actions.self-hosted-runner-configure %} {%- elsif ghae or ghes < 3.4 %} To add a self-hosted runner to an enterprise, you must be an enterprise owner. diff --git a/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md b/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md index 589308b1e4b0..6c884cdb9753 100644 --- a/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md +++ b/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md @@ -3,7 +3,7 @@ 2. Click {% octicon "gear" aria-label="The Settings gear" %} **Settings**. {% data reusables.organizations.settings-sidebar-actions-runners %} {% elsif ghec or ghes or ghae %} -1. Navigate to where your self-hosted runner is registered: +1. Navigate to where your runner is registered: * **In an organization**: navigate to the main page and click {% octicon "gear" aria-label="The Settings gear" %} **Settings**. * **If using an enterprise-level runner**: diff --git a/data/reusables/actions/self-hosted-runner-navigate-to-repo-org-enterprise.md b/data/reusables/actions/self-hosted-runner-navigate-to-repo-org-enterprise.md index 47a1613bb514..b43bfa22c6e3 100644 --- a/data/reusables/actions/self-hosted-runner-navigate-to-repo-org-enterprise.md +++ b/data/reusables/actions/self-hosted-runner-navigate-to-repo-org-enterprise.md @@ -3,7 +3,7 @@ 2. Click {% octicon "gear" aria-label="The Settings gear" %} **Settings**. {% data reusables.organizations.settings-sidebar-actions-runners %} {% elsif ghec or ghes or ghae %} -1. Navigate to where your self-hosted runner is registered: +1. Navigate to where your runner is registered: * **In an organization or repository**: navigate to the main page and click {% octicon "gear" aria-label="The Settings gear" %} **Settings**. * **If using an enterprise-level runner**: diff --git a/data/reusables/actions/self-hosted-runner-security-admonition.md b/data/reusables/actions/self-hosted-runner-security-admonition.md new file mode 100644 index 000000000000..3070a6394f67 --- /dev/null +++ b/data/reusables/actions/self-hosted-runner-security-admonition.md @@ -0,0 +1,7 @@ +{% warning %} + +**Warning**: {% data reusables.actions.self-hosted-runner-security %} + +For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." + +{% endwarning %} \ No newline at end of file diff --git a/data/reusables/actions/self-hosted-runner-security.md b/data/reusables/actions/self-hosted-runner-security.md index 0d4c1556b1bb..c90b1938d49a 100644 --- a/data/reusables/actions/self-hosted-runner-security.md +++ b/data/reusables/actions/self-hosted-runner-security.md @@ -1 +1 @@ -We recommend that you only use self-hosted runners with private repositories. This is because forks of your repository can potentially run dangerous code on your self-hosted runner machine by creating a pull request that executes the code in a workflow. +We recommend that you only use self-hosted runners with private repositories. This is because forks of your public repository can potentially run dangerous code on your self-hosted runner machine by creating a pull request that executes the code in a workflow. \ No newline at end of file diff --git a/data/reusables/billing/billing-hosted-runners.md b/data/reusables/billing/billing-hosted-runners.md new file mode 100644 index 000000000000..6b04d05ac21d --- /dev/null +++ b/data/reusables/billing/billing-hosted-runners.md @@ -0,0 +1,9 @@ +| Linux | 4 | $0.016 | +| Linux | 8 | $0.032 | +| Linux | 16 | $0.064 | +| Linux | 32 | $0.128 | +| Linux | 64 | $0.256 | +| Windows | 8 | $0.064 | +| Windows | 16 | $0.128 | +| Windows | 32 | $0.256 | +| Windows | 64 | $0.512 | \ No newline at end of file diff --git a/data/reusables/billing/billing-standard-runners.md b/data/reusables/billing/billing-standard-runners.md new file mode 100644 index 000000000000..c3dc2b3ec351 --- /dev/null +++ b/data/reusables/billing/billing-standard-runners.md @@ -0,0 +1,5 @@ +| Operating system | Cores | Per-minute rate (USD) | +|------- | --------- | --------- | +| Linux | 2 | $0.008 | +| macOS | 3 | $0.08 | +| Windows | 2 | $0.016 | diff --git a/data/reusables/code-scanning/example-configuration-files.md b/data/reusables/code-scanning/example-configuration-files.md index f429bb12cfd6..a55b33e6067e 100644 --- a/data/reusables/code-scanning/example-configuration-files.md +++ b/data/reusables/code-scanning/example-configuration-files.md @@ -30,3 +30,22 @@ paths-ignore: - src/node_modules - '**/*.test.js' ``` + +{% ifversion code-scanning-exclude-queries-from-analysis %} + +The following configuration file only runs queries that generate alerts of severity error. The configuration first selects all the default queries, all queries in `./my-queries`, and the default suite in `codeql/java-queries`, then excludes all the queries that generate warnings or recommendations. + +``` yaml +queries: + - name: Use an in-repository QL pack (run queries in the my-queries directory) + uses: ./my-queries +packs: + - codeql/java-queries +query-filters: +- exclude: + problem.severity: + - warning + - recommendation +``` + +{% endif %} \ No newline at end of file diff --git a/data/reusables/code-scanning/run-additional-queries.md b/data/reusables/code-scanning/run-additional-queries.md index 3f25bd67d1b3..fddae57c6268 100644 --- a/data/reusables/code-scanning/run-additional-queries.md +++ b/data/reusables/code-scanning/run-additional-queries.md @@ -1,5 +1,13 @@ When you use {% data variables.product.prodname_codeql %} to scan code, the {% data variables.product.prodname_codeql %} analysis engine generates a database from the code and runs queries on it. {% data variables.product.prodname_codeql %} analysis uses a default set of queries, but you can specify more queries to run, in addition to the default queries. +{% ifversion code-scanning-exclude-queries-from-analysis %} +{% tip %} + +You can also specify the queries you want to exclude from analysis, or include in the analysis. This requires the use of a custom configuration file. For more information, see "[Using a custom configuration file](#using-a-custom-configuration-file)" and "[Excluding specific queries from analysis](#excluding-specific-queries-from-analysis) " below. + +{% endtip %} +{% endif %} + {% ifversion codeql-packs %} You can run extra queries if they are part of a {% data variables.product.prodname_codeql %} pack (beta) published to the {% data variables.product.company_short %} {% data variables.product.prodname_container_registry %} or a {% data variables.product.prodname_ql %} pack stored in a repository. For more information, see "[About {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql#about-codeql-queries)." diff --git a/data/reusables/codespaces/codespaces-org-policies-note.md b/data/reusables/codespaces/codespaces-org-policies-note.md index 69e653079137..90604549480a 100644 --- a/data/reusables/codespaces/codespaces-org-policies-note.md +++ b/data/reusables/codespaces/codespaces-org-policies-note.md @@ -1,5 +1,5 @@ {% note %} -**Note**: Organization policies you define for {% data variables.product.prodname_codespaces %} only apply to codespaces for which your organization will be billed. If an individual user creates a codespace for a repository in your organization, and the organization is not billed, then the codespace will not be bound by these policies. For information on how to choose who can create codespaces that are billed to your organization, see "[Enabling {% data variables.product.prodname_github_codespaces %} for your organization](https://docs-internal-29134-ad7bd8.preview.ghdocs.com/en/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization#choose-who-can-create-codespaces-that-are-billed-to-your-organization)." +**Note**: Organization policies you define for {% data variables.product.prodname_codespaces %} only apply to codespaces for which your organization will be billed. If an individual user creates a codespace for a repository in your organization, and the organization is not billed, then the codespace will not be bound by these policies. For information on how to choose who can create codespaces that are billed to your organization, see "[Enabling {% data variables.product.prodname_github_codespaces %} for your organization](/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization#choose-who-can-create-codespaces-that-are-billed-to-your-organization)." {% endnote %} \ No newline at end of file diff --git a/data/reusables/codespaces/open-codespace-from-template-repo.md b/data/reusables/codespaces/open-codespace-from-template-repo.md new file mode 100644 index 000000000000..610c2f920de5 --- /dev/null +++ b/data/reusables/codespaces/open-codespace-from-template-repo.md @@ -0,0 +1,8 @@ +1. Select an owner for the new repository, enter a repository name, select your preferred privacy setting, and click **Create repository from template**. +1. On the main page of the newly created repository, click the **{% octicon "code" aria-label="The code icon" %} Code** button and select the **Codespaces** tab. + + ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) + + If you don’t see this tab, {% data variables.product.prodname_github_codespaces %} isn't available for you. For more information about access to {% data variables.product.prodname_github_codespaces %}, see "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-github-codespaces)." + +1. On the **Codespaces** tab, click **Create codespace on main**. diff --git a/data/reusables/codespaces/rebuild-command.md b/data/reusables/codespaces/rebuild-command.md index 09f44e08b175..5247bdfa0f0d 100644 --- a/data/reusables/codespaces/rebuild-command.md +++ b/data/reusables/codespaces/rebuild-command.md @@ -1,5 +1,3 @@ -1. Access the {% data variables.product.prodname_vscode_command_palette %} (Shift + Command + P / Ctrl + Shift + P), then start typing "rebuild". Select **Codespaces: Rebuild Container**. +1. Access the {% data variables.product.prodname_vscode_command_palette_shortname %} (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)), then start typing "rebuild". Select **Codespaces: Rebuild Container**. ![Rebuild container option](/assets/images/help/codespaces/codespaces-rebuild.png) - - diff --git a/data/reusables/codespaces/remote-explorer.md b/data/reusables/codespaces/remote-explorer.md index c46ed9b53925..545bdcf0c91d 100644 --- a/data/reusables/codespaces/remote-explorer.md +++ b/data/reusables/codespaces/remote-explorer.md @@ -2,7 +2,7 @@ **Note**: If the Remote Explorer is not displayed in the Activity Bar: -1. Access the command palette. For example, by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux). +1. Access the Command Palette. For example, by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux). 1. Type: `codespaces`. 1. Click **Codespaces: Details**. diff --git a/data/reusables/dependabot/dependabot-alerts-filters.md b/data/reusables/dependabot/dependabot-alerts-filters.md index 31056c274fec..016833a8bddd 100644 --- a/data/reusables/dependabot/dependabot-alerts-filters.md +++ b/data/reusables/dependabot/dependabot-alerts-filters.md @@ -2,7 +2,7 @@ You can sort and filter {% data variables.product.prodname_dependabot_alerts %} | Option | Description | Example | |:---|:---|:---| -| `ecosystem` | Displays alerts for the selected ecosystem | Use `ecosystem:npm` to show {% data variables.product.prodname_dependabot_alerts %} for npm |{% ifversion fpt or ghec or ghes > 3.5 %} +| `ecosystem` | Displays alerts for the selected ecosystem | Use `ecosystem:npm` to show {% data variables.product.prodname_dependabot_alerts %} for npm |{% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-7891 %} | `has` | Displays alerts meeting the selected filter criteria | Use `has:patch` to show alerts related to advisories that have a patch{% ifversion dependabot-alerts-vulnerable-calls %}
Use `has:vulnerable-calls` to show alerts relating to calls to vulnerable functions{% endif %} |{% endif %} | `is` | Displays alerts based on their state | Use `is:open` to show open alerts | | `manifest` | Displays alerts for the selected manifest | Use `manifest:webwolf/pom.xml` to show alerts on the pom.xml file of the webwolf application | diff --git a/data/reusables/dependency-review/dependency-review-action-beta-note.md b/data/reusables/dependency-review/dependency-review-action-beta-note.md index 01b1e2f26029..23aaae3ec267 100644 --- a/data/reusables/dependency-review/dependency-review-action-beta-note.md +++ b/data/reusables/dependency-review/dependency-review-action-beta-note.md @@ -2,4 +2,4 @@ **Note**: The {% data variables.product.prodname_dependency_review_action %} is currently in public beta and subject to change. -{% endnote %} +{% endnote %} \ No newline at end of file diff --git a/data/reusables/dependency-review/dependency-review-action-overview.md b/data/reusables/dependency-review/dependency-review-action-overview.md index fdfb2f6f8c34..d3b89434d276 100644 --- a/data/reusables/dependency-review/dependency-review-action-overview.md +++ b/data/reusables/dependency-review/dependency-review-action-overview.md @@ -1,3 +1,3 @@ The {% data variables.product.prodname_dependency_review_action %} scans your pull requests for dependency changes and raises an error if any new dependencies have known vulnerabilities. The action is supported by an API endpoint that compares the dependencies between two revisions and reports any differences. -For more information about the action and the API endpoint, see "[About dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-reinforcement)," and "[Dependency review](/rest/dependency-graph/dependency-review)" in the API documentation, respectively. +For more information about the action and the API endpoint, see the [`dependency-review-action`](https://github.com/actions/dependency-review-action) documentation, and "[Dependency review](/rest/dependency-graph/dependency-review)" in the API documentation. diff --git a/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md b/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md index c5d610006352..d9e308eee95d 100644 --- a/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md +++ b/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md @@ -1,4 +1,4 @@ -1. Define the key as a environment variable for {% data variables.product.product_name %}, replacing `` with the GPG key ID. +1. Define the key as an environment variable for {% data variables.product.product_name %}, replacing `` with the GPG key ID. ```bash{:copy} ghe-config "secrets.gpgverify.web-signing-key" "$(gpg --export-secret-keys -a | awk '{printf "%s\\n", $0}')" diff --git a/data/reusables/gated-features/hosted-runners.md b/data/reusables/gated-features/hosted-runners.md new file mode 100644 index 000000000000..4f1e2137bbfb --- /dev/null +++ b/data/reusables/gated-features/hosted-runners.md @@ -0,0 +1 @@ +The {% data variables.actions.hosted_runner %}s feature is currently in beta for organizations and enterprises using the {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %} plans, and is subject to change. \ No newline at end of file diff --git a/data/reusables/getting-started/bearer-vs-token.md b/data/reusables/getting-started/bearer-vs-token.md new file mode 100644 index 000000000000..9dd0b62adaba --- /dev/null +++ b/data/reusables/getting-started/bearer-vs-token.md @@ -0,0 +1 @@ +In most cases, you can use `Authorization: Bearer` or `Authorization: token` to pass a token. However, if you are passing a JSON web token (JWT), you must use `Authorization: Bearer`. \ No newline at end of file diff --git a/data/reusables/identity-and-permissions/ipv6-allow-lists.md b/data/reusables/identity-and-permissions/ipv6-allow-lists.md new file mode 100644 index 000000000000..3c26491fe2fb --- /dev/null +++ b/data/reusables/identity-and-permissions/ipv6-allow-lists.md @@ -0,0 +1,7 @@ +{% ifversion fpt or ghec %} +{% note %} + +**Note:** {% data variables.product.company_short %} is gradually rolling out support for IPv6. As {% data variables.product.prodname_dotcom %} services continue to add IPv6 support, we will start recognizing IPv6 addresses of {% data variables.product.prodname_dotcom %} users. To prevent possible access interruptions, please ensure you have added any necessary IPv6 addresses to your IP allow list. + +{% endnote %} +{% endif %} \ No newline at end of file diff --git a/data/reusables/package_registry/authenticate-packages.md b/data/reusables/package_registry/authenticate-packages.md index a766f6e96d9f..5ca4e91584b2 100644 --- a/data/reusables/package_registry/authenticate-packages.md +++ b/data/reusables/package_registry/authenticate-packages.md @@ -4,4 +4,4 @@ You can use a personal access token (PAT) to authenticate to {% data variables.p To authenticate to a {% data variables.product.prodname_registry %} registry within a {% data variables.product.prodname_actions %} workflow, you can use: - `GITHUB_TOKEN` to publish packages associated with the workflow repository. -- a PAT to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). +- a PAT with at least `packages:read` scope to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). diff --git a/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md b/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md deleted file mode 100644 index a54f9a084454..000000000000 --- a/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md +++ /dev/null @@ -1,11 +0,0 @@ -{% ifversion fpt or ghec or ghes > 3.4 %} - -To authenticate to the {% data variables.product.prodname_container_registry %} within a {% data variables.product.prodname_actions %} workflow, use the `GITHUB_TOKEN` for the best security and experience. If your workflow is using a personal access token (PAT) to authenticate to `{% data reusables.package_registry.container-registry-hostname %}`, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. - -{% ifversion fpt or ghec %}For guidance on updating your workflows that authenticate to `{% data reusables.package_registry.container-registry-hostname %}` with a personal access token, see "[Upgrading a workflow that accesses `ghcr.io`](/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions#upgrading-a-workflow-that-accesses-ghcrio)."{% endif %} - -For more information about the `GITHUB_TOKEN`, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)." - -If you're using the {% data variables.product.prodname_container_registry %} in actions, follow our security best practices at "[Security hardening for GitHub Actions](/actions/getting-started-with-github-actions/security-hardening-for-github-actions#considering-cross-repository-access)." - -{% endif %} diff --git a/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md b/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md new file mode 100644 index 000000000000..023e44c78c26 --- /dev/null +++ b/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md @@ -0,0 +1,7 @@ +If your workflow is using a personal access token (PAT) to authenticate to a registry, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. + +{% ifversion fpt or ghec %}For guidance on updating your workflows that authenticate to a registry with a personal access token, see "[Upgrading a workflow that accesses a registry using a PAT](/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions#upgrading-a-workflow-that-accesses-a-registry-using-a-pat)."{% endif %} + +For more information about the `GITHUB_TOKEN`, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)." + +For more information about the best practises when using a registry in actions, see "[Security hardening for GitHub Actions](/actions/getting-started-with-github-actions/security-hardening-for-github-actions#considering-cross-repository-access)." diff --git a/data/reusables/package_registry/no-graphql-to-delete-packages.md b/data/reusables/package_registry/no-graphql-to-delete-packages.md new file mode 100644 index 000000000000..cbab609f2b0e --- /dev/null +++ b/data/reusables/package_registry/no-graphql-to-delete-packages.md @@ -0,0 +1 @@ +{% ifversion fpt or ghec %} The {% data variables.product.prodname_registry %} GraphQL API does not support containers or Docker images that use the package namespace `https://ghcr.io/OWNER/PACKAGE-NAME`, or npm images that use the package namespace `https://npm.pkg.github.com/OWNER/PACKAGE-NAME`.{% endif %} \ No newline at end of file diff --git a/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md b/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md index 14f415752840..04d9906902d9 100644 --- a/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md +++ b/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md @@ -1,8 +1,8 @@ {% ifversion ghes < 3.5 %} -In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server 3.5 or later may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 when you upgrade from an earlier release to 3.5 or later. A fix will be available in upcoming patch releases. +In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server 3.5 or later may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 when you upgrade from an earlier release to 3.5 or later. A fix is available in the [3.5.5](/enterprise-server@3.5/admin/release-notes#3.5.5) and [3.6.1](/enterprise-server@3.6/admin/release-notes#3.6.1) patch releases. -To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). [Updated: 2022-08-26] +To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). [Updated: 2022-09-01] {% elsif ghes = 3.5 or ghes = 3.6 %} @@ -11,6 +11,6 @@ In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterpri - To display the missing alerts for all repositories owned by an organization, organization owners can navigate to the organization's **Code security and analysis** settings, then click **Enable all** for secret scanning. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-existing-repositories)." - To display the missing alerts for an individual repository, people with admin access to the repository can disable then enable secret scanning for the repository. For more information, see "[Managing security and analysis settings for your repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)." -A fix will be available in an upcoming patch release. [Updated: 2022-08-26] +A fix is available in the {% ifversion ghes = 3.5 %}[3.5.5](/admin/release-notes#3.5.5){% elsif ghes = 3.6 %}[3.6.1](/admin/release-notes#3.6.1){% endif %} patch release. [Updated: 2022-09-01] {% endif %} diff --git a/data/variables/actions.yml b/data/variables/actions.yml index a7720841ca2b..5191ec655d07 100644 --- a/data/variables/actions.yml +++ b/data/variables/actions.yml @@ -1 +1,2 @@ azure_portal: 'Azure Portal' +hosted_runner: 'larger runner' diff --git a/data/variables/product.yml b/data/variables/product.yml index b7beb0e5836c..90baf844301a 100644 --- a/data/variables/product.yml +++ b/data/variables/product.yml @@ -139,6 +139,10 @@ prodname_registry: 'GitHub Packages' prodname_container_registry: 'Container registry' prodname_docker_registry_namespace: '{% ifversion fpt or ghec %}`docker.pkg.github.com`{% elsif ghes or ghae %}docker.HOSTNAME{% endif %}' prodname_container_registry_namespace: '{% ifversion fpt or ghec %}`ghcr.io`{% elsif ghes or ghae %}containers.HOSTNAME{% endif %}' +prodname_npm_registry: 'npm registry' +prodname_ghcr_and_npm_registry: '{% data variables.product.prodname_container_registry %}{% ifversion packages-npm-v2 %} and {% data variables.product.prodname_npm_registry %}{% endif %}' +prodname_ghcr_or_npm_registry: '{% data variables.product.prodname_container_registry %}{% ifversion packages-npm-v2 %} or {% data variables.product.prodname_npm_registry %}{% endif %}' +prodname_ghcr_and_npm_registry_full: '{% data variables.product.prodname_container_registry %} (`ghcr.io`){% ifversion packages-npm-v2 %} and {% data variables.product.prodname_npm_registry %} (`npm.pkg.github.com`){% endif %}' # GitHub Insights prodname_insights: 'GitHub Insights' diff --git a/lib/enterprise-dates.json b/lib/enterprise-dates.json index 2b7116b57786..a76b2e4a1772 100644 --- a/lib/enterprise-dates.json +++ b/lib/enterprise-dates.json @@ -120,7 +120,7 @@ "deprecationDate": "2023-08-16" }, "3.7": { - "releaseDate": "2022-10-04", + "releaseDate": "2022-10-18", "deprecationDate": "2023-11-08" }, "3.8": { diff --git a/lib/graphql/static/changelog.json b/lib/graphql/static/changelog.json index 99353a9e0022..c29ced108639 100644 --- a/lib/graphql/static/changelog.json +++ b/lib/graphql/static/changelog.json @@ -1,4 +1,24 @@ [ + { + "schemaChanges": [ + { + "title": "The GraphQL schema includes these changes:", + "changes": [ + "

Type MergeCommitMessage was added

", + "

Type MergeCommitTitle was added

", + "

Type SquashMergeCommitMessage was added

", + "

Type SquashMergeCommitTitle was added

", + "

Field mergeCommitMessage was added to object type Repository

", + "

Field mergeCommitTitle was added to object type Repository

", + "

Field squashMergeCommitMessage was added to object type Repository

", + "

Field squashMergeCommitTitle was added to object type Repository

" + ] + } + ], + "previewChanges": [], + "upcomingChanges": [], + "date": "2022-09-01" + }, { "schemaChanges": [ { diff --git a/lib/graphql/static/schema-dotcom.json b/lib/graphql/static/schema-dotcom.json index 81b5fe1859ad..5b78ba5963f4 100644 --- a/lib/graphql/static/schema-dotcom.json +++ b/lib/graphql/static/schema-dotcom.json @@ -55802,6 +55802,22 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "mergeCommitMessage", + "description": "

How the default commit message will be generated when merging a pull request.

", + "type": "MergeCommitMessage!", + "id": "mergecommitmessage", + "kind": "enums", + "href": "/graphql/reference/enums#mergecommitmessage" + }, + { + "name": "mergeCommitTitle", + "description": "

How the default commit title will be generated when merging a pull request.

", + "type": "MergeCommitTitle!", + "id": "mergecommittitle", + "kind": "enums", + "href": "/graphql/reference/enums#mergecommittitle" + }, { "name": "milestone", "description": "

Returns a single milestone from the current repository by number.

", @@ -56958,6 +56974,22 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "squashMergeCommitMessage", + "description": "

How the default commit message will be generated when squash merging a pull request.

", + "type": "SquashMergeCommitMessage!", + "id": "squashmergecommitmessage", + "kind": "enums", + "href": "/graphql/reference/enums#squashmergecommitmessage" + }, + { + "name": "squashMergeCommitTitle", + "description": "

How the default commit title will be generated when squash merging a pull request.

", + "type": "SquashMergeCommitTitle!", + "id": "squashmergecommittitle", + "kind": "enums", + "href": "/graphql/reference/enums#squashmergecommittitle" + }, { "name": "squashPrTitleUsedAsDefault", "description": "

Whether a squash merge commit can use the pull request title as default.

", @@ -74787,6 +74819,44 @@ } ] }, + { + "name": "MergeCommitMessage", + "kind": "enums", + "id": "mergecommitmessage", + "href": "/graphql/reference/enums#mergecommitmessage", + "description": "

The possible default commit messages for merges.

", + "values": [ + { + "name": "BLANK", + "description": "

Default to a blank commit message.

" + }, + { + "name": "PR_BODY", + "description": "

Default to the pull request's body.

" + }, + { + "name": "PR_TITLE", + "description": "

Default to the pull request's title.

" + } + ] + }, + { + "name": "MergeCommitTitle", + "kind": "enums", + "id": "mergecommittitle", + "href": "/graphql/reference/enums#mergecommittitle", + "description": "

The possible default commit titles for merges.

", + "values": [ + { + "name": "MERGE_MESSAGE", + "description": "

Default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).

" + }, + { + "name": "PR_TITLE", + "description": "

Default to the pull request's title.

" + } + ] + }, { "name": "MergeStateStatus", "kind": "enums", @@ -77534,6 +77604,44 @@ } ] }, + { + "name": "SquashMergeCommitMessage", + "kind": "enums", + "id": "squashmergecommitmessage", + "href": "/graphql/reference/enums#squashmergecommitmessage", + "description": "

The possible default commit messages for squash merges.

", + "values": [ + { + "name": "BLANK", + "description": "

Default to a blank commit message.

" + }, + { + "name": "COMMIT_MESSAGES", + "description": "

Default to the branch's commit messages.

" + }, + { + "name": "PR_BODY", + "description": "

Default to the pull request's body.

" + } + ] + }, + { + "name": "SquashMergeCommitTitle", + "kind": "enums", + "id": "squashmergecommittitle", + "href": "/graphql/reference/enums#squashmergecommittitle", + "description": "

The possible default commit titles for squash merges.

", + "values": [ + { + "name": "COMMIT_OR_PR_TITLE", + "description": "

Default to the commit's title (if only one commit) or the pull request's title (when more than one commit).

" + }, + { + "name": "PR_TITLE", + "description": "

Default to the pull request's title.

" + } + ] + }, { "name": "StarOrderField", "kind": "enums", diff --git a/lib/graphql/static/schema-ghae.json b/lib/graphql/static/schema-ghae.json index 69e6a7c5ded9..cf4819350555 100644 --- a/lib/graphql/static/schema-ghae.json +++ b/lib/graphql/static/schema-ghae.json @@ -46043,6 +46043,22 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "mergeCommitMessage", + "description": "

How the default commit message will be generated when merging a pull request.

", + "type": "MergeCommitMessage!", + "id": "mergecommitmessage", + "kind": "enums", + "href": "/graphql/reference/enums#mergecommitmessage" + }, + { + "name": "mergeCommitTitle", + "description": "

How the default commit title will be generated when merging a pull request.

", + "type": "MergeCommitTitle!", + "id": "mergecommittitle", + "kind": "enums", + "href": "/graphql/reference/enums#mergecommittitle" + }, { "name": "milestone", "description": "

Returns a single milestone from the current repository by number.

", @@ -46874,6 +46890,22 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "squashMergeCommitMessage", + "description": "

How the default commit message will be generated when squash merging a pull request.

", + "type": "SquashMergeCommitMessage!", + "id": "squashmergecommitmessage", + "kind": "enums", + "href": "/graphql/reference/enums#squashmergecommitmessage" + }, + { + "name": "squashMergeCommitTitle", + "description": "

How the default commit title will be generated when squash merging a pull request.

", + "type": "SquashMergeCommitTitle!", + "id": "squashmergecommittitle", + "kind": "enums", + "href": "/graphql/reference/enums#squashmergecommittitle" + }, { "name": "squashPrTitleUsedAsDefault", "description": "

Whether a squash merge commit can use the pull request title as default.

", @@ -61294,6 +61326,44 @@ } ] }, + { + "name": "MergeCommitMessage", + "kind": "enums", + "id": "mergecommitmessage", + "href": "/graphql/reference/enums#mergecommitmessage", + "description": "

The possible default commit messages for merges.

", + "values": [ + { + "name": "BLANK", + "description": "

Default to a blank commit message.

" + }, + { + "name": "PR_BODY", + "description": "

Default to the pull request's body.

" + }, + { + "name": "PR_TITLE", + "description": "

Default to the pull request's title.

" + } + ] + }, + { + "name": "MergeCommitTitle", + "kind": "enums", + "id": "mergecommittitle", + "href": "/graphql/reference/enums#mergecommittitle", + "description": "

The possible default commit titles for merges.

", + "values": [ + { + "name": "MERGE_MESSAGE", + "description": "

Default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).

" + }, + { + "name": "PR_TITLE", + "description": "

Default to the pull request's title.

" + } + ] + }, { "name": "MergeStateStatus", "kind": "enums", @@ -63303,6 +63373,44 @@ } ] }, + { + "name": "SquashMergeCommitMessage", + "kind": "enums", + "id": "squashmergecommitmessage", + "href": "/graphql/reference/enums#squashmergecommitmessage", + "description": "

The possible default commit messages for squash merges.

", + "values": [ + { + "name": "BLANK", + "description": "

Default to a blank commit message.

" + }, + { + "name": "COMMIT_MESSAGES", + "description": "

Default to the branch's commit messages.

" + }, + { + "name": "PR_BODY", + "description": "

Default to the pull request's body.

" + } + ] + }, + { + "name": "SquashMergeCommitTitle", + "kind": "enums", + "id": "squashmergecommittitle", + "href": "/graphql/reference/enums#squashmergecommittitle", + "description": "

The possible default commit titles for squash merges.

", + "values": [ + { + "name": "COMMIT_OR_PR_TITLE", + "description": "

Default to the commit's title (if only one commit) or the pull request's title (when more than one commit).

" + }, + { + "name": "PR_TITLE", + "description": "

Default to the pull request's title.

" + } + ] + }, { "name": "StarOrderField", "kind": "enums", diff --git a/lib/graphql/static/schema-ghec.json b/lib/graphql/static/schema-ghec.json index 81b5fe1859ad..5b78ba5963f4 100644 --- a/lib/graphql/static/schema-ghec.json +++ b/lib/graphql/static/schema-ghec.json @@ -55802,6 +55802,22 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "mergeCommitMessage", + "description": "

How the default commit message will be generated when merging a pull request.

", + "type": "MergeCommitMessage!", + "id": "mergecommitmessage", + "kind": "enums", + "href": "/graphql/reference/enums#mergecommitmessage" + }, + { + "name": "mergeCommitTitle", + "description": "

How the default commit title will be generated when merging a pull request.

", + "type": "MergeCommitTitle!", + "id": "mergecommittitle", + "kind": "enums", + "href": "/graphql/reference/enums#mergecommittitle" + }, { "name": "milestone", "description": "

Returns a single milestone from the current repository by number.

", @@ -56958,6 +56974,22 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "squashMergeCommitMessage", + "description": "

How the default commit message will be generated when squash merging a pull request.

", + "type": "SquashMergeCommitMessage!", + "id": "squashmergecommitmessage", + "kind": "enums", + "href": "/graphql/reference/enums#squashmergecommitmessage" + }, + { + "name": "squashMergeCommitTitle", + "description": "

How the default commit title will be generated when squash merging a pull request.

", + "type": "SquashMergeCommitTitle!", + "id": "squashmergecommittitle", + "kind": "enums", + "href": "/graphql/reference/enums#squashmergecommittitle" + }, { "name": "squashPrTitleUsedAsDefault", "description": "

Whether a squash merge commit can use the pull request title as default.

", @@ -74787,6 +74819,44 @@ } ] }, + { + "name": "MergeCommitMessage", + "kind": "enums", + "id": "mergecommitmessage", + "href": "/graphql/reference/enums#mergecommitmessage", + "description": "

The possible default commit messages for merges.

", + "values": [ + { + "name": "BLANK", + "description": "

Default to a blank commit message.

" + }, + { + "name": "PR_BODY", + "description": "

Default to the pull request's body.

" + }, + { + "name": "PR_TITLE", + "description": "

Default to the pull request's title.

" + } + ] + }, + { + "name": "MergeCommitTitle", + "kind": "enums", + "id": "mergecommittitle", + "href": "/graphql/reference/enums#mergecommittitle", + "description": "

The possible default commit titles for merges.

", + "values": [ + { + "name": "MERGE_MESSAGE", + "description": "

Default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).

" + }, + { + "name": "PR_TITLE", + "description": "

Default to the pull request's title.

" + } + ] + }, { "name": "MergeStateStatus", "kind": "enums", @@ -77534,6 +77604,44 @@ } ] }, + { + "name": "SquashMergeCommitMessage", + "kind": "enums", + "id": "squashmergecommitmessage", + "href": "/graphql/reference/enums#squashmergecommitmessage", + "description": "

The possible default commit messages for squash merges.

", + "values": [ + { + "name": "BLANK", + "description": "

Default to a blank commit message.

" + }, + { + "name": "COMMIT_MESSAGES", + "description": "

Default to the branch's commit messages.

" + }, + { + "name": "PR_BODY", + "description": "

Default to the pull request's body.

" + } + ] + }, + { + "name": "SquashMergeCommitTitle", + "kind": "enums", + "id": "squashmergecommittitle", + "href": "/graphql/reference/enums#squashmergecommittitle", + "description": "

The possible default commit titles for squash merges.

", + "values": [ + { + "name": "COMMIT_OR_PR_TITLE", + "description": "

Default to the commit's title (if only one commit) or the pull request's title (when more than one commit).

" + }, + { + "name": "PR_TITLE", + "description": "

Default to the pull request's title.

" + } + ] + }, { "name": "StarOrderField", "kind": "enums", diff --git a/lib/redirects/static/client-side-rest-api-redirects.json b/lib/redirects/static/client-side-rest-api-redirects.json index 025fa5f46120..9b9d657ec971 100644 --- a/lib/redirects/static/client-side-rest-api-redirects.json +++ b/lib/redirects/static/client-side-rest-api-redirects.json @@ -446,6 +446,8 @@ "/rest/teams#list-idp-groups-for-a-team": "/rest/teams/team-sync#list-idp-groups-for-a-team", "/rest/teams#create-or-update-idp-group-connections": "/rest/teams/team-sync#create-or-update-idp-group-connections", "/rest/teams#list-child-teams": "/rest/teams/teams#list-child-teams", + "/rest/orgs#enable-or-disable-security-product-on-all-org-repos": "/rest/orgs/orgs#enable-or-disable-security-product-on-all-org-repos", + "/rest/orgs#orgs": "/rest/orgs/orgs", "/rest/projects#get-a-project-card": "/rest/projects/cards#get-a-project-card", "/rest/projects#cards": "/rest/projects/cards", "/rest/projects#update-a-project-card": "/rest/projects/cards#update-a-project-card", @@ -919,6 +921,11 @@ "/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user": "/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user", "/rest/collaborators/invitations#accept-a-repository-invitation": "/rest/collaborators/invitations#accept-a-repository-invitation", "/rest/collaborators/invitations#decline-a-repository-invitation": "/rest/collaborators/invitations#decline-a-repository-invitation", + "/rest/users#list-public-ssh-signing-keys-for-the-authenticated-user": "/rest/users/ssh-signing-keys#list-public-ssh-signing-keys-for-the-authenticated-user", + "/rest/users#ssh-signing-keys": "/rest/users/ssh-signing-keys", + "/rest/users#create-an-ssh-signing-key-for-the-authenticated-user": "/rest/users/ssh-signing-keys#create-an-ssh-signing-key-for-the-authenticated-user", + "/rest/users#get-a-ssh-signing-key-for-the-authenticated-user": "/rest/users/ssh-signing-keys#get-a-ssh-signing-key-for-the-authenticated-user", + "/rest/users#delete-a-ssh-signing-key-for-the-authenticated-user": "/rest/users/ssh-signing-keys#delete-a-ssh-signing-key-for-the-authenticated-user", "/rest/activity#list-repositories-starred-by-the-authenticated-user": "/rest/activity/starring#list-repositories-starred-by-the-authenticated-user", "/rest/activity#check-if-a-repository-is-starred-by-the-authenticated-user": "/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user", "/rest/activity#star-a-repository-for-the-authenticated-user": "/rest/activity/starring#star-a-repository-for-the-authenticated-user", @@ -943,6 +950,7 @@ "/rest/activity#list-events-received-by-the-authenticated-user": "/rest/activity/events#list-events-received-by-the-authenticated-user", "/rest/activity#list-public-events-received-by-a-user": "/rest/activity/events#list-public-events-received-by-a-user", "/rest/repos#list-repositories-for-a-user": "/rest/repos/repos#list-repositories-for-a-user", + "/rest/users#list-ssh-signing-keys-for-a-user": "/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user", "/rest/activity#list-repositories-starred-by-a-user": "/rest/activity/starring#list-repositories-starred-by-a-user", "/rest/activity#list-repositories-watched-by-a-user": "/rest/activity/watching#list-repositories-watched-by-a-user", "/rest/enterprise-admin#list-global-webhooks": "/rest/enterprise-admin/global-webhooks#list-global-webhooks", diff --git a/lib/render-content/README.md b/lib/render-content/README.md index 8be088bdc65d..cc5069393826 100644 --- a/lib/render-content/README.md +++ b/lib/render-content/README.md @@ -36,7 +36,7 @@ Options: ### .liquid -The [Liquid](https://ghub.io/liquid) instance used internally. +The [Liquid](https://ghub.io/liquidjs) instance used internally. ### Code block headers diff --git a/lib/rest/static/apps/enabled-for-apps.json b/lib/rest/static/apps/enabled-for-apps.json index 9929f2596fbe..743ae27ca25b 100644 --- a/lib/rest/static/apps/enabled-for-apps.json +++ b/lib/rest/static/apps/enabled-for-apps.json @@ -2454,6 +2454,12 @@ "verb": "delete", "requestPath": "/orgs/{org}/security-managers/teams/{team_slug}" }, + { + "slug": "enable-or-disable-a-security-feature-for-an-organization", + "subcategory": "orgs", + "verb": "post", + "requestPath": "/orgs/{org}/{security_product}/{enablement}" + }, { "slug": "list-organizations-for-a-user", "subcategory": "orgs", @@ -3798,6 +3804,12 @@ "subcategory": "keys", "verb": "get", "requestPath": "/users/{username}/keys" + }, + { + "slug": "list-ssh-signing-keys-for-a-user", + "subcategory": "ssh-signing-keys", + "verb": "get", + "requestPath": "/users/{username}/ssh_signing_keys" } ], "webhooks": [ diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index 33336ab93025..1c068829b894 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -4556,6 +4556,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -8409,6 +8413,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -14485,6 +14493,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -17129,6 +17141,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -18690,6 +18706,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -21472,6 +21492,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -23033,6 +23057,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -25841,6 +25869,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -27412,6 +27444,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -33099,6 +33135,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -35303,6 +35343,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -38569,6 +38613,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -40773,6 +40821,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -44548,6 +44600,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -46752,6 +46808,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -52166,6 +52226,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -54370,6 +54434,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -58214,6 +58282,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -62248,6 +62320,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -66276,6 +66352,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -70298,6 +70378,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -74310,6 +74394,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -78343,6 +78431,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -82355,6 +82447,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -86378,6 +86474,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -90401,6 +90501,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -94046,6 +94150,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -96543,6 +96651,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -99402,6 +99514,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -102218,6 +102334,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -103825,6 +103945,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -105742,6 +105866,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -107206,6 +107334,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -109987,6 +110119,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -112376,6 +112512,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -113949,14 +114089,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -114101,6 +114233,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -114878,14 +115018,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -115030,6 +115162,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -115500,15 +115640,6 @@ "write" ] }, - { - "type": "string", - "name": "organization_custom_roles", - "description": "

The level of permission to grant the access token for custom roles management.

", - "enum": [ - "read", - "write" - ] - }, { "type": "string", "name": "deployments", @@ -115671,6 +115802,15 @@ "write" ] }, + { + "type": "string", + "name": "organization_custom_roles", + "description": "

The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "organization_hooks", @@ -115951,14 +116091,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -116103,6 +116235,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -117561,6 +117701,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -118661,14 +118805,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -118813,6 +118949,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -119594,14 +119738,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -119746,6 +119882,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -120525,14 +120669,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -120677,6 +120813,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -122566,6 +122710,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -123219,14 +123367,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -123371,6 +123511,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -125297,6 +125445,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -128773,14 +128925,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -128925,6 +129069,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -129644,14 +129796,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -129796,6 +129940,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -130283,15 +130435,6 @@ "write" ] }, - { - "type": "string", - "name": "organization_custom_roles", - "description": "

The level of permission to grant the access token for custom roles management.

", - "enum": [ - "read", - "write" - ] - }, { "type": "string", "name": "deployments", @@ -130454,6 +130597,15 @@ "write" ] }, + { + "type": "string", + "name": "organization_custom_roles", + "description": "

The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.

", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "organization_hooks", @@ -130923,14 +131075,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -131075,6 +131219,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -135001,131 +135153,48 @@ }, "response": { "statusCode": "200", - "description": "

Response

" - } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "301", - "description": "

Moved permanently

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/rename", - "title": "Rename a branch", - "category": "branches", - "subcategory": "branches", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "new_name", - "in": "body", - "description": "

The new name of the branch.

", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "new_name": "my_renamed_branch" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "201", "contentType": "application/json", "description": "

Response

", "example": { - "name": "master", + "name": "main", "commit": { "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", - "node_id": "MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", "commit": { "author": { "name": "The Octocat", - "date": "2012-03-06T15:06:50-08:00", - "email": "octocat@nowhere.com" + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" }, - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", "tree": { "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" }, - "committer": { - "name": "The Octocat", - "date": "2012-03-06T15:06:50-08:00", - "email": "octocat@nowhere.com" - }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null - }, - "comment_count": 0 + } }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", "gravatar_id": "", - "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", "url": "https://api.github.com/users/octocat", - "id": 583231, - "login": "octocat", - "node_id": "MDQ6VXNlcjE=", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", @@ -135137,26 +135206,15 @@ "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", - "site_admin": true + "site_admin": false }, - "parents": [ - { - "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" - }, - { - "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303" - } - ], - "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", "gravatar_id": "", - "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", "url": "https://api.github.com/users/octocat", - "id": 583231, - "login": "octocat", - "node_id": "MDQ6VXNlcjE=", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", @@ -135168,26 +135226,35 @@ "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", - "site_admin": true + "site_admin": false }, - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] }, "_links": { - "html": "https://github.com/octocat/Hello-World/tree/master", - "self": "https://api.github.com/repos/octocat/Hello-World/branches/master" + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" }, - "protected": true, + "protected": false, "protection": { + "enabled": false, "required_status_checks": { - "enforcement_level": "non_admins", - "contexts": [ - "ci-test", - "linter" - ] + "enforcement_level": "off", + "contexts": [], + "checks": [] } }, - "protection_url": "https://api.github.com/repos/octocat/hello-world/branches/master/protection" + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" }, "schema": { "title": "Branch With Protection", @@ -137858,32 +137925,28 @@ } } ], + "descriptionHTML": "", "previews": [], - "descriptionHTML": "

Renames a branch in a repository.

\n

Note: Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".

\n

The permissions required to use this endpoint depends on whether you are renaming the default branch.

\n

To rename a non-default branch:

\n
    \n
  • Users must have push access.
  • \n
  • GitHub Apps must have the contents:write repository permission.
  • \n
\n

To rename the default branch:

\n
    \n
  • Users must have admin or owner permissions.
  • \n
  • GitHub Apps must have the administration:write repository permission.
  • \n
", "statusCodes": [ { - "httpStatusCode": "201", - "description": "

Created

" + "httpStatusCode": "200", + "description": "

OK

" }, { - "httpStatusCode": "403", - "description": "

Forbidden

" + "httpStatusCode": "301", + "description": "

Moved permanently

" }, { "httpStatusCode": "404", "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed

" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/merge-upstream", - "title": "Sync a fork branch with the upstream repository", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/rename", + "title": "Rename a branch", "category": "branches", "subcategory": "branches", "parameters": [ @@ -137904,130 +137967,25 @@ "schema": { "type": "string" } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "branch", - "in": "body", - "description": "

The name of the branch which should be updated to match upstream.

", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "branch": "main" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

The branch has been successfully synced with the upstream repository

", - "example": { - "message": "Successfully fetched and fast-forwarded from upstream defunkt:main", - "merge_type": "fast-forward", - "base_branch": "defunkt:main" - }, - "schema": { - "title": "Merged upstream", - "description": "Results of a successful merge upstream request", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "merge_type": { - "type": "string", - "enum": [ - "merge", - "fast-forward", - "none" - ] - }, - "base_branch": { - "type": "string" - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Sync a branch of a forked repository to keep it up-to-date with the upstream repository.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

The branch has been successfully synced with the upstream repository

" - }, - { - "httpStatusCode": "409", - "description": "

The branch could not be synced because of a merge conflict

" - }, - { - "httpStatusCode": "422", - "description": "

The branch could not be synced for some other reason

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/merges", - "title": "Merge a branch", - "category": "branches", - "subcategory": "branches", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", + "name": "branch", + "description": "

The name of the branch.

", "in": "path", "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true } ], "bodyParameters": [ { "type": "string", - "name": "base", - "in": "body", - "description": "

The name of the base branch that the head will be merged into.

", - "isRequired": true - }, - { - "type": "string", - "name": "head", + "name": "new_name", "in": "body", - "description": "

The head to merge. This can be a branch name or a commit SHA1.

", + "description": "

The new name of the branch.

", "isRequired": true - }, - { - "type": "string", - "name": "commit_message", - "in": "body", - "description": "

Commit message to use for the merge commit. If omitted, a default message will be used.

" } ], "enabledForGitHubApps": true, @@ -138039,153 +137997,129 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "base": "master", - "head": "cool_feature", - "commit_message": "Shipped cool_feature!" + "new_name": "my_renamed_branch" }, "parameters": { "owner": "OWNER", - "repo": "REPO" + "repo": "REPO", + "branch": "BRANCH" } }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "

Successful Response (The resulting merge commit)

", + "description": "

Response

", "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", + "name": "master", "commit": { - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==", + "commit": { + "author": { + "name": "The Octocat", + "date": "2012-03-06T15:06:50-08:00", + "email": "octocat@nowhere.com" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "committer": { + "name": "The Octocat", + "date": "2012-03-06T15:06:50-08:00", + "email": "octocat@nowhere.com" + }, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + }, + "comment_count": 0 + }, "author": { - "name": "Monalisa Octocat", - "email": "mona@github.com", - "date": "2011-04-14T16:00:49Z" + "gravatar_id": "", + "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", + "url": "https://api.github.com/users/octocat", + "id": 583231, + "login": "octocat", + "node_id": "MDQ6VXNlcjE=", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ], + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "committer": { - "name": "Monalisa Octocat", - "email": "mona@github.com", - "date": "2011-04-14T16:00:49Z" - }, - "message": "Fix all the bugs", - "tree": { - "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + "gravatar_id": "", + "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", + "url": "https://api.github.com/users/octocat", + "id": 583231, + "login": "octocat", + "node_id": "MDQ6VXNlcjE=", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true }, - "comment_count": 0, - "verification": { - "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null - } - }, - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" }, - "committer": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "_links": { + "html": "https://github.com/octocat/Hello-World/tree/master", + "self": "https://api.github.com/repos/octocat/Hello-World/branches/master" }, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + "protected": true, + "protection": { + "required_status_checks": { + "enforcement_level": "non_admins", + "contexts": [ + "ci-test", + "linter" + ] } - ], - "stats": { - "additions": 104, - "deletions": 4, - "total": 108 }, - "files": [ - { - "filename": "file1.txt", - "additions": 10, - "deletions": 2, - "changes": 12, - "status": "modified", - "raw_url": "https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", - "blob_url": "https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", - "patch": "@@ -29,7 +29,7 @@\n....." - } - ] + "protection_url": "https://api.github.com/repos/octocat/hello-world/branches/master/protection" }, "schema": { - "title": "Commit", - "description": "Commit", + "title": "Branch With Protection", + "description": "Branch With Protection", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "sha": { - "type": "string", - "examples": [ - "6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" - ] + "name": { + "type": "string" }, "commit": { + "title": "Commit", + "description": "Commit", "type": "object", "properties": { "url": { @@ -138195,35 +138129,345 @@ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, + "sha": { + "type": "string", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + ] + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { + "type": "string", + "examples": [ + "Fix all the bugs" + ] + }, + "comment_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" + ] + } + }, + "required": [ + "sha", + "url" + ] + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "payload": { + "type": [ + "string", + "null" + ] + }, + "signature": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature" + ] + } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, "author": { "anyOf": [ { "type": "null" }, { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", "examples": [ - "\"Chris Wanstrath\"" + "octocat" ] }, - "email": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", "examples": [ - "\"chris@ozmm.org\"" + "MDQ6VXNlcjE=" ] }, - "date": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "\"2007-10-29T02:42:39.000-07:00\"" + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } ] }, @@ -138233,639 +138477,5513 @@ "type": "null" }, { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", "examples": [ - "\"Chris Wanstrath\"" + "octocat" ] }, - "email": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", "examples": [ - "\"chris@ozmm.org\"" + "MDQ6VXNlcjE=" ] }, - "date": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "\"2007-10-29T02:42:39.000-07:00\"" + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } ] }, - "message": { - "type": "string", - "examples": [ - "Fix all the bugs" - ] - }, - "comment_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "tree": { - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "827efc6d56897b048c772eb4087f854f46256132" - ] + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + } }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" - ] - } - }, - "required": [ - "sha", - "url" - ] + "required": [ + "sha", + "url" + ] + } }, - "verification": { - "title": "Verification", + "stats": { "type": "object", "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" + "additions": { + "type": "integer" }, - "payload": { - "type": [ - "string", - "null" - ] + "deletions": { + "type": "integer" }, - "signature": { - "type": [ - "string", - "null" - ] + "total": { + "type": "integer" } - }, - "required": [ - "verified", - "reason", - "payload", - "signature" - ] + } + }, + "files": { + "type": "array", + "items": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" + ] + }, + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "examples": [ + "added" + ] + }, + "additions": { + "type": "integer", + "examples": [ + 103 + ] + }, + "deletions": { + "type": "integer", + "examples": [ + 21 + ] + }, + "changes": { + "type": "integer", + "examples": [ + 124 + ] + }, + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" + ] + } + }, + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + } } }, "required": [ + "url", + "sha", + "node_id", + "html_url", + "comments_url", + "commit", "author", "committer", - "comment_count", - "message", - "tree", - "url" + "parents" ] }, - "author": { - "anyOf": [ - { - "type": "null" + "_links": { + "type": "object", + "properties": { + "html": { + "type": "string" }, - { - "title": "Simple User", - "description": "Simple User", + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "html", + "self" + ] + }, + "protected": { + "type": "boolean" + }, + "protection": { + "title": "Branch Protection", + "description": "Branch Protection", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "type": "string" }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] + "enforcement_level": { + "type": "string" }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "contexts": { + "type": "array", + "items": { + "type": "string" + } }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": [ + "integer", + "null" + ] + } + }, + "required": [ + "context", + "app_id" + ] + } }, - "type": { - "type": "string", - "examples": [ - "User" - ] + "contexts_url": { + "type": "string" }, - "site_admin": { + "strict": { "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "contexts", + "checks" ] - } - ] - }, - "committer": { - "anyOf": [ - { - "type": "null" }, - { - "title": "Simple User", - "description": "Simple User", + "enforce_admins": { + "title": "Protected Branch Admin Enforced", + "description": "Protected Branch Admin Enforced", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "enabled": { + "type": "boolean", "examples": [ - "\"2020-07-09T00:17:55Z\"" + true ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "enabled" ] - } - ] - }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" - ] - } - }, - "required": [ - "sha", - "url" - ] - } - }, - "stats": { - "type": "object", - "properties": { - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "total": { - "type": "integer" - } - } - }, - "files": { - "type": "array", - "items": { - "title": "Diff Entry", - "description": "Diff Entry", - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "bbcd538c8e72b8c175046e27cc8f907076331401" - ] - }, - "filename": { - "type": "string", - "examples": [ - "file1.txt" - ] - }, - "status": { - "type": "string", - "enum": [ - "added", - "removed", - "modified", - "renamed", - "copied", - "changed", - "unchanged" - ], - "examples": [ - "added" - ] - }, - "additions": { - "type": "integer", - "examples": [ - 103 - ] - }, - "deletions": { - "type": "integer", - "examples": [ - 21 - ] - }, - "changes": { - "type": "integer", - "examples": [ - 124 - ] - }, - "blob_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "raw_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "contents_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "patch": { - "type": "string", - "examples": [ - "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" - ] - }, - "previous_filename": { - "type": "string", - "examples": [ - "file.txt" - ] - } }, - "required": [ - "additions", - "blob_url", - "changes", - "contents_url", - "deletions", - "filename", - "raw_url", - "sha", - "status" - ] - } - } - }, - "required": [ - "url", - "sha", - "node_id", - "html_url", - "comments_url", - "commit", - "author", - "committer", - "parents" - ] - } - } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Successful Response (The resulting merge commit)

" - }, - { - "httpStatusCode": "204", - "description": "

Response when already merged

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Not Found when the base or head does not exist

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict when there is a merge conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed

" - } - ] - } - ], - "branch-protection": [ - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "title": "Get branch protection", + "required_pull_request_reviews": { + "title": "Protected Branch Pull Request Review", + "description": "Protected Branch Pull Request Review", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" + ] + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "users": { + "description": "The list of users with review dismissal access.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams with review dismissal access.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps with review dismissal access.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" + ] + }, + "users_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" + ] + }, + "teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" + ] + } + } + }, + "bypass_pull_request_allowances": { + "type": "object", + "description": "Allow specific users, teams, or apps to bypass pull request requirements.", + "properties": { + "users": { + "description": "The list of users allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + } + } + }, + "dismiss_stale_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "require_code_owner_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "required_approving_review_count": { + "type": "integer", + "minimum": 0, + "maximum": 6, + "examples": [ + 2 + ] + } + }, + "required": [ + "dismiss_stale_reviews", + "require_code_owner_reviews" + ] + }, + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "name": { + "type": "string", + "examples": [ + "\"branch/with/protection\"" + ] + }, + "protection_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + } + } + }, + "protection_url": { + "type": "string", + "format": "uri" + }, + "pattern": { + "type": "string", + "examples": [ + "\"mas*\"" + ] + }, + "required_approving_review_count": { + "type": "integer", + "examples": [ + 1 + ] + } + }, + "required": [ + "name", + "commit", + "_links", + "protection", + "protected", + "protection_url" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Renames a branch in a repository.

\n

Note: Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".

\n

The permissions required to use this endpoint depends on whether you are renaming the default branch.

\n

To rename a non-default branch:

\n
    \n
  • Users must have push access.
  • \n
  • GitHub Apps must have the contents:write repository permission.
  • \n
\n

To rename the default branch:

\n
    \n
  • Users must have admin or owner permissions.
  • \n
  • GitHub Apps must have the administration:write repository permission.
  • \n
", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/merge-upstream", + "title": "Sync a fork branch with the upstream repository", + "category": "branches", + "subcategory": "branches", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "branch", + "in": "body", + "description": "

The name of the branch which should be updated to match upstream.

", + "isRequired": true + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "branch": "main" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

The branch has been successfully synced with the upstream repository

", + "example": { + "message": "Successfully fetched and fast-forwarded from upstream defunkt:main", + "merge_type": "fast-forward", + "base_branch": "defunkt:main" + }, + "schema": { + "title": "Merged upstream", + "description": "Results of a successful merge upstream request", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "merge_type": { + "type": "string", + "enum": [ + "merge", + "fast-forward", + "none" + ] + }, + "base_branch": { + "type": "string" + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Sync a branch of a forked repository to keep it up-to-date with the upstream repository.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

The branch has been successfully synced with the upstream repository

" + }, + { + "httpStatusCode": "409", + "description": "

The branch could not be synced because of a merge conflict

" + }, + { + "httpStatusCode": "422", + "description": "

The branch could not be synced for some other reason

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/merges", + "title": "Merge a branch", + "category": "branches", + "subcategory": "branches", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "base", + "in": "body", + "description": "

The name of the base branch that the head will be merged into.

", + "isRequired": true + }, + { + "type": "string", + "name": "head", + "in": "body", + "description": "

The head to merge. This can be a branch name or a commit SHA1.

", + "isRequired": true + }, + { + "type": "string", + "name": "commit_message", + "in": "body", + "description": "

Commit message to use for the merge commit. If omitted, a default message will be used.

" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "base": "master", + "head": "cool_feature", + "commit_message": "Shipped cool_feature!" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Successful Response (The resulting merge commit)

", + "example": { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", + "commit": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "author": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "committer": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "message": "Fix all the bugs", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "comment_count": 0, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + ], + "stats": { + "additions": 104, + "deletions": 4, + "total": 108 + }, + "files": [ + { + "filename": "file1.txt", + "additions": 10, + "deletions": 2, + "changes": 12, + "status": "modified", + "raw_url": "https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", + "blob_url": "https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", + "patch": "@@ -29,7 +29,7 @@\n....." + } + ] + }, + "schema": { + "title": "Commit", + "description": "Commit", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "sha": { + "type": "string", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + ] + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { + "type": "string", + "examples": [ + "Fix all the bugs" + ] + }, + "comment_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" + ] + } + }, + "required": [ + "sha", + "url" + ] + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "payload": { + "type": [ + "string", + "null" + ] + }, + "signature": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature" + ] + } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + } + }, + "required": [ + "sha", + "url" + ] + } + }, + "stats": { + "type": "object", + "properties": { + "additions": { + "type": "integer" + }, + "deletions": { + "type": "integer" + }, + "total": { + "type": "integer" + } + } + }, + "files": { + "type": "array", + "items": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" + ] + }, + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "examples": [ + "added" + ] + }, + "additions": { + "type": "integer", + "examples": [ + 103 + ] + }, + "deletions": { + "type": "integer", + "examples": [ + 21 + ] + }, + "changes": { + "type": "integer", + "examples": [ + 124 + ] + }, + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" + ] + } + }, + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + } + } + }, + "required": [ + "url", + "sha", + "node_id", + "html_url", + "comments_url", + "commit", + "author", + "committer", + "parents" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Successful Response (The resulting merge commit)

" + }, + { + "httpStatusCode": "204", + "description": "

Response when already merged

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Not Found when the base or head does not exist

" + }, + { + "httpStatusCode": "409", + "description": "

Conflict when there is a merge conflict

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed

" + } + ] + } + ], + "branch-protection": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", + "title": "Get branch protection", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts", + "enforcement_level": "non_admins" + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", + "enabled": true + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", + "users": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "apps": [ + { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + } + ] + }, + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2 + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps", + "users": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "apps": [ + { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + } + ] + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + }, + "schema": { + "title": "Branch Protection", + "description": "Branch Protection", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enforcement_level": { + "type": "string" + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + } + }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": [ + "integer", + "null" + ] + } + }, + "required": [ + "context", + "app_id" + ] + } + }, + "contexts_url": { + "type": "string" + }, + "strict": { + "type": "boolean" + } + }, + "required": [ + "contexts", + "checks" + ] + }, + "enforce_admins": { + "title": "Protected Branch Admin Enforced", + "description": "Protected Branch Admin Enforced", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "required_pull_request_reviews": { + "title": "Protected Branch Pull Request Review", + "description": "Protected Branch Pull Request Review", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" + ] + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "users": { + "description": "The list of users with review dismissal access.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams with review dismissal access.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps with review dismissal access.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" + ] + }, + "users_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" + ] + }, + "teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" + ] + } + } + }, + "bypass_pull_request_allowances": { + "type": "object", + "description": "Allow specific users, teams, or apps to bypass pull request requirements.", + "properties": { + "users": { + "description": "The list of users allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + } + } + }, + "dismiss_stale_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "require_code_owner_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "required_approving_review_count": { + "type": "integer", + "minimum": 0, + "maximum": 6, + "examples": [ + 2 + ] + } + }, + "required": [ + "dismiss_stale_reviews", + "require_code_owner_reviews" + ] + }, + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "name": { + "type": "string", + "examples": [ + "\"branch/with/protection\"" + ] + }, + "protection_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", + "title": "Update branch protection", "category": "branches", "subcategory": "branch-protection", "parameters": [ @@ -138898,205 +144016,289 @@ "x-multi-segment": true } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "object or null", + "name": "required_status_checks", + "in": "body", + "description": "

Require status checks to pass before merging. Set to null to disable.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "strict", + "description": "

Require branches to be up to date before merging.

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "contexts", + "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "isRequired": true + }, + { + "type": "array of objects", + "name": "checks", + "description": "

The list of status checks to require in order to merge into this branch.

", + "childParamsGroups": [ + { + "type": "string", + "name": "context", + "description": "

The name of the required check

", + "isRequired": true + }, + { + "type": "integer", + "name": "app_id", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" + } + ] + } + ] + }, + { + "type": "boolean or null", + "name": "enforce_admins", + "in": "body", + "description": "

Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "required_pull_request_reviews", + "in": "body", + "description": "

Require at least one approving review on a pull request, before merging. Set to null to disable.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "dismissal_restrictions", + "description": "

Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "users", + "description": "

The list of user logins with dismissal access

" + }, + { + "type": "array of strings", + "name": "teams", + "description": "

The list of team slugs with dismissal access

" + }, + { + "type": "array of strings", + "name": "apps", + "description": "

The list of app slugs with dismissal access

" + } + ] + }, + { + "type": "boolean", + "name": "dismiss_stale_reviews", + "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

" + }, + { + "type": "boolean", + "name": "require_code_owner_reviews", + "description": "

Blocks merging pull requests until code owners review them.

" + }, + { + "type": "integer", + "name": "required_approving_review_count", + "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

" + }, + { + "type": "object", + "name": "bypass_pull_request_allowances", + "description": "

Allow specific users, teams, or apps to bypass pull request requirements.

", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "users", + "description": "

The list of user logins allowed to bypass pull request requirements.

" + }, + { + "type": "array of strings", + "name": "teams", + "description": "

The list of team slugs allowed to bypass pull request requirements.

" + }, + { + "type": "array of strings", + "name": "apps", + "description": "

The list of app slugs allowed to bypass pull request requirements.

" + } + ] + } + ] + }, + { + "type": "object or null", + "name": "restrictions", + "in": "body", + "description": "

Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of strings", + "name": "users", + "description": "

The list of user logins with push access

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "teams", + "description": "

The list of team slugs with push access

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "apps", + "description": "

The list of app slugs with push access

" + } + ] + }, + { + "type": "boolean", + "name": "required_linear_history", + "in": "body", + "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

" + }, + { + "type": "boolean or null", + "name": "allow_force_pushes", + "in": "body", + "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

" + }, + { + "type": "boolean", + "name": "allow_deletions", + "in": "body", + "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

" + }, + { + "type": "boolean", + "name": "block_creations", + "in": "body", + "description": "

If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

" + }, + { + "type": "boolean", + "name": "required_conversation_resolution", + "in": "body", + "description": "

Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

" + } + ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { + "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection", + "bodyParameters": { "required_status_checks": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", + "strict": true, "contexts": [ "continuous-integration/travis-ci" - ], - "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts", - "enforcement_level": "non_admins" - }, - "enforce_admins": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", - "enabled": true + ] }, + "enforce_admins": true, "required_pull_request_reviews": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", "dismissal_restrictions": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", - "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", "users": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } + "octocat" ], "teams": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "apps": [ - { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] - } + "justice-league" ] }, "dismiss_stale_reviews": true, "require_code_owner_reviews": true, - "required_approving_review_count": 2 + "required_approving_review_count": 2, + "bypass_pull_request_allowances": { + "users": [ + "octocat" + ], + "teams": [ + "justice-league" + ] + } }, "restrictions": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", - "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams", - "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps", "users": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } + "octocat" ], "teams": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } + "justice-league" ], "apps": [ + "super-ci" + ] + }, + "required_linear_history": true, + "allow_force_pushes": true, + "allow_deletions": true, + "block_creations": true, + "required_conversation_resolution": true + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] + "context": "continuous-integration/travis-ci", + "app_id": null } ] }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [], + "teams": [], + "apps": [] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [], + "teams": [], + "apps": [] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, "required_linear_history": { "enabled": true }, @@ -139106,37 +144308,48 @@ "allow_deletions": { "enabled": true }, + "block_creations": { + "enabled": true + }, "required_conversation_resolution": { "enabled": true } }, "schema": { - "title": "Branch Protection", - "description": "Branch Protection", + "title": "Protected Branch", + "description": "Branch protections protect branches", "type": "object", "properties": { "url": { - "type": "string" - }, - "enabled": { - "type": "boolean" + "type": "string", + "format": "uri" }, "required_status_checks": { - "title": "Protected Branch Required Status Check", - "description": "Protected Branch Required Status Check", + "title": "Status Check Policy", + "description": "Status Check Policy", "type": "object", "properties": { "url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" + ] }, - "enforcement_level": { - "type": "string" + "strict": { + "type": "boolean", + "examples": [ + true + ] }, "contexts": { "type": "array", "items": { "type": "string" - } + }, + "examples": [ + "continuous-integration/travis-ci" + ] }, "checks": { "type": "array", @@ -139144,7 +144357,10 @@ "type": "object", "properties": { "context": { - "type": "string" + "type": "string", + "examples": [ + "continuous-integration/travis-ci" + ] }, "app_id": { "type": [ @@ -139160,58 +144376,53 @@ } }, "contexts_url": { - "type": "string" - }, - "strict": { - "type": "boolean" - } - }, - "required": [ - "contexts", - "checks" - ] - }, - "enforce_admins": { - "title": "Protected Branch Admin Enforced", - "description": "Protected Branch Admin Enforced", - "type": "object", - "properties": { - "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" - ] - }, - "enabled": { - "type": "boolean", - "examples": [ - true + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" ] } }, "required": [ "url", - "enabled" + "contexts_url", + "strict", + "contexts", + "checks" ] }, "required_pull_request_reviews": { - "title": "Protected Branch Pull Request Review", - "description": "Protected Branch Pull Request Review", "type": "object", "properties": { "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" - ] + "format": "uri" + }, + "dismiss_stale_reviews": { + "type": "boolean" + }, + "require_code_owner_reviews": { + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" }, "dismissal_restrictions": { "type": "object", "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, "users": { - "description": "The list of users with review dismissal access.", "type": "array", "items": { "title": "Simple User", @@ -139376,7 +144587,6 @@ } }, "teams": { - "description": "The list of teams with review dismissal access.", "type": "array", "items": { "title": "Team", @@ -139580,7 +144790,6 @@ } }, "apps": { - "description": "The list of apps with review dismissal access.", "type": "array", "items": { "title": "GitHub app", @@ -139907,33 +145116,20 @@ "events" ] } - }, - "url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" - ] - }, - "users_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" - ] - }, - "teams_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" - ] } - } + }, + "required": [ + "url", + "users_url", + "teams_url", + "users", + "teams" + ] }, "bypass_pull_request_allowances": { "type": "object", - "description": "Allow specific users, teams, or apps to bypass pull request requirements.", "properties": { "users": { - "description": "The list of users allowed to bypass pull request requirements.", "type": "array", "items": { "title": "Simple User", @@ -140098,7 +145294,6 @@ } }, "teams": { - "description": "The list of teams allowed to bypass pull request requirements.", "type": "array", "items": { "title": "Team", @@ -140302,7 +145497,6 @@ } }, "apps": { - "description": "The list of apps allowed to bypass pull request requirements.", "type": "array", "items": { "title": "GitHub app", @@ -140630,32 +145824,90 @@ ] } } - } - }, - "dismiss_stale_reviews": { - "type": "boolean", + }, + "required": [ + "users", + "teams" + ] + } + }, + "required": [ + "url" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", "examples": [ - true + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" ] }, - "require_code_owner_reviews": { + "enabled": { "type": "boolean", "examples": [ true ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "enforce_admins": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" }, - "required_approving_review_count": { - "type": "integer", - "minimum": 0, - "maximum": 6, - "examples": [ - 2 - ] + "enabled": { + "type": "boolean" } }, + "additionalProperties": false, "required": [ - "dismiss_stale_reviews", - "require_code_owner_reviews" + "url", + "enabled" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" ] }, "restrictions": { @@ -140967,29 +146219,14 @@ "apps" ] }, - "required_linear_history": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "allow_force_pushes": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "allow_deletions": { + "required_conversation_resolution": { "type": "object", "properties": { "enabled": { "type": "boolean" } - } + }, + "additionalProperties": false }, "block_creations": { "type": "object", @@ -140997,340 +146234,17 @@ "enabled": { "type": "boolean" } - } - }, - "required_conversation_resolution": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "name": { - "type": "string", - "examples": [ - "\"branch/with/protection\"" - ] - }, - "protection_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" - ] - }, - "required_signatures": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" - ] - }, - "enabled": { - "type": "boolean", - "examples": [ - true - ] - } }, + "additionalProperties": false, "required": [ - "url", "enabled" ] } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "title": "Update branch protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "object or null", - "name": "required_status_checks", - "in": "body", - "description": "

Require status checks to pass before merging. Set to null to disable.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "strict", - "description": "

Require branches to be up to date before merging.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "contexts", - "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "checks", - "description": "

The list of status checks to require in order to merge into this branch.

", - "childParamsGroups": [ - { - "type": "string", - "name": "context", - "description": "

The name of the required check

", - "isRequired": true - }, - { - "type": "integer", - "name": "app_id", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" - } - ] - } - ] - }, - { - "type": "boolean or null", - "name": "enforce_admins", - "in": "body", - "description": "

Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "required_pull_request_reviews", - "in": "body", - "description": "

Require at least one approving review on a pull request, before merging. Set to null to disable.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "dismissal_restrictions", - "description": "

Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "users", - "description": "

The list of user logins with dismissal access

" - }, - { - "type": "array of strings", - "name": "teams", - "description": "

The list of team slugs with dismissal access

" - }, - { - "type": "array of strings", - "name": "apps", - "description": "

The list of app slugs with dismissal access

" - } - ] - }, - { - "type": "boolean", - "name": "dismiss_stale_reviews", - "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

" - }, - { - "type": "boolean", - "name": "require_code_owner_reviews", - "description": "

Blocks merging pull requests until code owners review them.

" - }, - { - "type": "integer", - "name": "required_approving_review_count", - "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

" - }, - { - "type": "object", - "name": "bypass_pull_request_allowances", - "description": "

Allow specific users, teams, or apps to bypass pull request requirements.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "users", - "description": "

The list of user logins allowed to bypass pull request requirements.

" - }, - { - "type": "array of strings", - "name": "teams", - "description": "

The list of team slugs allowed to bypass pull request requirements.

" - }, - { - "type": "array of strings", - "name": "apps", - "description": "

The list of app slugs allowed to bypass pull request requirements.

" - } - ] - } - ] - }, - { - "type": "object or null", - "name": "restrictions", - "in": "body", - "description": "

Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of strings", - "name": "users", - "description": "

The list of user logins with push access

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "teams", - "description": "

The list of team slugs with push access

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "apps", - "description": "

The list of app slugs with push access

" - } - ] - }, - { - "type": "boolean", - "name": "required_linear_history", - "in": "body", - "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

" - }, - { - "type": "boolean or null", - "name": "allow_force_pushes", - "in": "body", - "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

" - }, - { - "type": "boolean", - "name": "allow_deletions", - "in": "body", - "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

" - }, - { - "type": "boolean", - "name": "block_creations", - "in": "body", - "description": "

If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

" - }, - { - "type": "boolean", - "name": "required_conversation_resolution", - "in": "body", - "description": "

Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

" - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "required_status_checks": { - "strict": true, - "contexts": [ - "continuous-integration/travis-ci" - ] - }, - "enforce_admins": true, - "required_pull_request_reviews": { - "dismissal_restrictions": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ] - }, - "dismiss_stale_reviews": true, - "require_code_owner_reviews": true, - "required_approving_review_count": 2, - "bypass_pull_request_allowances": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ] - } - }, - "restrictions": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ], - "apps": [ - "super-ci" - ] }, - "required_linear_history": true, - "allow_force_pushes": true, - "allow_deletions": true, - "block_creations": true, - "required_conversation_resolution": true - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" + "required": [ + "url" + ] } - }, - "response": { - "statusCode": "200", - "description": "

Response

" } } ], @@ -145536,36 +150450,347 @@ } ], "bodyParameters": [ - { - "type": "boolean", - "name": "strict", - "in": "body", - "description": "

Require branches to be up to date before merging.

" - }, + { + "type": "boolean", + "name": "strict", + "in": "body", + "description": "

Require branches to be up to date before merging.

" + }, + { + "type": "array of strings", + "name": "contexts", + "in": "body", + "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

" + }, + { + "type": "array of objects", + "name": "checks", + "in": "body", + "description": "

The list of status checks to require in order to merge into this branch.

", + "childParamsGroups": [ + { + "type": "string", + "name": "context", + "description": "

The name of the required check

", + "isRequired": true + }, + { + "type": "integer", + "name": "app_id", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" + } + ] + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ] + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + }, + "schema": { + "title": "Status Check Policy", + "description": "Status Check Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" + ] + }, + "strict": { + "type": "boolean", + "examples": [ + true + ] + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "continuous-integration/travis-ci" + ] + }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "examples": [ + "continuous-integration/travis-ci" + ] + }, + "app_id": { + "type": [ + "integer", + "null" + ] + } + }, + "required": [ + "context", + "app_id" + ] + } + }, + "contexts_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + ] + } + }, + "required": [ + "url", + "contexts_url", + "strict", + "contexts", + "checks" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + "title": "Remove status check protection", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "title": "Get all status check contexts", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + "continuous-integration/travis-ci" + ], + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "title": "Add status check contexts", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [ { "type": "array of strings", "name": "contexts", "in": "body", - "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

" - }, - { - "type": "array of objects", - "name": "checks", - "in": "body", - "description": "

The list of status checks to require in order to merge into this branch.

", - "childParamsGroups": [ - { - "type": "string", - "name": "context", - "description": "

The name of the required check

", - "isRequired": true - }, - { - "type": "integer", - "name": "app_id", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" - } - ] + "description": "

The name of the status checks

", + "isRequired": true } ], "enabledForGitHubApps": true, @@ -145574,12 +150799,12 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding status checks to a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "strict": true, "contexts": [ - "continuous-integration/travis-ci" + "continuous-integration/travis-ci", + "continuous-integration/jenkins" ] }, "parameters": { @@ -145588,311 +150813,6 @@ "branch": "BRANCH" } }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", - "strict": true, - "contexts": [ - "continuous-integration/travis-ci" - ], - "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" - }, - "schema": { - "title": "Status Check Policy", - "description": "Status Check Policy", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" - ] - }, - "strict": { - "type": "boolean", - "examples": [ - true - ] - }, - "contexts": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "continuous-integration/travis-ci" - ] - }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "examples": [ - "continuous-integration/travis-ci" - ] - }, - "app_id": { - "type": [ - "integer", - "null" - ] - } - }, - "required": [ - "context", - "app_id" - ] - } - }, - "contexts_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" - ] - } - }, - "required": [ - "url", - "contexts_url", - "strict", - "contexts", - "checks" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "title": "Remove status check protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "title": "Get all status check contexts", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - "continuous-integration/travis-ci" - ], - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "title": "Add status check contexts", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "contexts", - "in": "body", - "description": "

contexts parameter

", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, "response": { "statusCode": "200", "contentType": "application/json", @@ -145973,7 +150893,7 @@ "type": "array of strings", "name": "contexts", "in": "body", - "description": "

contexts parameter

", + "description": "

The name of the status checks

", "isRequired": true } ], @@ -145983,8 +150903,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example updating status checks for a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -146066,7 +150991,7 @@ "type": "array of strings", "name": "contexts", "in": "body", - "description": "

contexts parameter

", + "description": "

The name of the status checks

", "isRequired": true } ], @@ -146076,8 +151001,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing status checks from a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -148771,7 +153701,7 @@ "type": "array of strings", "name": "teams", "in": "body", - "description": "

teams parameter

", + "description": "

The slug values for teams

", "isRequired": true } ], @@ -148781,8 +153711,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -149070,7 +154005,7 @@ "type": "array of strings", "name": "teams", "in": "body", - "description": "

teams parameter

", + "description": "

The slug values for teams

", "isRequired": true } ], @@ -149080,8 +154015,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -149369,7 +154309,7 @@ "type": "array of strings", "name": "teams", "in": "body", - "description": "

teams parameter

", + "description": "

The slug values for teams

", "isRequired": true } ], @@ -149379,8 +154319,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -149925,7 +154870,7 @@ "type": "array of strings", "name": "users", "in": "body", - "description": "

users parameter

", + "description": "

The username for users

", "isRequired": true } ], @@ -149935,8 +154880,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -150191,7 +155141,7 @@ "type": "array of strings", "name": "users", "in": "body", - "description": "

users parameter

", + "description": "

The username for users

", "isRequired": true } ], @@ -150201,8 +155151,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -150457,7 +155412,7 @@ "type": "array of strings", "name": "users", "in": "body", - "description": "

users parameter

", + "description": "

The username for users

", "isRequired": true } ], @@ -150467,8 +155422,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -161675,6 +166635,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -164834,6 +169798,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -167511,6 +172479,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -170607,6 +175579,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -173810,6 +178786,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -174883,6 +179863,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -176285,6 +181272,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -177784,7 +182778,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -178134,6 +183129,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -178421,7 +183423,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -178771,6 +183774,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -179010,6 +184020,7 @@ "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "state": "open", "fixed_at": null, "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", @@ -179250,6 +184261,33 @@ "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53" ] } + }, + { + "name": "direction", + "description": "

The direction to sort the results by.

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "

The property by which to sort the results.

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created" + ], + "default": "created" + } } ], "bodyParameters": [], @@ -179861,7 +184899,7 @@ "description": "

Service unavailable

" } ], - "descriptionHTML": "

Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the repo scope. For public repositories,\nyou must use an access token with public_repo scope.\nGitHub Apps must have the security_events write permission to use this endpoint.

\n

You can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.

\n

When you list the analyses for a repository,\none or more will be identified as deletable in the response:

\n
\"deletable\": true\n
\n

An analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:

\n
    \n
  • ref
  • \n
  • tool
  • \n
  • analysis_key
  • \n
  • environment
  • \n
\n

If you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:

\n
Analysis specified is not deletable.\n
\n

The response from a successful DELETE operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\nnext_analysis_url and confirm_delete_url.\nUse the next_analysis_url URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the confirm_delete_url URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of next_analysis_url and confirm_delete_url\nin the 200 response is null.

\n

As an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:

\n

Outer loop:

\n
    \n
  • \n

    List the analyses for the repository, filtered by tool.

    \n
  • \n
  • \n

    Parse this list to find a deletable analysis. If found:

    \n

    Inner loop:

    \n
      \n
    • Delete the identified analysis.
    • \n
    • Parse the response for the value of confirm_delete_url and, if found, use this in the next iteration.
    • \n
    \n
  • \n
\n

The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url value. Alternatively, you could use the next_analysis_url value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.

", + "descriptionHTML": "

Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the repo scope. For public repositories,\nyou must use an access token with public_repo scope.\nGitHub Apps must have the security_events write permission to use this endpoint.

\n

You can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.

\n

When you list the analyses for a repository,\none or more will be identified as deletable in the response:

\n
\"deletable\": true\n
\n

An analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:

\n
    \n
  • ref
  • \n
  • tool
  • \n
  • category
  • \n
\n

If you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:

\n
Analysis specified is not deletable.\n
\n

The response from a successful DELETE operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\nnext_analysis_url and confirm_delete_url.\nUse the next_analysis_url URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the confirm_delete_url URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of next_analysis_url and confirm_delete_url\nin the 200 response is null.

\n

As an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:

\n

Outer loop:

\n
    \n
  • \n

    List the analyses for the repository, filtered by tool.

    \n
  • \n
  • \n

    Parse this list to find a deletable analysis. If found:

    \n

    Inner loop:

    \n
      \n
    • Delete the identified analysis.
    • \n
    • Parse the response for the value of confirm_delete_url and, if found, use this in the next iteration.
    • \n
    \n
  • \n
\n

The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url value. Alternatively, you could use the next_analysis_url value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.

", "subcategory": "code-scanning" }, { @@ -183028,6 +188066,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -183567,6 +188609,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -186208,6 +191260,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -186747,6 +191803,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -189268,6 +194334,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -189807,6 +194877,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -192882,6 +197962,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -193421,6 +198505,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -195943,6 +201037,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -196482,6 +201580,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -199358,6 +204466,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -199897,6 +205009,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -202548,6 +207670,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -203087,6 +208213,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -205605,6 +210741,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -206144,6 +211284,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -208706,6 +213856,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -209245,6 +214399,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -211834,6 +216998,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -212373,6 +217541,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -215282,6 +220460,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -215821,6 +221003,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -218399,6 +223591,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -218938,6 +224134,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -222204,6 +227410,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -222743,6 +227953,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -225417,6 +230637,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -225956,6 +231180,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -229241,6 +234475,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -232275,6 +237513,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -235464,6 +240706,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -236161,8 +241407,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example request body", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permissions": "write" + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -238270,6 +243519,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -241114,6 +246367,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -246294,6 +251551,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -247938,6 +253199,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -249451,6 +254716,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ] }, @@ -252032,6 +257301,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ] } @@ -256449,6 +261722,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -260077,6 +265354,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -289702,8 +294983,12 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example request body", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "limit": "collaborators_only", + "expiry": "one_day" + }, "parameters": { "owner": "OWNER", "repo": "REPO" @@ -293058,6 +298343,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -296558,6 +301847,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -297394,7 +302687,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ], "schema": { @@ -299975,6 +305269,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -300751,7 +306049,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -303329,6 +308628,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -304072,7 +309375,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -306650,6 +311954,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -307245,6 +312553,12 @@ "closed" ] }, + { + "type": "string or null", + "name": "state_reason", + "in": "body", + "description": "

The reason for the current state

" + }, { "type": "null or string or integer or string or integer", "name": "milestone", @@ -307449,7 +312763,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -310027,6 +315342,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -313697,6 +319016,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -314779,7 +320102,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -317357,6 +322681,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -318094,7 +323422,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -320672,6 +326001,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -325303,7 +330636,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ], @@ -328113,6 +333447,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -330247,7 +335585,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } }, "schema": { @@ -333054,6 +338393,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -360624,6 +365967,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -369392,6 +374739,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -371385,6 +376736,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -373350,6 +378705,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -375821,6 +381180,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -379655,6 +385018,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -381647,6 +387014,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -383605,6 +388976,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -386065,6 +391440,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -386927,6 +392306,48 @@ "updated_at": { "type": "string", "format": "date-time" + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] } }, "required": [ @@ -387130,6 +392551,42 @@ "name": "blog", "in": "body", "description": "" + }, + { + "type": "boolean", + "name": "advanced_security_enabled_for_new_repositories", + "in": "body", + "description": "

Whether GitHub Advanced Security is automatically enabled for new repositories.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + }, + { + "type": "boolean", + "name": "dependabot_alerts_enabled_for_new_repositories", + "in": "body", + "description": "

Whether Dependabot alerts is automatically enabled for new repositories.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + }, + { + "type": "boolean", + "name": "dependabot_security_updates_enabled_for_new_repositories", + "in": "body", + "description": "

Whether Dependabot security updates is automatically enabled for new repositories.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + }, + { + "type": "boolean", + "name": "dependency_graph_enabled_for_new_repositories", + "in": "body", + "description": "

Whether dependency graph is automatically enabled for new repositories.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + }, + { + "type": "boolean", + "name": "secret_scanning_enabled_for_new_repositories", + "in": "body", + "description": "

Whether secret scanning is automatically enabled for new repositories.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + }, + { + "type": "boolean", + "name": "secret_scanning_push_protection_enabled_for_new_repositories", + "in": "body", + "description": "

Whether secret scanning push protection is automatically enabled for new repositories.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" } ], "enabledForGitHubApps": true, @@ -387558,6 +393015,48 @@ "updated_at": { "type": "string", "format": "date-time" + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] } }, "required": [ @@ -388651,14 +394150,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -388803,6 +394294,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -389141,6 +394640,87 @@ ], "subcategory": "orgs" }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/{security_product}/{enablement}", + "title": "Enable or disable a security feature for an organization", + "category": "orgs", + "subcategory": "orgs", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "security_product", + "in": "path", + "description": "

The security feature to enable or disable.

", + "required": true, + "schema": { + "type": "string", + "enum": [ + "dependency_graph", + "dependabot_alerts", + "dependabot_security_updates", + "advanced_security", + "secret_scanning", + "secret_scanning_push_protection" + ] + } + }, + { + "name": "enablement", + "in": "path", + "description": "

The action to take.

\n

enable_all means to enable the specified security feature for all repositories in the organization.\ndisable_all means to disable the specified security feature for all repositories in the organization.

", + "required": true, + "schema": { + "type": "string", + "enum": [ + "enable_all", + "disable_all" + ] + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "security_product": "SECURITY_PRODUCT", + "enablement": "ENABLEMENT" + } + }, + "response": { + "statusCode": "204", + "description": "

Action started

" + } + } + ], + "previews": [], + "descriptionHTML": "

Enables or disables the specified security feature for all repositories in an organization.

\n

To use this endpoint, you must be an organization owner or be member of a team with the security manager role.\nA token with the 'write:org' scope is also required.

\n

GitHub Apps must have the organization_administration:write permission to use this endpoint.

\n

For more information, see \"Managing security managers in your organization.\"

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

Action started

" + }, + { + "httpStatusCode": "422", + "description": "

The action could not be taken due to an in progress enablement, or a policy is preventing enablement

" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -389999,7 +395579,7 @@ } ], "previews": [], - "descriptionHTML": "

List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.

\n

For more information on custom repository roles, see \"Managing custom repository roles for an organization\".

", + "descriptionHTML": "

List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.

\n

To use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with admin:org repo scope.\nGitHub Apps must have the organization_custom_roles:read organization permission to use this endpoint.

\n

For more information on custom repository roles, see \"Managing custom repository roles for an organization\".

", "statusCodes": [ { "httpStatusCode": "200", @@ -391661,10 +397241,6 @@ "httpStatusCode": "200", "description": "

OK

" }, - { - "httpStatusCode": "302", - "description": "

Response if requester is not an organization member

" - }, { "httpStatusCode": "422", "description": "

Validation failed

" @@ -399430,6 +405006,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -402006,6 +407586,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -405476,6 +411060,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -408101,6 +413689,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -411531,6 +417123,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -414174,6 +419770,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -427615,6 +433215,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -429259,6 +434863,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -437588,6 +443196,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ], "subcategory": "pulls" @@ -442499,6 +448111,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ], "subcategory": "pulls" @@ -450734,6 +456350,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -452378,6 +457998,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -456412,6 +462036,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -458056,6 +463684,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -479683,6 +485315,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -481647,6 +487283,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -484324,6 +489964,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -486123,6 +491767,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -487578,6 +493226,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -490672,6 +496324,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -492471,6 +498127,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -493926,6 +499586,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -497815,6 +503479,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -499810,6 +505478,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -499892,7 +505564,7 @@ } ], "previews": [], - "descriptionHTML": "

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

\n

OAuth scope requirements

\n

When using OAuth, authorizations must include:

\n
    \n
  • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
  • \n
  • repo scope to create a private repository
  • \n
", + "descriptionHTML": "

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

\n

OAuth scope requirements

\n

When using OAuth, authorizations must include:

\n
    \n
  • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
  • \n
  • repo scope to create a private repository
  • \n
", "statusCodes": [ { "httpStatusCode": "201", @@ -501971,6 +507643,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -503864,6 +509540,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -505653,6 +511333,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -507938,6 +513622,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -508280,14 +513968,18 @@ ] }, "is_alphanumeric": { - "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference is a legacy autolink that only matches numeric characters.", - "type": "boolean" + "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.", + "type": "boolean", + "examples": [ + true + ] } }, "required": [ "id", "key_prefix", - "url_template" + "url_template", + "is_alphanumeric" ] } } @@ -508335,15 +514027,22 @@ "type": "string", "name": "key_prefix", "in": "body", - "description": "

The prefix appended by alphanumeric characters will generate a link any time it is found in an issue, pull request, or commit.

", + "description": "

This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit.

", "isRequired": true }, { "type": "string", "name": "url_template", "in": "body", - "description": "

The URL must contain <num> for the reference number. <num> matches alphanumeric characters A-Z (case insensitive), 0-9, and -.

", + "description": "

The URL must contain <num> for the reference number. <num> matches different characters depending on the value of is_alphanumeric.

", "isRequired": true + }, + { + "type": "boolean", + "name": "is_alphanumeric", + "in": "body", + "description": "

Whether this autolink reference matches alphanumeric characters. If true, the <num> parameter of the url_template matches alphanumeric characters A-Z (case insensitive), 0-9, and -. If false, this autolink reference only matches numeric characters.

", + "default": "true" } ], "enabledForGitHubApps": true, @@ -508356,7 +514055,8 @@ "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=" + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true }, "parameters": { "owner": "OWNER", @@ -508399,14 +514099,18 @@ ] }, "is_alphanumeric": { - "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference is a legacy autolink that only matches numeric characters.", - "type": "boolean" + "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.", + "type": "boolean", + "examples": [ + true + ] } }, "required": [ "id", "key_prefix", - "url_template" + "url_template", + "is_alphanumeric" ] } } @@ -508511,14 +514215,18 @@ ] }, "is_alphanumeric": { - "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference is a legacy autolink that only matches numeric characters.", - "type": "boolean" + "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.", + "type": "boolean", + "examples": [ + true + ] } }, "required": [ "id", "key_prefix", - "url_template" + "url_template", + "is_alphanumeric" ] } } @@ -514112,6 +519820,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -514405,6 +520117,12 @@ "name": "name", "in": "body", "description": "

When forking from an existing repository, a new name for the fork.

" + }, + { + "type": "boolean", + "name": "default_branch_only", + "in": "body", + "description": "

When forking from an existing repository, fork with only the default branch.

" } ], "enabledForGitHubApps": true, @@ -516962,6 +522680,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -518761,6 +524483,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -520216,6 +525942,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -525456,6 +531186,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -528348,6 +534082,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -528847,7 +534585,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] }, @@ -531284,6 +537023,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -543985,6 +549728,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -546674,6 +552421,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -552607,6 +558358,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -555290,6 +561045,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -575352,6 +581111,487 @@ } ] } + ], + "ssh-signing-keys": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/user/ssh_signing_keys", + "title": "List SSH signing keys for the authenticated user", + "category": "users", + "subcategory": "ssh-signing-keys", + "parameters": [ + { + "name": "per_page", + "description": "

The number of results per page (max 100).

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

Page number of the results to fetch.

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "id": 2, + "url": "https://api.github.com/user/keys/2", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z" + }, + { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234", + "id": 3, + "url": "https://api.github.com/user/keys/3", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAB", + "created_at": "2020-07-11T21:31:57Z" + } + ], + "schema": { + "type": "array", + "items": { + "title": "SSH Signing Key", + "description": "A public SSH key used to sign Git commits", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "key", + "id", + "title", + "created_at" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least read:ssh_signing_key scope. For more information, see \"Understanding scopes for OAuth apps.\"

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/user/ssh_signing_keys", + "title": "Create a SSH signing key for the authenticated user", + "category": "users", + "subcategory": "ssh-signing-keys", + "parameters": [], + "bodyParameters": [ + { + "type": "string", + "name": "title", + "in": "body", + "description": "

A descriptive name for the new key.

" + }, + { + "type": "string", + "name": "key", + "in": "body", + "description": "

The public SSH key to add to your GitHub account. For more information, see \"Checking for existing SSH keys.\"

", + "isRequired": true + } + ], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "id": 2, + "url": "https://api.github.com/user/keys/2", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z" + }, + "schema": { + "title": "SSH Signing Key", + "description": "A public SSH key used to sign Git commits", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "key", + "id", + "title", + "created_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Creates an SSH signing key for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least write:ssh_signing_key scope. For more information, see \"Understanding scopes for OAuth apps.\"

", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/user/ssh_signing_keys/{ssh_signing_key_id}", + "title": "Get an SSH signing key for the authenticated user", + "category": "users", + "subcategory": "ssh-signing-keys", + "parameters": [ + { + "name": "ssh_signing_key_id", + "description": "

The unique identifier of the SSH signing key.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "ssh_signing_key_id": "SSH_SIGNING_KEY_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "id": 2, + "url": "https://api.github.com/user/keys/2", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z" + }, + "schema": { + "title": "SSH Signing Key", + "description": "A public SSH key used to sign Git commits", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "key", + "id", + "title", + "created_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least read:ssh_signing_key scope. For more information, see \"Understanding scopes for OAuth apps.\"

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/user/ssh_signing_keys/{ssh_signing_key_id}", + "title": "Delete an SSH signing key for the authenticated user", + "category": "users", + "subcategory": "ssh-signing-keys", + "parameters": [ + { + "name": "ssh_signing_key_id", + "description": "

The unique identifier of the SSH signing key.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "204", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "ssh_signing_key_id": "SSH_SIGNING_KEY_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Deletes an SSH signing key from the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least admin:ssh_signing_key scope. For more information, see \"Understanding scopes for OAuth apps.\"

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/ssh_signing_keys", + "title": "List SSH signing keys for a user", + "category": "users", + "subcategory": "ssh-signing-keys", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100).

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

Page number of the results to fetch.

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "id": 2, + "url": "https://api.github.com/user/keys/2", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z" + }, + { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234", + "id": 3, + "url": "https://api.github.com/user/keys/3", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAB", + "created_at": "2020-07-11T21:31:57Z" + } + ], + "schema": { + "type": "array", + "items": { + "title": "SSH Signing Key", + "description": "A public SSH key used to sign Git commits", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "key", + "id", + "title", + "created_at" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists the SSH signing keys for a user. This operation is accessible by anyone.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + } + ] + } ] }, "webhooks": { diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json index 6b31a9783b31..9282a9335030 100644 --- a/lib/rest/static/decorated/ghes-3.2.json +++ b/lib/rest/static/decorated/ghes-3.2.json @@ -3136,6 +3136,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -6431,6 +6435,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -12113,6 +12121,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -14669,6 +14681,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -16138,6 +16154,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -18157,6 +18177,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -19626,6 +19650,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -21675,6 +21703,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -23154,6 +23186,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -26881,6 +26917,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -28981,6 +29021,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -31706,6 +31750,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -33806,6 +33854,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -38710,6 +38762,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -40810,6 +40866,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -44431,6 +44491,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -48373,6 +48437,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -52309,6 +52377,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -56239,6 +56311,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -60159,6 +60235,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -64100,6 +64180,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -68020,6 +68104,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -71951,6 +72039,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -75882,6 +75974,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -79425,6 +79521,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -81818,6 +81918,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -84573,6 +84677,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -87290,6 +87398,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -88805,6 +88917,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -90629,6 +90745,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -92001,6 +92121,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -94684,6 +94808,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -96969,6 +97097,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -98536,14 +98668,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -99473,14 +99597,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -100103,15 +100219,6 @@ "write" ] }, - { - "type": "string", - "name": "organization_custom_roles", - "description": "

The level of permission to grant the access token for custom roles management.

", - "enum": [ - "read", - "write" - ] - }, { "type": "string", "name": "deployments", @@ -100563,14 +100670,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -102089,6 +102188,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -103189,14 +103292,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -104130,14 +104225,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -105069,14 +105156,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -107026,6 +107105,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -107836,14 +107919,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -109830,6 +109905,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -110600,14 +110679,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -111479,14 +111550,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -112126,15 +112189,6 @@ "write" ] }, - { - "type": "string", - "name": "organization_custom_roles", - "description": "

The level of permission to grant the access token for custom roles management.

", - "enum": [ - "read", - "write" - ] - }, { "type": "string", "name": "deployments", @@ -112775,14 +112829,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -113665,14 +113711,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -114540,14 +114578,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -117204,131 +117234,48 @@ }, "response": { "statusCode": "200", - "description": "

Response

" - } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "301", - "description": "

Moved permanently

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/rename", - "title": "Rename a branch", - "category": "branches", - "subcategory": "branches", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "new_name", - "in": "body", - "description": "

The new name of the branch.

", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "new_name": "my_renamed_branch" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "201", "contentType": "application/json", "description": "

Response

", "example": { - "name": "master", + "name": "main", "commit": { "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", - "node_id": "MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", "commit": { "author": { "name": "The Octocat", - "date": "2012-03-06T15:06:50-08:00", - "email": "octocat@nowhere.com" + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" }, - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", "tree": { "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" }, - "committer": { - "name": "The Octocat", - "date": "2012-03-06T15:06:50-08:00", - "email": "octocat@nowhere.com" - }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null - }, - "comment_count": 0 + } }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", "gravatar_id": "", - "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", "url": "https://api.github.com/users/octocat", - "id": 583231, - "login": "octocat", - "node_id": "MDQ6VXNlcjE=", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", @@ -117340,26 +117287,15 @@ "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", - "site_admin": true + "site_admin": false }, - "parents": [ - { - "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" - }, - { - "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303" - } - ], - "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", "gravatar_id": "", - "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", "url": "https://api.github.com/users/octocat", - "id": 583231, - "login": "octocat", - "node_id": "MDQ6VXNlcjE=", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", @@ -117371,26 +117307,35 @@ "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", - "site_admin": true + "site_admin": false }, - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] }, "_links": { - "html": "https://github.com/octocat/Hello-World/tree/master", - "self": "https://api.github.com/repos/octocat/Hello-World/branches/master" + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" }, - "protected": true, + "protected": false, "protection": { + "enabled": false, "required_status_checks": { - "enforcement_level": "non_admins", - "contexts": [ - "ci-test", - "linter" - ] + "enforcement_level": "off", + "contexts": [], + "checks": [] } }, - "protection_url": "https://api.github.com/repos/octocat/hello-world/branches/master/protection" + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" }, "schema": { "title": "Branch With Protection", @@ -119335,32 +119280,28 @@ } } ], + "descriptionHTML": "", "previews": [], - "descriptionHTML": "

Renames a branch in a repository.

\n

Note: Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".

\n

The permissions required to use this endpoint depends on whether you are renaming the default branch.

\n

To rename a non-default branch:

\n
    \n
  • Users must have push access.
  • \n
  • GitHub Apps must have the contents:write repository permission.
  • \n
\n

To rename the default branch:

\n
    \n
  • Users must have admin or owner permissions.
  • \n
  • GitHub Apps must have the administration:write repository permission.
  • \n
", "statusCodes": [ { - "httpStatusCode": "201", - "description": "

Created

" + "httpStatusCode": "200", + "description": "

OK

" }, { - "httpStatusCode": "403", - "description": "

Forbidden

" + "httpStatusCode": "301", + "description": "

Moved permanently

" }, { "httpStatusCode": "404", "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/merges", - "title": "Merge a branch", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/rename", + "title": "Rename a branch", "category": "branches", "subcategory": "branches", "parameters": [ @@ -119381,28 +119322,25 @@ "schema": { "type": "string" } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true } ], "bodyParameters": [ { "type": "string", - "name": "base", - "in": "body", - "description": "

The name of the base branch that the head will be merged into.

", - "isRequired": true - }, - { - "type": "string", - "name": "head", + "name": "new_name", "in": "body", - "description": "

The head to merge. This can be a branch name or a commit SHA1.

", + "description": "

The new name of the branch.

", "isRequired": true - }, - { - "type": "string", - "name": "commit_message", - "in": "body", - "description": "

Commit message to use for the merge commit. If omitted, a default message will be used.

" } ], "enabledForGitHubApps": true, @@ -119414,153 +119352,129 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "base": "master", - "head": "cool_feature", - "commit_message": "Shipped cool_feature!" + "new_name": "my_renamed_branch" }, "parameters": { "owner": "OWNER", - "repo": "REPO" + "repo": "REPO", + "branch": "BRANCH" } }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "

Successful Response (The resulting merge commit)

", + "description": "

Response

", "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", + "name": "master", "commit": { - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==", + "commit": { + "author": { + "name": "The Octocat", + "date": "2012-03-06T15:06:50-08:00", + "email": "octocat@nowhere.com" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "committer": { + "name": "The Octocat", + "date": "2012-03-06T15:06:50-08:00", + "email": "octocat@nowhere.com" + }, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + }, + "comment_count": 0 + }, "author": { - "name": "Monalisa Octocat", - "email": "mona@github.com", - "date": "2011-04-14T16:00:49Z" + "gravatar_id": "", + "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", + "url": "https://api.github.com/users/octocat", + "id": 583231, + "login": "octocat", + "node_id": "MDQ6VXNlcjE=", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ], + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "committer": { - "name": "Monalisa Octocat", - "email": "mona@github.com", - "date": "2011-04-14T16:00:49Z" - }, - "message": "Fix all the bugs", - "tree": { - "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + "gravatar_id": "", + "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", + "url": "https://api.github.com/users/octocat", + "id": 583231, + "login": "octocat", + "node_id": "MDQ6VXNlcjE=", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true }, - "comment_count": 0, - "verification": { - "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null - } - }, - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" }, - "committer": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "_links": { + "html": "https://github.com/octocat/Hello-World/tree/master", + "self": "https://api.github.com/repos/octocat/Hello-World/branches/master" }, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + "protected": true, + "protection": { + "required_status_checks": { + "enforcement_level": "non_admins", + "contexts": [ + "ci-test", + "linter" + ] } - ], - "stats": { - "additions": 104, - "deletions": 4, - "total": 108 }, - "files": [ - { - "filename": "file1.txt", - "additions": 10, - "deletions": 2, - "changes": 12, - "status": "modified", - "raw_url": "https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", - "blob_url": "https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", - "patch": "@@ -29,7 +29,7 @@\n....." - } - ] + "protection_url": "https://api.github.com/repos/octocat/hello-world/branches/master/protection" }, "schema": { - "title": "Commit", - "description": "Commit", + "title": "Branch With Protection", + "description": "Branch With Protection", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "sha": { - "type": "string", - "examples": [ - "6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" - ] + "name": { + "type": "string" }, "commit": { + "title": "Commit", + "description": "Commit", "type": "object", "properties": { "url": { @@ -119570,35 +119484,345 @@ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, + "sha": { + "type": "string", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + ] + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { + "type": "string", + "examples": [ + "Fix all the bugs" + ] + }, + "comment_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" + ] + } + }, + "required": [ + "sha", + "url" + ] + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "payload": { + "type": [ + "string", + "null" + ] + }, + "signature": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature" + ] + } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, "author": { "anyOf": [ { "type": "null" }, { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", "examples": [ - "\"Chris Wanstrath\"" + "octocat" ] }, - "email": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", "examples": [ - "\"chris@ozmm.org\"" + "MDQ6VXNlcjE=" ] }, - "date": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "\"2007-10-29T02:42:39.000-07:00\"" + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } ] }, @@ -119608,373 +119832,2221 @@ "type": "null" }, { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", "examples": [ - "\"Chris Wanstrath\"" + "octocat" ] }, - "email": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", "examples": [ - "\"chris@ozmm.org\"" + "MDQ6VXNlcjE=" ] }, - "date": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "\"2007-10-29T02:42:39.000-07:00\"" + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } ] }, - "message": { - "type": "string", - "examples": [ - "Fix all the bugs" - ] - }, - "comment_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "tree": { - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "827efc6d56897b048c772eb4087f854f46256132" - ] + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + } }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" - ] - } - }, - "required": [ - "sha", - "url" - ] + "required": [ + "sha", + "url" + ] + } }, - "verification": { - "title": "Verification", + "stats": { "type": "object", "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" + "additions": { + "type": "integer" }, - "payload": { - "type": [ - "string", - "null" - ] + "deletions": { + "type": "integer" }, - "signature": { - "type": [ - "string", - "null" - ] + "total": { + "type": "integer" } - }, - "required": [ - "verified", - "reason", - "payload", - "signature" - ] + } + }, + "files": { + "type": "array", + "items": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" + ] + }, + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "examples": [ + "added" + ] + }, + "additions": { + "type": "integer", + "examples": [ + 103 + ] + }, + "deletions": { + "type": "integer", + "examples": [ + 21 + ] + }, + "changes": { + "type": "integer", + "examples": [ + 124 + ] + }, + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" + ] + } + }, + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + } } }, "required": [ + "url", + "sha", + "node_id", + "html_url", + "comments_url", + "commit", "author", "committer", - "comment_count", - "message", - "tree", - "url" + "parents" ] }, - "author": { - "anyOf": [ - { - "type": "null" + "_links": { + "type": "object", + "properties": { + "html": { + "type": "string" }, - { - "title": "Simple User", - "description": "Simple User", + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "html", + "self" + ] + }, + "protected": { + "type": "boolean" + }, + "protection": { + "title": "Branch Protection", + "description": "Branch Protection", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] + "url": { + "type": "string" }, - "email": { - "type": [ - "string", - "null" - ] + "enforcement_level": { + "type": "string" }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] + "contexts": { + "type": "array", + "items": { + "type": "string" + } }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] + "contexts_url": { + "type": "string" }, + "strict": { + "type": "boolean" + } + }, + "required": [ + "contexts" + ] + }, + "enforce_admins": { + "title": "Protected Branch Admin Enforced", + "description": "Protected Branch Admin Enforced", + "type": "object", + "properties": { "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" ] }, - "organizations_url": { - "type": "string", - "format": "uri", + "enabled": { + "type": "boolean", "examples": [ - "https://api.github.com/users/octocat/orgs" + true ] - }, - "repos_url": { + } + }, + "required": [ + "url", + "enabled" + ] + }, + "required_pull_request_reviews": { + "title": "Protected Branch Pull Request Review", + "description": "Protected Branch Pull Request Review", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" ] }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "dismissal_restrictions": { + "type": "object", + "properties": { + "users": { + "description": "The list of users with review dismissal access.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams with review dismissal access.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps with review dismissal access.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" + ] + }, + "users_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" + ] + }, + "teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" + ] + } + } }, - "received_events_url": { - "type": "string", - "format": "uri", + "dismiss_stale_reviews": { + "type": "boolean", "examples": [ - "https://api.github.com/users/octocat/received_events" + true ] }, - "type": { - "type": "string", + "require_code_owner_reviews": { + "type": "boolean", "examples": [ - "User" + true ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "required_approving_review_count": { + "type": "integer", + "minimum": 1, + "maximum": 6, "examples": [ - "\"2020-07-09T00:17:55Z\"" + 2 ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "dismiss_stale_reviews", + "require_code_owner_reviews" ] - } - ] - }, - "committer": { - "anyOf": [ - { - "type": "null" }, - { - "title": "Simple User", - "description": "Simple User", + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] + "format": "uri" }, - "followers_url": { + "users_url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "format": "uri" }, - "following_url": { + "teams_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "format": "uri" }, - "gists_url": { + "apps_url": { "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "format": "uri" }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "name": { + "type": "string", + "examples": [ + "\"branch/with/protection\"" + ] + }, + "protection_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + } + } + }, + "protection_url": { + "type": "string", + "format": "uri" + }, + "pattern": { + "type": "string", + "examples": [ + "\"mas*\"" + ] + }, + "required_approving_review_count": { + "type": "integer", + "examples": [ + 1 + ] + } + }, + "required": [ + "name", + "commit", + "_links", + "protection", + "protected", + "protection_url" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Renames a branch in a repository.

\n

Note: Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".

\n

The permissions required to use this endpoint depends on whether you are renaming the default branch.

\n

To rename a non-default branch:

\n
    \n
  • Users must have push access.
  • \n
  • GitHub Apps must have the contents:write repository permission.
  • \n
\n

To rename the default branch:

\n
    \n
  • Users must have admin or owner permissions.
  • \n
  • GitHub Apps must have the administration:write repository permission.
  • \n
", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/merges", + "title": "Merge a branch", + "category": "branches", + "subcategory": "branches", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "base", + "in": "body", + "description": "

The name of the base branch that the head will be merged into.

", + "isRequired": true + }, + { + "type": "string", + "name": "head", + "in": "body", + "description": "

The head to merge. This can be a branch name or a commit SHA1.

", + "isRequired": true + }, + { + "type": "string", + "name": "commit_message", + "in": "body", + "description": "

Commit message to use for the merge commit. If omitted, a default message will be used.

" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "base": "master", + "head": "cool_feature", + "commit_message": "Shipped cool_feature!" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Successful Response (The resulting merge commit)

", + "example": { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", + "commit": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "author": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "committer": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "message": "Fix all the bugs", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "comment_count": 0, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + ], + "stats": { + "additions": 104, + "deletions": 4, + "total": 108 + }, + "files": [ + { + "filename": "file1.txt", + "additions": 10, + "deletions": 2, + "changes": 12, + "status": "modified", + "raw_url": "https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", + "blob_url": "https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", + "patch": "@@ -29,7 +29,7 @@\n....." + } + ] + }, + "schema": { + "title": "Commit", + "description": "Commit", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "sha": { + "type": "string", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + ] + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { + "type": "string", + "examples": [ + "Fix all the bugs" + ] + }, + "comment_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" + ] + } + }, + "required": [ + "sha", + "url" + ] + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "payload": { + "type": [ + "string", + "null" + ] + }, + "signature": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature" + ] + } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, @@ -120044,203 +122116,1677 @@ } ] }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" - ] + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + } + }, + "required": [ + "sha", + "url" + ] + } + }, + "stats": { + "type": "object", + "properties": { + "additions": { + "type": "integer" + }, + "deletions": { + "type": "integer" + }, + "total": { + "type": "integer" + } + } + }, + "files": { + "type": "array", + "items": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" + ] + }, + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "examples": [ + "added" + ] + }, + "additions": { + "type": "integer", + "examples": [ + 103 + ] + }, + "deletions": { + "type": "integer", + "examples": [ + 21 + ] + }, + "changes": { + "type": "integer", + "examples": [ + 124 + ] + }, + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" + ] + } + }, + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + } + } + }, + "required": [ + "url", + "sha", + "node_id", + "html_url", + "comments_url", + "commit", + "author", + "committer", + "parents" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Successful Response (The resulting merge commit)

" + }, + { + "httpStatusCode": "204", + "description": "

Response when already merged

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Not Found when the base or head does not exist

" + }, + { + "httpStatusCode": "409", + "description": "

Conflict when there is a merge conflict

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed

" + } + ] + } + ], + "branch-protection": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", + "title": "Get branch protection", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts", + "enforcement_level": "non_admins" + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", + "enabled": true + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", + "users": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "apps": [ + { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + } + ] + }, + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2 + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps", + "users": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "apps": [ + { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + } + ] + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + }, + "schema": { + "title": "Branch Protection", + "description": "Branch Protection", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enforcement_level": { + "type": "string" + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + } + }, + "contexts_url": { + "type": "string" + }, + "strict": { + "type": "boolean" + } + }, + "required": [ + "contexts" + ] + }, + "enforce_admins": { + "title": "Protected Branch Admin Enforced", + "description": "Protected Branch Admin Enforced", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "required_pull_request_reviews": { + "title": "Protected Branch Pull Request Review", + "description": "Protected Branch Pull Request Review", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" + ] + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "users": { + "description": "The list of users with review dismissal access.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams with review dismissal access.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps with review dismissal access.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" + ] + }, + "users_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" + ] + }, + "teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" + ] + } + } + }, + "dismiss_stale_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "require_code_owner_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "required_approving_review_count": { + "type": "integer", + "minimum": 1, + "maximum": 6, + "examples": [ + 2 + ] + } + }, + "required": [ + "dismiss_stale_reviews", + "require_code_owner_reviews" + ] + }, + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } } }, - "required": [ - "sha", - "url" - ] + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } } }, - "stats": { + "allow_force_pushes": { "type": "object", "properties": { - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "total": { - "type": "integer" + "enabled": { + "type": "boolean" } } }, - "files": { - "type": "array", - "items": { - "title": "Diff Entry", - "description": "Diff Entry", - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "bbcd538c8e72b8c175046e27cc8f907076331401" - ] - }, - "filename": { - "type": "string", - "examples": [ - "file1.txt" - ] - }, - "status": { - "type": "string", - "enum": [ - "added", - "removed", - "modified", - "renamed", - "copied", - "changed", - "unchanged" - ], - "examples": [ - "added" - ] - }, - "additions": { - "type": "integer", - "examples": [ - 103 - ] - }, - "deletions": { - "type": "integer", - "examples": [ - 21 - ] - }, - "changes": { - "type": "integer", - "examples": [ - 124 - ] - }, - "blob_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "raw_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "contents_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "patch": { - "type": "string", - "examples": [ - "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" - ] - }, - "previous_filename": { - "type": "string", - "examples": [ - "file.txt" - ] - } - }, - "required": [ - "additions", - "blob_url", - "changes", - "contents_url", - "deletions", - "filename", - "raw_url", - "sha", - "status" - ] + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } } + }, + "name": { + "type": "string", + "examples": [ + "\"branch/with/protection\"" + ] + }, + "protection_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] } - }, - "required": [ - "url", - "sha", - "node_id", - "html_url", - "comments_url", - "commit", - "author", - "committer", - "parents" - ] + } } } } ], - "descriptionHTML": "", - "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", "statusCodes": [ { - "httpStatusCode": "201", - "description": "

Successful Response (The resulting merge commit)

" - }, - { - "httpStatusCode": "204", - "description": "

Response when already merged

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" + "httpStatusCode": "200", + "description": "

OK

" }, { "httpStatusCode": "404", - "description": "

Not Found when the base or head does not exist

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict when there is a merge conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed

" + "description": "

Resource not found

" } + ], + "previews": [ + "

The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.luke-cage-preview+json
" ] - } - ], - "branch-protection": [ + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", + "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "title": "Get branch protection", + "title": "Update branch protection", "category": "branches", "subcategory": "branch-protection", "parameters": [ @@ -120273,205 +123819,273 @@ "x-multi-segment": true } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "object or null", + "name": "required_status_checks", + "in": "body", + "description": "

Require status checks to pass before merging. Set to null to disable.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "strict", + "description": "

Require branches to be up to date before merging.

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "contexts", + "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "isRequired": true + }, + { + "type": "array of objects", + "name": "checks", + "description": "

The list of status checks to require in order to merge into this branch.

", + "childParamsGroups": [ + { + "type": "string", + "name": "context", + "description": "

The name of the required check

", + "isRequired": true + }, + { + "type": "integer", + "name": "app_id", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" + } + ] + } + ] + }, + { + "type": "boolean or null", + "name": "enforce_admins", + "in": "body", + "description": "

Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "required_pull_request_reviews", + "in": "body", + "description": "

Require at least one approving review on a pull request, before merging. Set to null to disable.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "dismissal_restrictions", + "description": "

Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "users", + "description": "

The list of user logins with dismissal access

" + }, + { + "type": "array of strings", + "name": "teams", + "description": "

The list of team slugs with dismissal access

" + }, + { + "type": "array of strings", + "name": "apps", + "description": "

The list of app slugs with dismissal access

" + } + ] + }, + { + "type": "boolean", + "name": "dismiss_stale_reviews", + "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

" + }, + { + "type": "boolean", + "name": "require_code_owner_reviews", + "description": "

Blocks merging pull requests until code owners review them.

" + }, + { + "type": "integer", + "name": "required_approving_review_count", + "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.

" + } + ] + }, + { + "type": "object or null", + "name": "restrictions", + "in": "body", + "description": "

Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of strings", + "name": "users", + "description": "

The list of user logins with push access

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "teams", + "description": "

The list of team slugs with push access

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "apps", + "description": "

The list of app slugs with push access

" + } + ] + }, + { + "type": "boolean", + "name": "required_linear_history", + "in": "body", + "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

" + }, + { + "type": "boolean or null", + "name": "allow_force_pushes", + "in": "body", + "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

" + }, + { + "type": "boolean", + "name": "allow_deletions", + "in": "body", + "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

" + }, + { + "type": "boolean", + "name": "block_creations", + "in": "body", + "description": "

If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

" + }, + { + "type": "boolean", + "name": "required_conversation_resolution", + "in": "body", + "description": "

Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

" + }, + { + "type": "array of strings", + "name": "contexts", + "in": "body", + "description": "

The list of status checks to require in order to merge into this branch.

" + } + ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { + "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection", + "bodyParameters": { "required_status_checks": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", + "strict": true, "contexts": [ "continuous-integration/travis-ci" - ], - "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts", - "enforcement_level": "non_admins" - }, - "enforce_admins": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", - "enabled": true + ] }, + "enforce_admins": true, "required_pull_request_reviews": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", "dismissal_restrictions": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", - "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", "users": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } + "octocat" ], "teams": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "apps": [ - { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] - } + "justice-league" ] }, "dismiss_stale_reviews": true, "require_code_owner_reviews": true, - "required_approving_review_count": 2 + "required_approving_review_count": 2, + "bypass_pull_request_allowances": { + "users": [ + "octocat" + ], + "teams": [ + "justice-league" + ] + } }, "restrictions": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", - "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams", - "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps", "users": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } + "octocat" ], "teams": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } + "justice-league" ], "apps": [ + "super-ci" + ] + }, + "required_linear_history": true, + "allow_force_pushes": true, + "allow_deletions": true, + "block_creations": true, + "required_conversation_resolution": true + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] + "context": "continuous-integration/travis-ci", + "app_id": null } ] }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [], + "teams": [], + "apps": [] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [], + "teams": [], + "apps": [] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, "required_linear_history": { "enabled": true }, @@ -120481,90 +124095,96 @@ "allow_deletions": { "enabled": true }, + "block_creations": { + "enabled": true + }, "required_conversation_resolution": { "enabled": true } }, "schema": { - "title": "Branch Protection", - "description": "Branch Protection", + "title": "Protected Branch", + "description": "Branch protections protect branches", "type": "object", "properties": { "url": { - "type": "string" - }, - "enabled": { - "type": "boolean" + "type": "string", + "format": "uri" }, "required_status_checks": { - "title": "Protected Branch Required Status Check", - "description": "Protected Branch Required Status Check", + "title": "Status Check Policy", + "description": "Status Check Policy", "type": "object", "properties": { "url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" + ] }, - "enforcement_level": { - "type": "string" + "strict": { + "type": "boolean", + "examples": [ + true + ] }, "contexts": { "type": "array", "items": { "type": "string" - } + }, + "examples": [ + "continuous-integration/travis-ci" + ] }, "contexts_url": { - "type": "string" - }, - "strict": { - "type": "boolean" - } - }, - "required": [ - "contexts" - ] - }, - "enforce_admins": { - "title": "Protected Branch Admin Enforced", - "description": "Protected Branch Admin Enforced", - "type": "object", - "properties": { - "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" - ] - }, - "enabled": { - "type": "boolean", - "examples": [ - true + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" ] } }, "required": [ "url", - "enabled" + "contexts_url", + "strict", + "contexts" ] }, "required_pull_request_reviews": { - "title": "Protected Branch Pull Request Review", - "description": "Protected Branch Pull Request Review", "type": "object", "properties": { "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" - ] + "format": "uri" + }, + "dismiss_stale_reviews": { + "type": "boolean" + }, + "require_code_owner_reviews": { + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" }, "dismissal_restrictions": { "type": "object", "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, "users": { - "description": "The list of users with review dismissal access.", "type": "array", "items": { "title": "Simple User", @@ -120729,7 +124349,6 @@ } }, "teams": { - "description": "The list of teams with review dismissal access.", "type": "array", "items": { "title": "Team", @@ -120933,7 +124552,6 @@ } }, "apps": { - "description": "The list of apps with review dismissal access.", "type": "array", "items": { "title": "GitHub app", @@ -121260,51 +124878,94 @@ "events" ] } - }, - "url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" - ] - }, - "users_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" - ] - }, - "teams_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" - ] } - } - }, - "dismiss_stale_reviews": { - "type": "boolean", + }, + "required": [ + "url", + "users_url", + "teams_url", + "users", + "teams" + ] + } + }, + "required": [ + "url" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", "examples": [ - true + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" ] }, - "require_code_owner_reviews": { + "enabled": { "type": "boolean", "examples": [ true ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "enforce_admins": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" }, - "required_approving_review_count": { - "type": "integer", - "minimum": 1, - "maximum": 6, - "examples": [ - 2 - ] + "enabled": { + "type": "boolean" } }, + "additionalProperties": false, "required": [ - "dismiss_stale_reviews", - "require_code_owner_reviews" + "url", + "enabled" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" ] }, "restrictions": { @@ -121616,29 +125277,14 @@ "apps" ] }, - "required_linear_history": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "allow_force_pushes": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "allow_deletions": { + "required_conversation_resolution": { "type": "object", "properties": { "enabled": { "type": "boolean" } - } + }, + "additionalProperties": false }, "block_creations": { "type": "object", @@ -121646,326 +125292,17 @@ "enabled": { "type": "boolean" } - } - }, - "required_conversation_resolution": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "name": { - "type": "string", - "examples": [ - "\"branch/with/protection\"" - ] - }, - "protection_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" - ] - }, - "required_signatures": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" - ] - }, - "enabled": { - "type": "boolean", - "examples": [ - true - ] - } }, + "additionalProperties": false, "required": [ - "url", "enabled" ] } - } - } - } - } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ], - "previews": [ - "

The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.luke-cage-preview+json
" - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "title": "Update branch protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "object or null", - "name": "required_status_checks", - "in": "body", - "description": "

Require status checks to pass before merging. Set to null to disable.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "strict", - "description": "

Require branches to be up to date before merging.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "contexts", - "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "checks", - "description": "

The list of status checks to require in order to merge into this branch.

", - "childParamsGroups": [ - { - "type": "string", - "name": "context", - "description": "

The name of the required check

", - "isRequired": true - }, - { - "type": "integer", - "name": "app_id", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" - } - ] - } - ] - }, - { - "type": "boolean or null", - "name": "enforce_admins", - "in": "body", - "description": "

Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "required_pull_request_reviews", - "in": "body", - "description": "

Require at least one approving review on a pull request, before merging. Set to null to disable.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "dismissal_restrictions", - "description": "

Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "users", - "description": "

The list of user logins with dismissal access

" - }, - { - "type": "array of strings", - "name": "teams", - "description": "

The list of team slugs with dismissal access

" - }, - { - "type": "array of strings", - "name": "apps", - "description": "

The list of app slugs with dismissal access

" - } - ] - }, - { - "type": "boolean", - "name": "dismiss_stale_reviews", - "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

" - }, - { - "type": "boolean", - "name": "require_code_owner_reviews", - "description": "

Blocks merging pull requests until code owners review them.

" - }, - { - "type": "integer", - "name": "required_approving_review_count", - "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.

" - } - ] - }, - { - "type": "object or null", - "name": "restrictions", - "in": "body", - "description": "

Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of strings", - "name": "users", - "description": "

The list of user logins with push access

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "teams", - "description": "

The list of team slugs with push access

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "apps", - "description": "

The list of app slugs with push access

" - } - ] - }, - { - "type": "boolean", - "name": "required_linear_history", - "in": "body", - "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

" - }, - { - "type": "boolean or null", - "name": "allow_force_pushes", - "in": "body", - "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

" - }, - { - "type": "boolean", - "name": "allow_deletions", - "in": "body", - "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

" - }, - { - "type": "boolean", - "name": "block_creations", - "in": "body", - "description": "

If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

" - }, - { - "type": "boolean", - "name": "required_conversation_resolution", - "in": "body", - "description": "

Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

" - }, - { - "type": "array of strings", - "name": "contexts", - "in": "body", - "description": "

The list of status checks to require in order to merge into this branch.

" - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "required_status_checks": { - "strict": true, - "contexts": [ - "continuous-integration/travis-ci" - ] - }, - "enforce_admins": true, - "required_pull_request_reviews": { - "dismissal_restrictions": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ] - }, - "dismiss_stale_reviews": true, - "require_code_owner_reviews": true, - "required_approving_review_count": 2, - "bypass_pull_request_allowances": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ] - } }, - "restrictions": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ], - "apps": [ - "super-ci" - ] - }, - "required_linear_history": true, - "allow_force_pushes": true, - "allow_deletions": true, - "block_creations": true, - "required_conversation_resolution": true - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" + "required": [ + "url" + ] } - }, - "response": { - "statusCode": "200", - "description": "

Response

" } } ], @@ -124727,17 +128064,303 @@ } ], "bodyParameters": [ - { - "type": "boolean", - "name": "strict", - "in": "body", - "description": "

Require branches to be up to date before merging.

" - }, + { + "type": "boolean", + "name": "strict", + "in": "body", + "description": "

Require branches to be up to date before merging.

" + }, + { + "type": "array of strings", + "name": "contexts", + "in": "body", + "description": "

The list of status checks to require in order to merge into this branch

" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ] + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + }, + "schema": { + "title": "Status Check Policy", + "description": "Status Check Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" + ] + }, + "strict": { + "type": "boolean", + "examples": [ + true + ] + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "continuous-integration/travis-ci" + ] + }, + "contexts_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + ] + } + }, + "required": [ + "url", + "contexts_url", + "strict", + "contexts" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + "title": "Remove status check protection", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "title": "Get all status check contexts", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + "continuous-integration/travis-ci" + ], + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "title": "Add status check contexts", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [ { "type": "array of strings", "name": "contexts", "in": "body", - "description": "

The list of status checks to require in order to merge into this branch

" + "description": "

The name of the status checks

", + "isRequired": true } ], "enabledForGitHubApps": true, @@ -124746,12 +128369,12 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding status checks to a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "strict": true, "contexts": [ - "continuous-integration/travis-ci" + "continuous-integration/travis-ci", + "continuous-integration/jenkins" ] }, "parameters": { @@ -124760,286 +128383,6 @@ "branch": "BRANCH" } }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", - "strict": true, - "contexts": [ - "continuous-integration/travis-ci" - ], - "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" - }, - "schema": { - "title": "Status Check Policy", - "description": "Status Check Policy", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" - ] - }, - "strict": { - "type": "boolean", - "examples": [ - true - ] - }, - "contexts": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "continuous-integration/travis-ci" - ] - }, - "contexts_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" - ] - } - }, - "required": [ - "url", - "contexts_url", - "strict", - "contexts" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "title": "Remove status check protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "title": "Get all status check contexts", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - "continuous-integration/travis-ci" - ], - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "title": "Add status check contexts", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "contexts", - "in": "body", - "description": "

contexts parameter

", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, "response": { "statusCode": "200", "contentType": "application/json", @@ -125120,7 +128463,7 @@ "type": "array of strings", "name": "contexts", "in": "body", - "description": "

contexts parameter

", + "description": "

The name of the status checks

", "isRequired": true } ], @@ -125130,8 +128473,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example updating status checks for a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -125213,7 +128561,7 @@ "type": "array of strings", "name": "contexts", "in": "body", - "description": "

contexts parameter

", + "description": "

The name of the status checks

", "isRequired": true } ], @@ -125223,8 +128571,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing status checks from a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -127918,7 +131271,7 @@ "type": "array of strings", "name": "teams", "in": "body", - "description": "

teams parameter

", + "description": "

The slug values for teams

", "isRequired": true } ], @@ -127928,8 +131281,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -128217,7 +131575,7 @@ "type": "array of strings", "name": "teams", "in": "body", - "description": "

teams parameter

", + "description": "

The slug values for teams

", "isRequired": true } ], @@ -128227,8 +131585,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -128516,7 +131879,7 @@ "type": "array of strings", "name": "teams", "in": "body", - "description": "

teams parameter

", + "description": "

The slug values for teams

", "isRequired": true } ], @@ -128526,8 +131889,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -129072,7 +132440,7 @@ "type": "array of strings", "name": "users", "in": "body", - "description": "

users parameter

", + "description": "

The username for users

", "isRequired": true } ], @@ -129082,8 +132450,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -129338,7 +132711,7 @@ "type": "array of strings", "name": "users", "in": "body", - "description": "

users parameter

", + "description": "

The username for users

", "isRequired": true } ], @@ -129348,8 +132721,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -129604,7 +132982,7 @@ "type": "array of strings", "name": "users", "in": "body", - "description": "

users parameter

", + "description": "

The username for users

", "isRequired": true } ], @@ -129614,8 +132992,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -140647,6 +144030,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -143702,6 +147089,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -146275,6 +149666,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -149267,6 +152662,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -152366,6 +155765,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -153450,7 +156853,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -153777,6 +157181,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -154054,7 +157465,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -154381,6 +157793,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -158378,6 +161797,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -161448,6 +164871,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -162139,8 +165566,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example request body", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permissions": "write" + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -164150,6 +167580,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -166890,6 +170324,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -171974,6 +175412,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -173526,6 +176968,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -175041,6 +178487,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ] }, @@ -177622,6 +181072,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ] } @@ -181947,6 +185401,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -199790,14 +203248,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -201028,14 +204478,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -201831,14 +205273,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -219458,6 +222892,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -222869,6 +226307,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -223708,7 +227150,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ], "schema": { @@ -226197,6 +229640,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -226976,7 +230423,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -229462,6 +232910,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -230205,7 +233657,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -232691,6 +236144,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -233288,6 +236745,12 @@ "closed" ] }, + { + "type": "string or null", + "name": "state_reason", + "in": "body", + "description": "

The reason for the current state

" + }, { "type": "null or string or integer or string or integer", "name": "milestone", @@ -233492,7 +236955,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -235978,6 +239442,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -239556,6 +243024,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -240641,7 +244113,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -243127,6 +246600,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -243864,7 +247341,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -246350,6 +249828,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -250988,7 +254470,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ], @@ -253706,6 +257189,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -255842,7 +259329,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } }, "schema": { @@ -258557,6 +262045,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -286039,6 +289531,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -292855,14 +296351,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -293739,14 +297227,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -294638,14 +298118,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -295449,14 +298921,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -296352,14 +299816,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -297164,14 +300620,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -298005,14 +301453,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -298888,14 +302328,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -301134,14 +304566,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -302275,10 +305699,6 @@ "httpStatusCode": "200", "description": "

OK

" }, - { - "httpStatusCode": "302", - "description": "

Response if requester is not an organization member

" - }, { "httpStatusCode": "422", "description": "

Validation failed

" @@ -319123,6 +322543,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -320675,6 +324099,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -328992,6 +332420,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ], "subcategory": "pulls" @@ -333897,6 +337329,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ], "subcategory": "pulls" @@ -342055,6 +345491,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -343607,6 +347047,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -347549,6 +350993,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -349101,6 +352549,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -370551,6 +374003,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -372410,6 +375866,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -374990,6 +378450,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -376633,6 +380097,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -377996,6 +381464,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -380713,6 +384185,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -382356,6 +385832,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -383719,6 +387199,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -386703,6 +390187,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -388346,6 +391834,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -389709,6 +393201,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -393234,6 +396730,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -394961,6 +398461,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -395042,7 +398546,7 @@ } } ], - "descriptionHTML": "

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

\n

OAuth scope requirements

\n

When using OAuth, authorizations must include:

\n
    \n
  • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
  • \n
  • repo scope to create a private repository
  • \n
", + "descriptionHTML": "

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

\n

OAuth scope requirements

\n

When using OAuth, authorizations must include:

\n
    \n
  • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
  • \n
  • repo scope to create a private repository
  • \n
", "statusCodes": [ { "httpStatusCode": "201", @@ -397043,6 +400547,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -398837,6 +402345,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -400524,6 +404036,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -402711,6 +406227,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -408366,6 +411886,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -411103,6 +414627,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -412746,6 +416274,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -414109,6 +417641,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -416468,6 +420004,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -419256,6 +422796,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -419751,7 +423295,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] }, @@ -422096,6 +425641,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -431120,6 +434669,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -433703,6 +437256,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -439488,6 +443045,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -442065,6 +445626,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json index 578de7a1092f..96b80f244dc1 100644 --- a/lib/rest/static/decorated/ghes-3.3.json +++ b/lib/rest/static/decorated/ghes-3.3.json @@ -3147,6 +3147,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -6453,6 +6457,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -12146,6 +12154,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -14713,6 +14725,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -16193,6 +16209,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -18223,6 +18243,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -19703,6 +19727,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -21763,6 +21791,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -23253,6 +23285,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -27128,6 +27164,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -29239,6 +29279,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -31975,6 +32019,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -34086,6 +34134,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -39001,6 +39053,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -41112,6 +41168,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -44744,6 +44804,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -48697,6 +48761,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -52644,6 +52712,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -56585,6 +56657,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -60516,6 +60592,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -64468,6 +64548,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -68399,6 +68483,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -72341,6 +72429,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -76283,6 +76375,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -79837,6 +79933,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -82241,6 +82341,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -85007,6 +85111,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -87736,6 +87844,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -89262,6 +89374,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -91098,6 +91214,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -92481,6 +92601,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -95175,6 +95299,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -97471,6 +97599,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -99038,14 +99170,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -99975,14 +100099,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -100605,15 +100721,6 @@ "write" ] }, - { - "type": "string", - "name": "organization_custom_roles", - "description": "

The level of permission to grant the access token for custom roles management.

", - "enum": [ - "read", - "write" - ] - }, { "type": "string", "name": "deployments", @@ -101065,14 +101172,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -102602,6 +102701,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -103702,14 +103805,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -104643,14 +104738,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -105582,14 +105669,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -107550,6 +107629,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -108358,14 +108441,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -110363,6 +110438,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -111131,14 +111210,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -112010,14 +112081,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -112657,15 +112720,6 @@ "write" ] }, - { - "type": "string", - "name": "organization_custom_roles", - "description": "

The level of permission to grant the access token for custom roles management.

", - "enum": [ - "read", - "write" - ] - }, { "type": "string", "name": "deployments", @@ -113306,14 +113360,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -114196,14 +114242,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -115071,14 +115109,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -117735,131 +117765,48 @@ }, "response": { "statusCode": "200", - "description": "

Response

" - } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "301", - "description": "

Moved permanently

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/rename", - "title": "Rename a branch", - "category": "branches", - "subcategory": "branches", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "new_name", - "in": "body", - "description": "

The new name of the branch.

", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "new_name": "my_renamed_branch" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "201", "contentType": "application/json", "description": "

Response

", "example": { - "name": "master", + "name": "main", "commit": { "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", - "node_id": "MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", "commit": { "author": { "name": "The Octocat", - "date": "2012-03-06T15:06:50-08:00", - "email": "octocat@nowhere.com" + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" }, - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", "tree": { "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" }, - "committer": { - "name": "The Octocat", - "date": "2012-03-06T15:06:50-08:00", - "email": "octocat@nowhere.com" - }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null - }, - "comment_count": 0 + } }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", "gravatar_id": "", - "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", "url": "https://api.github.com/users/octocat", - "id": 583231, - "login": "octocat", - "node_id": "MDQ6VXNlcjE=", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", @@ -117871,26 +117818,15 @@ "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", - "site_admin": true + "site_admin": false }, - "parents": [ - { - "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" - }, - { - "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303" - } - ], - "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", "gravatar_id": "", - "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", "url": "https://api.github.com/users/octocat", - "id": 583231, - "login": "octocat", - "node_id": "MDQ6VXNlcjE=", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", @@ -117902,26 +117838,35 @@ "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", - "site_admin": true + "site_admin": false }, - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] }, "_links": { - "html": "https://github.com/octocat/Hello-World/tree/master", - "self": "https://api.github.com/repos/octocat/Hello-World/branches/master" + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" }, - "protected": true, + "protected": false, "protection": { + "enabled": false, "required_status_checks": { - "enforcement_level": "non_admins", - "contexts": [ - "ci-test", - "linter" - ] + "enforcement_level": "off", + "contexts": [], + "checks": [] } }, - "protection_url": "https://api.github.com/repos/octocat/hello-world/branches/master/protection" + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" }, "schema": { "title": "Branch With Protection", @@ -119866,32 +119811,28 @@ } } ], + "descriptionHTML": "", "previews": [], - "descriptionHTML": "

Renames a branch in a repository.

\n

Note: Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".

\n

The permissions required to use this endpoint depends on whether you are renaming the default branch.

\n

To rename a non-default branch:

\n
    \n
  • Users must have push access.
  • \n
  • GitHub Apps must have the contents:write repository permission.
  • \n
\n

To rename the default branch:

\n
    \n
  • Users must have admin or owner permissions.
  • \n
  • GitHub Apps must have the administration:write repository permission.
  • \n
", "statusCodes": [ { - "httpStatusCode": "201", - "description": "

Created

" + "httpStatusCode": "200", + "description": "

OK

" }, { - "httpStatusCode": "403", - "description": "

Forbidden

" + "httpStatusCode": "301", + "description": "

Moved permanently

" }, { "httpStatusCode": "404", "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/merge-upstream", - "title": "Sync a fork branch with the upstream repository", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/rename", + "title": "Rename a branch", "category": "branches", "subcategory": "branches", "parameters": [ @@ -119912,130 +119853,25 @@ "schema": { "type": "string" } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "branch", - "in": "body", - "description": "

The name of the branch which should be updated to match upstream.

", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "branch": "main" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

The branch has been successfully synced with the upstream repository

", - "example": { - "message": "Successfully fetched and fast-forwarded from upstream defunkt:main", - "merge_type": "fast-forward", - "base_branch": "defunkt:main" - }, - "schema": { - "title": "Merged upstream", - "description": "Results of a successful merge upstream request", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "merge_type": { - "type": "string", - "enum": [ - "merge", - "fast-forward", - "none" - ] - }, - "base_branch": { - "type": "string" - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Sync a branch of a forked repository to keep it up-to-date with the upstream repository.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

The branch has been successfully synced with the upstream repository

" - }, - { - "httpStatusCode": "409", - "description": "

The branch could not be synced because of a merge conflict

" - }, - { - "httpStatusCode": "422", - "description": "

The branch could not be synced for some other reason

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/merges", - "title": "Merge a branch", - "category": "branches", - "subcategory": "branches", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", + "name": "branch", + "description": "

The name of the branch.

", "in": "path", "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true } ], "bodyParameters": [ { "type": "string", - "name": "base", - "in": "body", - "description": "

The name of the base branch that the head will be merged into.

", - "isRequired": true - }, - { - "type": "string", - "name": "head", + "name": "new_name", "in": "body", - "description": "

The head to merge. This can be a branch name or a commit SHA1.

", + "description": "

The new name of the branch.

", "isRequired": true - }, - { - "type": "string", - "name": "commit_message", - "in": "body", - "description": "

Commit message to use for the merge commit. If omitted, a default message will be used.

" } ], "enabledForGitHubApps": true, @@ -120047,153 +119883,129 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "base": "master", - "head": "cool_feature", - "commit_message": "Shipped cool_feature!" + "new_name": "my_renamed_branch" }, "parameters": { "owner": "OWNER", - "repo": "REPO" + "repo": "REPO", + "branch": "BRANCH" } }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "

Successful Response (The resulting merge commit)

", + "description": "

Response

", "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", + "name": "master", "commit": { - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==", + "commit": { + "author": { + "name": "The Octocat", + "date": "2012-03-06T15:06:50-08:00", + "email": "octocat@nowhere.com" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "committer": { + "name": "The Octocat", + "date": "2012-03-06T15:06:50-08:00", + "email": "octocat@nowhere.com" + }, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + }, + "comment_count": 0 + }, "author": { - "name": "Monalisa Octocat", - "email": "mona@github.com", - "date": "2011-04-14T16:00:49Z" + "gravatar_id": "", + "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", + "url": "https://api.github.com/users/octocat", + "id": 583231, + "login": "octocat", + "node_id": "MDQ6VXNlcjE=", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ], + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "committer": { - "name": "Monalisa Octocat", - "email": "mona@github.com", - "date": "2011-04-14T16:00:49Z" - }, - "message": "Fix all the bugs", - "tree": { - "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + "gravatar_id": "", + "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", + "url": "https://api.github.com/users/octocat", + "id": 583231, + "login": "octocat", + "node_id": "MDQ6VXNlcjE=", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true }, - "comment_count": 0, - "verification": { - "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null - } - }, - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" }, - "committer": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "_links": { + "html": "https://github.com/octocat/Hello-World/tree/master", + "self": "https://api.github.com/repos/octocat/Hello-World/branches/master" }, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + "protected": true, + "protection": { + "required_status_checks": { + "enforcement_level": "non_admins", + "contexts": [ + "ci-test", + "linter" + ] } - ], - "stats": { - "additions": 104, - "deletions": 4, - "total": 108 }, - "files": [ - { - "filename": "file1.txt", - "additions": 10, - "deletions": 2, - "changes": 12, - "status": "modified", - "raw_url": "https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", - "blob_url": "https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", - "patch": "@@ -29,7 +29,7 @@\n....." - } - ] + "protection_url": "https://api.github.com/repos/octocat/hello-world/branches/master/protection" }, "schema": { - "title": "Commit", - "description": "Commit", + "title": "Branch With Protection", + "description": "Branch With Protection", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "sha": { - "type": "string", - "examples": [ - "6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" - ] + "name": { + "type": "string" }, "commit": { + "title": "Commit", + "description": "Commit", "type": "object", "properties": { "url": { @@ -120203,35 +120015,345 @@ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, + "sha": { + "type": "string", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + ] + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { + "type": "string", + "examples": [ + "Fix all the bugs" + ] + }, + "comment_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" + ] + } + }, + "required": [ + "sha", + "url" + ] + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "payload": { + "type": [ + "string", + "null" + ] + }, + "signature": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature" + ] + } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, "author": { "anyOf": [ { "type": "null" }, { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", "examples": [ - "\"Chris Wanstrath\"" + "octocat" ] }, - "email": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", "examples": [ - "\"chris@ozmm.org\"" + "MDQ6VXNlcjE=" ] }, - "date": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "\"2007-10-29T02:42:39.000-07:00\"" + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } ] }, @@ -120241,317 +120363,2099 @@ "type": "null" }, { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", "examples": [ - "\"Chris Wanstrath\"" + "octocat" ] }, - "email": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", "examples": [ - "\"chris@ozmm.org\"" + "MDQ6VXNlcjE=" ] }, - "date": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "\"2007-10-29T02:42:39.000-07:00\"" + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } ] }, - "message": { - "type": "string", - "examples": [ - "Fix all the bugs" - ] - }, - "comment_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "tree": { - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "827efc6d56897b048c772eb4087f854f46256132" - ] + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + } }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" - ] - } - }, - "required": [ - "sha", - "url" - ] + "required": [ + "sha", + "url" + ] + } }, - "verification": { - "title": "Verification", + "stats": { "type": "object", "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" + "additions": { + "type": "integer" }, - "payload": { - "type": [ - "string", - "null" - ] + "deletions": { + "type": "integer" }, - "signature": { - "type": [ - "string", - "null" - ] + "total": { + "type": "integer" } - }, - "required": [ - "verified", - "reason", - "payload", - "signature" - ] - } - }, - "required": [ - "author", - "committer", - "comment_count", - "message", - "tree", - "url" - ] - }, - "author": { - "anyOf": [ - { - "type": "null" + } }, - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "files": { + "type": "array", + "items": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" + ] + }, + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "examples": [ + "added" + ] + }, + "additions": { + "type": "integer", + "examples": [ + 103 + ] + }, + "deletions": { + "type": "integer", + "examples": [ + 21 + ] + }, + "changes": { + "type": "integer", + "examples": [ + 124 + ] + }, + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" + ] + } }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + } + } + }, + "required": [ + "url", + "sha", + "node_id", + "html_url", + "comments_url", + "commit", + "author", + "committer", + "parents" + ] + }, + "_links": { + "type": "object", + "properties": { + "html": { + "type": "string" + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "html", + "self" + ] + }, + "protected": { + "type": "boolean" + }, + "protection": { + "title": "Branch Protection", + "description": "Branch Protection", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", + "type": "object", + "properties": { + "url": { + "type": "string" }, - "subscriptions_url": { + "enforcement_level": { + "type": "string" + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + } + }, + "contexts_url": { + "type": "string" + }, + "strict": { + "type": "boolean" + } + }, + "required": [ + "contexts" + ] + }, + "enforce_admins": { + "title": "Protected Branch Admin Enforced", + "description": "Protected Branch Admin Enforced", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/subscriptions" + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" ] }, - "organizations_url": { - "type": "string", - "format": "uri", + "enabled": { + "type": "boolean", "examples": [ - "https://api.github.com/users/octocat/orgs" + true ] - }, - "repos_url": { + } + }, + "required": [ + "url", + "enabled" + ] + }, + "required_pull_request_reviews": { + "title": "Protected Branch Pull Request Review", + "description": "Protected Branch Pull Request Review", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" ] }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] + "dismissal_restrictions": { + "type": "object", + "properties": { + "users": { + "description": "The list of users with review dismissal access.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams with review dismissal access.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps with review dismissal access.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" + ] + }, + "users_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" + ] + }, + "teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" + ] + } + } }, - "received_events_url": { - "type": "string", - "format": "uri", + "dismiss_stale_reviews": { + "type": "boolean", "examples": [ - "https://api.github.com/users/octocat/received_events" + true ] }, - "type": { - "type": "string", + "require_code_owner_reviews": { + "type": "boolean", "examples": [ - "User" + true ] }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", + "required_approving_review_count": { + "type": "integer", + "minimum": 1, + "maximum": 6, "examples": [ - "\"2020-07-09T00:17:55Z\"" + 2 ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "dismiss_stale_reviews", + "require_code_owner_reviews" ] - } - ] - }, - "committer": { - "anyOf": [ - { - "type": "null" }, - { - "title": "Simple User", - "description": "Simple User", + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { + "url": { "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] + "format": "uri" }, - "node_id": { + "users_url": { "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] + "format": "uri" }, - "avatar_url": { + "teams_url": { "type": "string", - "format": "uri", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "name": { + "type": "string", + "examples": [ + "\"branch/with/protection\"" + ] + }, + "protection_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + } + } + }, + "protection_url": { + "type": "string", + "format": "uri" + }, + "pattern": { + "type": "string", + "examples": [ + "\"mas*\"" + ] + }, + "required_approving_review_count": { + "type": "integer", + "examples": [ + 1 + ] + } + }, + "required": [ + "name", + "commit", + "_links", + "protection", + "protected", + "protection_url" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Renames a branch in a repository.

\n

Note: Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".

\n

The permissions required to use this endpoint depends on whether you are renaming the default branch.

\n

To rename a non-default branch:

\n
    \n
  • Users must have push access.
  • \n
  • GitHub Apps must have the contents:write repository permission.
  • \n
\n

To rename the default branch:

\n
    \n
  • Users must have admin or owner permissions.
  • \n
  • GitHub Apps must have the administration:write repository permission.
  • \n
", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/merge-upstream", + "title": "Sync a fork branch with the upstream repository", + "category": "branches", + "subcategory": "branches", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "branch", + "in": "body", + "description": "

The name of the branch which should be updated to match upstream.

", + "isRequired": true + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "branch": "main" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

The branch has been successfully synced with the upstream repository

", + "example": { + "message": "Successfully fetched and fast-forwarded from upstream defunkt:main", + "merge_type": "fast-forward", + "base_branch": "defunkt:main" + }, + "schema": { + "title": "Merged upstream", + "description": "Results of a successful merge upstream request", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "merge_type": { + "type": "string", + "enum": [ + "merge", + "fast-forward", + "none" + ] + }, + "base_branch": { + "type": "string" + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Sync a branch of a forked repository to keep it up-to-date with the upstream repository.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

The branch has been successfully synced with the upstream repository

" + }, + { + "httpStatusCode": "409", + "description": "

The branch could not be synced because of a merge conflict

" + }, + { + "httpStatusCode": "422", + "description": "

The branch could not be synced for some other reason

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/merges", + "title": "Merge a branch", + "category": "branches", + "subcategory": "branches", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "base", + "in": "body", + "description": "

The name of the base branch that the head will be merged into.

", + "isRequired": true + }, + { + "type": "string", + "name": "head", + "in": "body", + "description": "

The head to merge. This can be a branch name or a commit SHA1.

", + "isRequired": true + }, + { + "type": "string", + "name": "commit_message", + "in": "body", + "description": "

Commit message to use for the merge commit. If omitted, a default message will be used.

" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "base": "master", + "head": "cool_feature", + "commit_message": "Shipped cool_feature!" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Successful Response (The resulting merge commit)

", + "example": { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", + "commit": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "author": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "committer": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "message": "Fix all the bugs", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "comment_count": 0, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + ], + "stats": { + "additions": 104, + "deletions": 4, + "total": 108 + }, + "files": [ + { + "filename": "file1.txt", + "additions": 10, + "deletions": 2, + "changes": 12, + "status": "modified", + "raw_url": "https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", + "blob_url": "https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", + "patch": "@@ -29,7 +29,7 @@\n....." + } + ] + }, + "schema": { + "title": "Commit", + "description": "Commit", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "sha": { + "type": "string", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + ] + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { + "type": "string", + "examples": [ + "Fix all the bugs" + ] + }, + "comment_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" + ] + } + }, + "required": [ + "sha", + "url" + ] + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "payload": { + "type": [ + "string", + "null" + ] + }, + "signature": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature" + ] + } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] @@ -120677,203 +122581,1843 @@ } ] }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" - ] + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + } + }, + "required": [ + "sha", + "url" + ] + } + }, + "stats": { + "type": "object", + "properties": { + "additions": { + "type": "integer" + }, + "deletions": { + "type": "integer" + }, + "total": { + "type": "integer" + } + } + }, + "files": { + "type": "array", + "items": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" + ] + }, + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "examples": [ + "added" + ] + }, + "additions": { + "type": "integer", + "examples": [ + 103 + ] + }, + "deletions": { + "type": "integer", + "examples": [ + 21 + ] + }, + "changes": { + "type": "integer", + "examples": [ + 124 + ] + }, + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" + ] + } + }, + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + } + } + }, + "required": [ + "url", + "sha", + "node_id", + "html_url", + "comments_url", + "commit", + "author", + "committer", + "parents" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Successful Response (The resulting merge commit)

" + }, + { + "httpStatusCode": "204", + "description": "

Response when already merged

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Not Found when the base or head does not exist

" + }, + { + "httpStatusCode": "409", + "description": "

Conflict when there is a merge conflict

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed

" + } + ] + } + ], + "branch-protection": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", + "title": "Get branch protection", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts", + "enforcement_level": "non_admins" + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", + "enabled": true + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", + "users": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "apps": [ + { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + } + ] + }, + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2 + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps", + "users": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "apps": [ + { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + } + ] + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + }, + "schema": { + "title": "Branch Protection", + "description": "Branch Protection", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enforcement_level": { + "type": "string" + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + } + }, + "contexts_url": { + "type": "string" + }, + "strict": { + "type": "boolean" + } + }, + "required": [ + "contexts" + ] + }, + "enforce_admins": { + "title": "Protected Branch Admin Enforced", + "description": "Protected Branch Admin Enforced", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "required_pull_request_reviews": { + "title": "Protected Branch Pull Request Review", + "description": "Protected Branch Pull Request Review", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" + ] + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "users": { + "description": "The list of users with review dismissal access.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams with review dismissal access.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps with review dismissal access.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" + ] + }, + "users_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" + ] + }, + "teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" + ] + } + } + }, + "dismiss_stale_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "require_code_owner_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "required_approving_review_count": { + "type": "integer", + "minimum": 1, + "maximum": 6, + "examples": [ + 2 + ] + } + }, + "required": [ + "dismiss_stale_reviews", + "require_code_owner_reviews" + ] + }, + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } } }, - "required": [ - "sha", - "url" - ] + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } } }, - "stats": { + "allow_force_pushes": { "type": "object", "properties": { - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "total": { - "type": "integer" + "enabled": { + "type": "boolean" } } }, - "files": { - "type": "array", - "items": { - "title": "Diff Entry", - "description": "Diff Entry", - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "bbcd538c8e72b8c175046e27cc8f907076331401" - ] - }, - "filename": { - "type": "string", - "examples": [ - "file1.txt" - ] - }, - "status": { - "type": "string", - "enum": [ - "added", - "removed", - "modified", - "renamed", - "copied", - "changed", - "unchanged" - ], - "examples": [ - "added" - ] - }, - "additions": { - "type": "integer", - "examples": [ - 103 - ] - }, - "deletions": { - "type": "integer", - "examples": [ - 21 - ] - }, - "changes": { - "type": "integer", - "examples": [ - 124 - ] - }, - "blob_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "raw_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "contents_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "patch": { - "type": "string", - "examples": [ - "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" - ] - }, - "previous_filename": { - "type": "string", - "examples": [ - "file.txt" - ] - } - }, - "required": [ - "additions", - "blob_url", - "changes", - "contents_url", - "deletions", - "filename", - "raw_url", - "sha", - "status" - ] + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } } + }, + "name": { + "type": "string", + "examples": [ + "\"branch/with/protection\"" + ] + }, + "protection_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] } - }, - "required": [ - "url", - "sha", - "node_id", - "html_url", - "comments_url", - "commit", - "author", - "committer", - "parents" - ] + } } } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", "statusCodes": [ { - "httpStatusCode": "201", - "description": "

Successful Response (The resulting merge commit)

" - }, - { - "httpStatusCode": "204", - "description": "

Response when already merged

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" + "httpStatusCode": "200", + "description": "

OK

" }, { "httpStatusCode": "404", - "description": "

Not Found when the base or head does not exist

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict when there is a merge conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed

" + "description": "

Resource not found

" } ] - } - ], - "branch-protection": [ + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", + "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "title": "Get branch protection", + "title": "Update branch protection", "category": "branches", "subcategory": "branch-protection", "parameters": [ @@ -120906,205 +124450,273 @@ "x-multi-segment": true } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "object or null", + "name": "required_status_checks", + "in": "body", + "description": "

Require status checks to pass before merging. Set to null to disable.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "strict", + "description": "

Require branches to be up to date before merging.

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "contexts", + "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "isRequired": true + }, + { + "type": "array of objects", + "name": "checks", + "description": "

The list of status checks to require in order to merge into this branch.

", + "childParamsGroups": [ + { + "type": "string", + "name": "context", + "description": "

The name of the required check

", + "isRequired": true + }, + { + "type": "integer", + "name": "app_id", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" + } + ] + } + ] + }, + { + "type": "boolean or null", + "name": "enforce_admins", + "in": "body", + "description": "

Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "required_pull_request_reviews", + "in": "body", + "description": "

Require at least one approving review on a pull request, before merging. Set to null to disable.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "dismissal_restrictions", + "description": "

Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "users", + "description": "

The list of user logins with dismissal access

" + }, + { + "type": "array of strings", + "name": "teams", + "description": "

The list of team slugs with dismissal access

" + }, + { + "type": "array of strings", + "name": "apps", + "description": "

The list of app slugs with dismissal access

" + } + ] + }, + { + "type": "boolean", + "name": "dismiss_stale_reviews", + "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

" + }, + { + "type": "boolean", + "name": "require_code_owner_reviews", + "description": "

Blocks merging pull requests until code owners review them.

" + }, + { + "type": "integer", + "name": "required_approving_review_count", + "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.

" + } + ] + }, + { + "type": "object or null", + "name": "restrictions", + "in": "body", + "description": "

Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of strings", + "name": "users", + "description": "

The list of user logins with push access

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "teams", + "description": "

The list of team slugs with push access

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "apps", + "description": "

The list of app slugs with push access

" + } + ] + }, + { + "type": "boolean", + "name": "required_linear_history", + "in": "body", + "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

" + }, + { + "type": "boolean or null", + "name": "allow_force_pushes", + "in": "body", + "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

" + }, + { + "type": "boolean", + "name": "allow_deletions", + "in": "body", + "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

" + }, + { + "type": "boolean", + "name": "block_creations", + "in": "body", + "description": "

If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

" + }, + { + "type": "boolean", + "name": "required_conversation_resolution", + "in": "body", + "description": "

Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

" + }, + { + "type": "array of strings", + "name": "contexts", + "in": "body", + "description": "

The list of status checks to require in order to merge into this branch.

" + } + ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { + "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection", + "bodyParameters": { "required_status_checks": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", + "strict": true, "contexts": [ "continuous-integration/travis-ci" - ], - "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts", - "enforcement_level": "non_admins" - }, - "enforce_admins": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", - "enabled": true + ] }, + "enforce_admins": true, "required_pull_request_reviews": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", "dismissal_restrictions": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", - "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", "users": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } + "octocat" ], "teams": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "apps": [ - { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] - } + "justice-league" ] }, "dismiss_stale_reviews": true, "require_code_owner_reviews": true, - "required_approving_review_count": 2 + "required_approving_review_count": 2, + "bypass_pull_request_allowances": { + "users": [ + "octocat" + ], + "teams": [ + "justice-league" + ] + } }, "restrictions": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", - "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams", - "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps", "users": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } + "octocat" ], "teams": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } + "justice-league" ], "apps": [ + "super-ci" + ] + }, + "required_linear_history": true, + "allow_force_pushes": true, + "allow_deletions": true, + "block_creations": true, + "required_conversation_resolution": true + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] + "context": "continuous-integration/travis-ci", + "app_id": null } ] }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [], + "teams": [], + "apps": [] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [], + "teams": [], + "apps": [] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, "required_linear_history": { "enabled": true }, @@ -121114,90 +124726,96 @@ "allow_deletions": { "enabled": true }, + "block_creations": { + "enabled": true + }, "required_conversation_resolution": { "enabled": true } }, "schema": { - "title": "Branch Protection", - "description": "Branch Protection", + "title": "Protected Branch", + "description": "Branch protections protect branches", "type": "object", "properties": { "url": { - "type": "string" - }, - "enabled": { - "type": "boolean" + "type": "string", + "format": "uri" }, "required_status_checks": { - "title": "Protected Branch Required Status Check", - "description": "Protected Branch Required Status Check", + "title": "Status Check Policy", + "description": "Status Check Policy", "type": "object", "properties": { "url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" + ] }, - "enforcement_level": { - "type": "string" + "strict": { + "type": "boolean", + "examples": [ + true + ] }, "contexts": { "type": "array", "items": { "type": "string" - } + }, + "examples": [ + "continuous-integration/travis-ci" + ] }, "contexts_url": { - "type": "string" - }, - "strict": { - "type": "boolean" - } - }, - "required": [ - "contexts" - ] - }, - "enforce_admins": { - "title": "Protected Branch Admin Enforced", - "description": "Protected Branch Admin Enforced", - "type": "object", - "properties": { - "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" - ] - }, - "enabled": { - "type": "boolean", - "examples": [ - true + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" ] } }, "required": [ "url", - "enabled" + "contexts_url", + "strict", + "contexts" ] }, "required_pull_request_reviews": { - "title": "Protected Branch Pull Request Review", - "description": "Protected Branch Pull Request Review", "type": "object", "properties": { "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" - ] + "format": "uri" + }, + "dismiss_stale_reviews": { + "type": "boolean" + }, + "require_code_owner_reviews": { + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" }, "dismissal_restrictions": { "type": "object", "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, "users": { - "description": "The list of users with review dismissal access.", "type": "array", "items": { "title": "Simple User", @@ -121362,7 +124980,6 @@ } }, "teams": { - "description": "The list of teams with review dismissal access.", "type": "array", "items": { "title": "Team", @@ -121566,7 +125183,6 @@ } }, "apps": { - "description": "The list of apps with review dismissal access.", "type": "array", "items": { "title": "GitHub app", @@ -121893,51 +125509,94 @@ "events" ] } - }, - "url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" - ] - }, - "users_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" - ] - }, - "teams_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" - ] } - } - }, - "dismiss_stale_reviews": { - "type": "boolean", + }, + "required": [ + "url", + "users_url", + "teams_url", + "users", + "teams" + ] + } + }, + "required": [ + "url" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", "examples": [ - true + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" ] }, - "require_code_owner_reviews": { + "enabled": { "type": "boolean", "examples": [ true ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "enforce_admins": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" }, - "required_approving_review_count": { - "type": "integer", - "minimum": 1, - "maximum": 6, - "examples": [ - 2 - ] + "enabled": { + "type": "boolean" } }, + "additionalProperties": false, "required": [ - "dismiss_stale_reviews", - "require_code_owner_reviews" + "url", + "enabled" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" ] }, "restrictions": { @@ -122249,29 +125908,14 @@ "apps" ] }, - "required_linear_history": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "allow_force_pushes": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "allow_deletions": { + "required_conversation_resolution": { "type": "object", "properties": { "enabled": { "type": "boolean" } - } + }, + "additionalProperties": false }, "block_creations": { "type": "object", @@ -122279,324 +125923,17 @@ "enabled": { "type": "boolean" } - } - }, - "required_conversation_resolution": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "name": { - "type": "string", - "examples": [ - "\"branch/with/protection\"" - ] - }, - "protection_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" - ] - }, - "required_signatures": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" - ] - }, - "enabled": { - "type": "boolean", - "examples": [ - true - ] - } }, + "additionalProperties": false, "required": [ - "url", "enabled" ] } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "title": "Update branch protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "object or null", - "name": "required_status_checks", - "in": "body", - "description": "

Require status checks to pass before merging. Set to null to disable.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "strict", - "description": "

Require branches to be up to date before merging.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "contexts", - "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "checks", - "description": "

The list of status checks to require in order to merge into this branch.

", - "childParamsGroups": [ - { - "type": "string", - "name": "context", - "description": "

The name of the required check

", - "isRequired": true - }, - { - "type": "integer", - "name": "app_id", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" - } - ] - } - ] - }, - { - "type": "boolean or null", - "name": "enforce_admins", - "in": "body", - "description": "

Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "required_pull_request_reviews", - "in": "body", - "description": "

Require at least one approving review on a pull request, before merging. Set to null to disable.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "dismissal_restrictions", - "description": "

Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "users", - "description": "

The list of user logins with dismissal access

" - }, - { - "type": "array of strings", - "name": "teams", - "description": "

The list of team slugs with dismissal access

" - }, - { - "type": "array of strings", - "name": "apps", - "description": "

The list of app slugs with dismissal access

" - } - ] - }, - { - "type": "boolean", - "name": "dismiss_stale_reviews", - "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

" - }, - { - "type": "boolean", - "name": "require_code_owner_reviews", - "description": "

Blocks merging pull requests until code owners review them.

" - }, - { - "type": "integer", - "name": "required_approving_review_count", - "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.

" - } - ] - }, - { - "type": "object or null", - "name": "restrictions", - "in": "body", - "description": "

Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of strings", - "name": "users", - "description": "

The list of user logins with push access

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "teams", - "description": "

The list of team slugs with push access

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "apps", - "description": "

The list of app slugs with push access

" - } - ] - }, - { - "type": "boolean", - "name": "required_linear_history", - "in": "body", - "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

" - }, - { - "type": "boolean or null", - "name": "allow_force_pushes", - "in": "body", - "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

" - }, - { - "type": "boolean", - "name": "allow_deletions", - "in": "body", - "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

" - }, - { - "type": "boolean", - "name": "block_creations", - "in": "body", - "description": "

If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

" - }, - { - "type": "boolean", - "name": "required_conversation_resolution", - "in": "body", - "description": "

Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

" - }, - { - "type": "array of strings", - "name": "contexts", - "in": "body", - "description": "

The list of status checks to require in order to merge into this branch.

" - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "required_status_checks": { - "strict": true, - "contexts": [ - "continuous-integration/travis-ci" - ] - }, - "enforce_admins": true, - "required_pull_request_reviews": { - "dismissal_restrictions": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ] - }, - "dismiss_stale_reviews": true, - "require_code_owner_reviews": true, - "required_approving_review_count": 2, - "bypass_pull_request_allowances": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ] - } }, - "restrictions": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ], - "apps": [ - "super-ci" - ] - }, - "required_linear_history": true, - "allow_force_pushes": true, - "allow_deletions": true, - "block_creations": true, - "required_conversation_resolution": true - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" + "required": [ + "url" + ] } - }, - "response": { - "statusCode": "200", - "description": "

Response

" } } ], @@ -125346,17 +128683,303 @@ } ], "bodyParameters": [ - { - "type": "boolean", - "name": "strict", - "in": "body", - "description": "

Require branches to be up to date before merging.

" - }, + { + "type": "boolean", + "name": "strict", + "in": "body", + "description": "

Require branches to be up to date before merging.

" + }, + { + "type": "array of strings", + "name": "contexts", + "in": "body", + "description": "

The list of status checks to require in order to merge into this branch

" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ] + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + }, + "schema": { + "title": "Status Check Policy", + "description": "Status Check Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" + ] + }, + "strict": { + "type": "boolean", + "examples": [ + true + ] + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "continuous-integration/travis-ci" + ] + }, + "contexts_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + ] + } + }, + "required": [ + "url", + "contexts_url", + "strict", + "contexts" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + "title": "Remove status check protection", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "title": "Get all status check contexts", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + "continuous-integration/travis-ci" + ], + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "title": "Add status check contexts", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [ { "type": "array of strings", "name": "contexts", "in": "body", - "description": "

The list of status checks to require in order to merge into this branch

" + "description": "

The name of the status checks

", + "isRequired": true } ], "enabledForGitHubApps": true, @@ -125365,12 +128988,12 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding status checks to a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "strict": true, "contexts": [ - "continuous-integration/travis-ci" + "continuous-integration/travis-ci", + "continuous-integration/jenkins" ] }, "parameters": { @@ -125379,286 +129002,6 @@ "branch": "BRANCH" } }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", - "strict": true, - "contexts": [ - "continuous-integration/travis-ci" - ], - "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" - }, - "schema": { - "title": "Status Check Policy", - "description": "Status Check Policy", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" - ] - }, - "strict": { - "type": "boolean", - "examples": [ - true - ] - }, - "contexts": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "continuous-integration/travis-ci" - ] - }, - "contexts_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" - ] - } - }, - "required": [ - "url", - "contexts_url", - "strict", - "contexts" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "title": "Remove status check protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "title": "Get all status check contexts", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - "continuous-integration/travis-ci" - ], - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "title": "Add status check contexts", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "contexts", - "in": "body", - "description": "

contexts parameter

", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, "response": { "statusCode": "200", "contentType": "application/json", @@ -125739,7 +129082,7 @@ "type": "array of strings", "name": "contexts", "in": "body", - "description": "

contexts parameter

", + "description": "

The name of the status checks

", "isRequired": true } ], @@ -125749,8 +129092,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example updating status checks for a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -125832,7 +129180,7 @@ "type": "array of strings", "name": "contexts", "in": "body", - "description": "

contexts parameter

", + "description": "

The name of the status checks

", "isRequired": true } ], @@ -125842,8 +129190,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing status checks from a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -128537,7 +131890,7 @@ "type": "array of strings", "name": "teams", "in": "body", - "description": "

teams parameter

", + "description": "

The slug values for teams

", "isRequired": true } ], @@ -128547,8 +131900,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -128836,7 +132194,7 @@ "type": "array of strings", "name": "teams", "in": "body", - "description": "

teams parameter

", + "description": "

The slug values for teams

", "isRequired": true } ], @@ -128846,8 +132204,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -129135,7 +132498,7 @@ "type": "array of strings", "name": "teams", "in": "body", - "description": "

teams parameter

", + "description": "

The slug values for teams

", "isRequired": true } ], @@ -129145,8 +132508,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -129691,7 +133059,7 @@ "type": "array of strings", "name": "users", "in": "body", - "description": "

users parameter

", + "description": "

The username for users

", "isRequired": true } ], @@ -129701,8 +133069,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -129957,7 +133330,7 @@ "type": "array of strings", "name": "users", "in": "body", - "description": "

users parameter

", + "description": "

The username for users

", "isRequired": true } ], @@ -129967,8 +133340,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -130223,7 +133601,7 @@ "type": "array of strings", "name": "users", "in": "body", - "description": "

users parameter

", + "description": "

The username for users

", "isRequired": true } ], @@ -130233,8 +133611,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -141356,6 +144739,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -144422,6 +147809,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -147006,6 +150397,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -150009,6 +153404,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -153119,6 +156518,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -154204,7 +157607,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -154531,6 +157935,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -154806,7 +158217,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -155133,6 +158545,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -159132,6 +162551,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -162213,6 +165636,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -162904,8 +166331,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example request body", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permissions": "write" + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -164926,6 +168356,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -167677,6 +171111,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -172770,6 +176208,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -174333,6 +177775,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -175846,6 +179292,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ] }, @@ -178427,6 +181877,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ] } @@ -182757,6 +186211,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -200899,14 +204357,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -202137,14 +205587,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -202940,14 +206382,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -220578,6 +224012,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -223997,6 +227435,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -224833,7 +228275,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ], "schema": { @@ -227333,6 +230776,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -228109,7 +231556,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -230606,6 +234054,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -231349,7 +234801,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -233846,6 +237299,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -234441,6 +237898,12 @@ "closed" ] }, + { + "type": "string or null", + "name": "state_reason", + "in": "body", + "description": "

The reason for the current state

" + }, { "type": "null or string or integer or string or integer", "name": "milestone", @@ -234645,7 +238108,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -237142,6 +240606,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -240731,6 +244199,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -241813,7 +245285,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -244310,6 +247783,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -245047,7 +248524,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -247544,6 +251022,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -252175,7 +255657,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ], @@ -254904,6 +258387,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -257038,7 +260525,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } }, "schema": { @@ -259764,6 +263252,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -287253,6 +290745,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -294066,14 +297562,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -294950,14 +298438,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -295849,14 +299329,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -296660,14 +300132,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -297563,14 +301027,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -298375,14 +301831,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -299216,14 +302664,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -300099,14 +303539,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -302739,14 +306171,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -303880,10 +307304,6 @@ "httpStatusCode": "200", "description": "

OK

" }, - { - "httpStatusCode": "302", - "description": "

Response if requester is not an organization member

" - }, { "httpStatusCode": "422", "description": "

Validation failed

" @@ -320681,6 +324101,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -322244,6 +325668,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -330561,6 +333989,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ], "subcategory": "pulls" @@ -335466,6 +338898,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ], "subcategory": "pulls" @@ -343620,6 +347056,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -345183,6 +348623,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -349136,6 +352580,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -350699,6 +354147,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -372226,6 +375678,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -374103,6 +377559,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -376699,6 +380159,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -378359,6 +381823,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -379733,6 +383201,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -382738,6 +386210,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -384398,6 +387874,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -385772,6 +389252,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -389296,6 +392780,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -391035,6 +394523,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -391116,7 +394608,7 @@ } } ], - "descriptionHTML": "

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

\n

OAuth scope requirements

\n

When using OAuth, authorizations must include:

\n
    \n
  • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
  • \n
  • repo scope to create a private repository
  • \n
", + "descriptionHTML": "

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

\n

OAuth scope requirements

\n

When using OAuth, authorizations must include:

\n
    \n
  • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
  • \n
  • repo scope to create a private repository
  • \n
", "statusCodes": [ { "httpStatusCode": "201", @@ -393128,6 +396620,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -394934,6 +398430,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -396642,6 +400142,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -398840,6 +402344,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -399235,6 +402743,13 @@ "in": "body", "description": "

The URL must contain <num> for the reference number.

", "isRequired": true + }, + { + "type": "boolean", + "name": "is_alphanumeric", + "in": "body", + "description": "

Whether this autolink reference matches alphanumeric characters. If true, the <num> parameter of the url_template matches alphanumeric characters A-Z (case insensitive), 0-9, and -. If false, this autolink reference only matches numeric characters.

", + "default": "true" } ], "enabledForGitHubApps": true, @@ -399247,7 +402762,8 @@ "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=" + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true }, "parameters": { "owner": "OWNER", @@ -404906,6 +408422,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -407661,6 +411181,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -409321,6 +412845,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -410695,6 +414223,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -413181,6 +416713,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -415980,6 +419516,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -416473,7 +420013,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] }, @@ -418829,6 +422370,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -429161,6 +432706,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -431755,6 +435304,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -437545,6 +441098,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -440133,6 +443690,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ diff --git a/lib/rest/static/decorated/ghes-3.4.json b/lib/rest/static/decorated/ghes-3.4.json index 19da14652dfc..c7871c0ace4b 100644 --- a/lib/rest/static/decorated/ghes-3.4.json +++ b/lib/rest/static/decorated/ghes-3.4.json @@ -3147,6 +3147,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -6453,6 +6457,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -12146,6 +12154,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -14713,6 +14725,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -16193,6 +16209,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -18904,6 +18924,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -20384,6 +20408,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -23121,6 +23149,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -24611,6 +24643,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -29213,6 +29249,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -31324,6 +31364,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -34060,6 +34104,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -36171,6 +36219,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -41086,6 +41138,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -43197,6 +43253,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -46829,6 +46889,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -50782,6 +50846,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -54729,6 +54797,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -58670,6 +58742,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -62601,6 +62677,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -66553,6 +66633,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -70484,6 +70568,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -74426,6 +74514,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -78368,6 +78460,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -81922,6 +82018,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -84326,6 +84426,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -87092,6 +87196,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -89821,6 +89929,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -91347,6 +91459,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -93183,6 +93299,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -94566,6 +94686,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -97260,6 +97384,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -99556,6 +99684,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -101123,14 +101255,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -102052,14 +102176,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -102674,15 +102790,6 @@ "write" ] }, - { - "type": "string", - "name": "organization_custom_roles", - "description": "

The level of permission to grant the access token for custom roles management.

", - "enum": [ - "read", - "write" - ] - }, { "type": "string", "name": "deployments", @@ -103125,14 +103232,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -104654,6 +104753,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -105754,14 +105857,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -106687,14 +106782,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -107618,14 +107705,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -109578,6 +109657,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -110231,14 +110314,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -112228,6 +112303,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -112936,14 +113015,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -113807,14 +113878,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -114446,15 +114509,6 @@ "write" ] }, - { - "type": "string", - "name": "organization_custom_roles", - "description": "

The level of permission to grant the access token for custom roles management.

", - "enum": [ - "read", - "write" - ] - }, { "type": "string", "name": "deployments", @@ -115086,14 +115140,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -118592,131 +118638,48 @@ }, "response": { "statusCode": "200", - "description": "

Response

" - } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "301", - "description": "

Moved permanently

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/rename", - "title": "Rename a branch", - "category": "branches", - "subcategory": "branches", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "new_name", - "in": "body", - "description": "

The new name of the branch.

", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "new_name": "my_renamed_branch" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "201", "contentType": "application/json", "description": "

Response

", "example": { - "name": "master", + "name": "main", "commit": { "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", - "node_id": "MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", "commit": { "author": { "name": "The Octocat", - "date": "2012-03-06T15:06:50-08:00", - "email": "octocat@nowhere.com" + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" }, - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", "tree": { "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" }, - "committer": { - "name": "The Octocat", - "date": "2012-03-06T15:06:50-08:00", - "email": "octocat@nowhere.com" - }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null - }, - "comment_count": 0 + } }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", "gravatar_id": "", - "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", "url": "https://api.github.com/users/octocat", - "id": 583231, - "login": "octocat", - "node_id": "MDQ6VXNlcjE=", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", @@ -118728,26 +118691,15 @@ "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", - "site_admin": true + "site_admin": false }, - "parents": [ - { - "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" - }, - { - "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303" - } - ], - "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", "gravatar_id": "", - "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", "url": "https://api.github.com/users/octocat", - "id": 583231, - "login": "octocat", - "node_id": "MDQ6VXNlcjE=", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", @@ -118759,26 +118711,35 @@ "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", - "site_admin": true + "site_admin": false }, - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] }, "_links": { - "html": "https://github.com/octocat/Hello-World/tree/master", - "self": "https://api.github.com/repos/octocat/Hello-World/branches/master" + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" }, - "protected": true, + "protected": false, "protection": { + "enabled": false, "required_status_checks": { - "enforcement_level": "non_admins", - "contexts": [ - "ci-test", - "linter" - ] + "enforcement_level": "off", + "contexts": [], + "checks": [] } }, - "protection_url": "https://api.github.com/repos/octocat/hello-world/branches/master/protection" + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" }, "schema": { "title": "Branch With Protection", @@ -121449,32 +121410,28 @@ } } ], + "descriptionHTML": "", "previews": [], - "descriptionHTML": "

Renames a branch in a repository.

\n

Note: Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".

\n

The permissions required to use this endpoint depends on whether you are renaming the default branch.

\n

To rename a non-default branch:

\n
    \n
  • Users must have push access.
  • \n
  • GitHub Apps must have the contents:write repository permission.
  • \n
\n

To rename the default branch:

\n
    \n
  • Users must have admin or owner permissions.
  • \n
  • GitHub Apps must have the administration:write repository permission.
  • \n
", "statusCodes": [ { - "httpStatusCode": "201", - "description": "

Created

" + "httpStatusCode": "200", + "description": "

OK

" }, { - "httpStatusCode": "403", - "description": "

Forbidden

" + "httpStatusCode": "301", + "description": "

Moved permanently

" }, { "httpStatusCode": "404", "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/merge-upstream", - "title": "Sync a fork branch with the upstream repository", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/rename", + "title": "Rename a branch", "category": "branches", "subcategory": "branches", "parameters": [ @@ -121495,130 +121452,25 @@ "schema": { "type": "string" } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "branch", - "in": "body", - "description": "

The name of the branch which should be updated to match upstream.

", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "branch": "main" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

The branch has been successfully synced with the upstream repository

", - "example": { - "message": "Successfully fetched and fast-forwarded from upstream defunkt:main", - "merge_type": "fast-forward", - "base_branch": "defunkt:main" - }, - "schema": { - "title": "Merged upstream", - "description": "Results of a successful merge upstream request", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "merge_type": { - "type": "string", - "enum": [ - "merge", - "fast-forward", - "none" - ] - }, - "base_branch": { - "type": "string" - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Sync a branch of a forked repository to keep it up-to-date with the upstream repository.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

The branch has been successfully synced with the upstream repository

" - }, - { - "httpStatusCode": "409", - "description": "

The branch could not be synced because of a merge conflict

" - }, - { - "httpStatusCode": "422", - "description": "

The branch could not be synced for some other reason

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/merges", - "title": "Merge a branch", - "category": "branches", - "subcategory": "branches", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", + "name": "branch", + "description": "

The name of the branch.

", "in": "path", "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true } ], "bodyParameters": [ { "type": "string", - "name": "base", - "in": "body", - "description": "

The name of the base branch that the head will be merged into.

", - "isRequired": true - }, - { - "type": "string", - "name": "head", + "name": "new_name", "in": "body", - "description": "

The head to merge. This can be a branch name or a commit SHA1.

", + "description": "

The new name of the branch.

", "isRequired": true - }, - { - "type": "string", - "name": "commit_message", - "in": "body", - "description": "

Commit message to use for the merge commit. If omitted, a default message will be used.

" } ], "enabledForGitHubApps": true, @@ -121630,153 +121482,129 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "base": "master", - "head": "cool_feature", - "commit_message": "Shipped cool_feature!" + "new_name": "my_renamed_branch" }, "parameters": { "owner": "OWNER", - "repo": "REPO" + "repo": "REPO", + "branch": "BRANCH" } }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "

Successful Response (The resulting merge commit)

", + "description": "

Response

", "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", + "name": "master", "commit": { - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==", + "commit": { + "author": { + "name": "The Octocat", + "date": "2012-03-06T15:06:50-08:00", + "email": "octocat@nowhere.com" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "committer": { + "name": "The Octocat", + "date": "2012-03-06T15:06:50-08:00", + "email": "octocat@nowhere.com" + }, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + }, + "comment_count": 0 + }, "author": { - "name": "Monalisa Octocat", - "email": "mona@github.com", - "date": "2011-04-14T16:00:49Z" + "gravatar_id": "", + "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", + "url": "https://api.github.com/users/octocat", + "id": 583231, + "login": "octocat", + "node_id": "MDQ6VXNlcjE=", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ], + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "committer": { - "name": "Monalisa Octocat", - "email": "mona@github.com", - "date": "2011-04-14T16:00:49Z" - }, - "message": "Fix all the bugs", - "tree": { - "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + "gravatar_id": "", + "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", + "url": "https://api.github.com/users/octocat", + "id": 583231, + "login": "octocat", + "node_id": "MDQ6VXNlcjE=", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true }, - "comment_count": 0, - "verification": { - "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null - } - }, - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" }, - "committer": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "_links": { + "html": "https://github.com/octocat/Hello-World/tree/master", + "self": "https://api.github.com/repos/octocat/Hello-World/branches/master" }, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + "protected": true, + "protection": { + "required_status_checks": { + "enforcement_level": "non_admins", + "contexts": [ + "ci-test", + "linter" + ] } - ], - "stats": { - "additions": 104, - "deletions": 4, - "total": 108 }, - "files": [ - { - "filename": "file1.txt", - "additions": 10, - "deletions": 2, - "changes": 12, - "status": "modified", - "raw_url": "https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", - "blob_url": "https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", - "patch": "@@ -29,7 +29,7 @@\n....." - } - ] + "protection_url": "https://api.github.com/repos/octocat/hello-world/branches/master/protection" }, "schema": { - "title": "Commit", - "description": "Commit", + "title": "Branch With Protection", + "description": "Branch With Protection", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "sha": { - "type": "string", - "examples": [ - "6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" - ] + "name": { + "type": "string" }, "commit": { + "title": "Commit", + "description": "Commit", "type": "object", "properties": { "url": { @@ -121786,35 +121614,345 @@ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, + "sha": { + "type": "string", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + ] + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { + "type": "string", + "examples": [ + "Fix all the bugs" + ] + }, + "comment_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" + ] + } + }, + "required": [ + "sha", + "url" + ] + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "payload": { + "type": [ + "string", + "null" + ] + }, + "signature": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature" + ] + } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, "author": { "anyOf": [ { "type": "null" }, { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", "examples": [ - "\"Chris Wanstrath\"" + "octocat" ] }, - "email": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", "examples": [ - "\"chris@ozmm.org\"" + "MDQ6VXNlcjE=" ] }, - "date": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "\"2007-10-29T02:42:39.000-07:00\"" + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } ] }, @@ -121824,639 +121962,5513 @@ "type": "null" }, { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", "examples": [ - "\"Chris Wanstrath\"" + "octocat" ] }, - "email": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", "examples": [ - "\"chris@ozmm.org\"" + "MDQ6VXNlcjE=" ] }, - "date": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "\"2007-10-29T02:42:39.000-07:00\"" + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } ] }, - "message": { - "type": "string", - "examples": [ - "Fix all the bugs" - ] - }, - "comment_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "tree": { - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "827efc6d56897b048c772eb4087f854f46256132" - ] + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + } }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" - ] - } - }, - "required": [ - "sha", - "url" - ] + "required": [ + "sha", + "url" + ] + } }, - "verification": { - "title": "Verification", + "stats": { "type": "object", "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" + "additions": { + "type": "integer" }, - "payload": { - "type": [ - "string", - "null" - ] + "deletions": { + "type": "integer" }, - "signature": { - "type": [ - "string", - "null" - ] + "total": { + "type": "integer" } - }, - "required": [ - "verified", - "reason", - "payload", - "signature" - ] - } - }, - "required": [ - "author", - "committer", - "comment_count", - "message", - "tree", - "url" - ] - }, - "author": { - "anyOf": [ - { - "type": "null" + } }, - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "files": { + "type": "array", + "items": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" + ] + }, + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "examples": [ + "added" + ] + }, + "additions": { + "type": "integer", + "examples": [ + 103 + ] + }, + "deletions": { + "type": "integer", + "examples": [ + 21 + ] + }, + "changes": { + "type": "integer", + "examples": [ + 124 + ] + }, + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" + ] + } }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + } + } + }, + "required": [ + "url", + "sha", + "node_id", + "html_url", + "comments_url", + "commit", + "author", + "committer", + "parents" + ] + }, + "_links": { + "type": "object", + "properties": { + "html": { + "type": "string" + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "html", + "self" + ] + }, + "protected": { + "type": "boolean" + }, + "protection": { + "title": "Branch Protection", + "description": "Branch Protection", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", + "type": "object", + "properties": { + "url": { + "type": "string" }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "enforcement_level": { + "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "contexts": { + "type": "array", + "items": { + "type": "string" + } }, - "repos_url": { + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": [ + "integer", + "null" + ] + } + }, + "required": [ + "context", + "app_id" + ] + } + }, + "contexts_url": { + "type": "string" + }, + "strict": { + "type": "boolean" + } + }, + "required": [ + "contexts", + "checks" + ] + }, + "enforce_admins": { + "title": "Protected Branch Admin Enforced", + "description": "Protected Branch Admin Enforced", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" ] }, - "events_url": { - "type": "string", + "enabled": { + "type": "boolean", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + true ] - }, - "received_events_url": { + } + }, + "required": [ + "url", + "enabled" + ] + }, + "required_pull_request_reviews": { + "title": "Protected Branch Pull Request Review", + "description": "Protected Branch Pull Request Review", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" ] }, - "site_admin": { - "type": "boolean" + "dismissal_restrictions": { + "type": "object", + "properties": { + "users": { + "description": "The list of users with review dismissal access.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams with review dismissal access.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps with review dismissal access.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" + ] + }, + "users_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" + ] + }, + "teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" + ] + } + } }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "bypass_pull_request_allowances": { + "type": "object", + "description": "Allow specific users, teams, or apps to bypass pull request requirements.", + "properties": { + "users": { + "description": "The list of users allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + } + } + }, + "dismiss_stale_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "require_code_owner_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "required_approving_review_count": { + "type": "integer", + "minimum": 0, + "maximum": 6, + "examples": [ + 2 + ] + } + }, + "required": [ + "dismiss_stale_reviews", + "require_code_owner_reviews" + ] + }, + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "name": { + "type": "string", + "examples": [ + "\"branch/with/protection\"" + ] + }, + "protection_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + } + } + }, + "protection_url": { + "type": "string", + "format": "uri" + }, + "pattern": { + "type": "string", + "examples": [ + "\"mas*\"" + ] + }, + "required_approving_review_count": { + "type": "integer", + "examples": [ + 1 + ] + } + }, + "required": [ + "name", + "commit", + "_links", + "protection", + "protected", + "protection_url" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Renames a branch in a repository.

\n

Note: Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".

\n

The permissions required to use this endpoint depends on whether you are renaming the default branch.

\n

To rename a non-default branch:

\n
    \n
  • Users must have push access.
  • \n
  • GitHub Apps must have the contents:write repository permission.
  • \n
\n

To rename the default branch:

\n
    \n
  • Users must have admin or owner permissions.
  • \n
  • GitHub Apps must have the administration:write repository permission.
  • \n
", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/merge-upstream", + "title": "Sync a fork branch with the upstream repository", + "category": "branches", + "subcategory": "branches", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "branch", + "in": "body", + "description": "

The name of the branch which should be updated to match upstream.

", + "isRequired": true + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "branch": "main" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

The branch has been successfully synced with the upstream repository

", + "example": { + "message": "Successfully fetched and fast-forwarded from upstream defunkt:main", + "merge_type": "fast-forward", + "base_branch": "defunkt:main" + }, + "schema": { + "title": "Merged upstream", + "description": "Results of a successful merge upstream request", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "merge_type": { + "type": "string", + "enum": [ + "merge", + "fast-forward", + "none" + ] + }, + "base_branch": { + "type": "string" + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Sync a branch of a forked repository to keep it up-to-date with the upstream repository.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

The branch has been successfully synced with the upstream repository

" + }, + { + "httpStatusCode": "409", + "description": "

The branch could not be synced because of a merge conflict

" + }, + { + "httpStatusCode": "422", + "description": "

The branch could not be synced for some other reason

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/merges", + "title": "Merge a branch", + "category": "branches", + "subcategory": "branches", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "base", + "in": "body", + "description": "

The name of the base branch that the head will be merged into.

", + "isRequired": true + }, + { + "type": "string", + "name": "head", + "in": "body", + "description": "

The head to merge. This can be a branch name or a commit SHA1.

", + "isRequired": true + }, + { + "type": "string", + "name": "commit_message", + "in": "body", + "description": "

Commit message to use for the merge commit. If omitted, a default message will be used.

" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "base": "master", + "head": "cool_feature", + "commit_message": "Shipped cool_feature!" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Successful Response (The resulting merge commit)

", + "example": { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", + "commit": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "author": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "committer": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "message": "Fix all the bugs", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "comment_count": 0, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + ], + "stats": { + "additions": 104, + "deletions": 4, + "total": 108 + }, + "files": [ + { + "filename": "file1.txt", + "additions": 10, + "deletions": 2, + "changes": 12, + "status": "modified", + "raw_url": "https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", + "blob_url": "https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", + "patch": "@@ -29,7 +29,7 @@\n....." + } + ] + }, + "schema": { + "title": "Commit", + "description": "Commit", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "sha": { + "type": "string", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + ] + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { + "type": "string", + "examples": [ + "Fix all the bugs" + ] + }, + "comment_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" + ] + } + }, + "required": [ + "sha", + "url" + ] + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "payload": { + "type": [ + "string", + "null" + ] + }, + "signature": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature" + ] + } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + } + }, + "required": [ + "sha", + "url" + ] + } + }, + "stats": { + "type": "object", + "properties": { + "additions": { + "type": "integer" + }, + "deletions": { + "type": "integer" + }, + "total": { + "type": "integer" + } + } + }, + "files": { + "type": "array", + "items": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" + ] + }, + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "examples": [ + "added" + ] + }, + "additions": { + "type": "integer", + "examples": [ + 103 + ] + }, + "deletions": { + "type": "integer", + "examples": [ + 21 + ] + }, + "changes": { + "type": "integer", + "examples": [ + 124 + ] + }, + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" + ] + } + }, + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + } + } + }, + "required": [ + "url", + "sha", + "node_id", + "html_url", + "comments_url", + "commit", + "author", + "committer", + "parents" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Successful Response (The resulting merge commit)

" + }, + { + "httpStatusCode": "204", + "description": "

Response when already merged

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Not Found when the base or head does not exist

" + }, + { + "httpStatusCode": "409", + "description": "

Conflict when there is a merge conflict

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed

" + } + ] + } + ], + "branch-protection": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", + "title": "Get branch protection", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts", + "enforcement_level": "non_admins" + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", + "enabled": true + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", + "users": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "apps": [ + { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + } + ] + }, + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2 + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps", + "users": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "apps": [ + { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + } + ] + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + }, + "schema": { + "title": "Branch Protection", + "description": "Branch Protection", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enforcement_level": { + "type": "string" + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + } + }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": [ + "integer", + "null" + ] + } + }, + "required": [ + "context", + "app_id" + ] + } + }, + "contexts_url": { + "type": "string" + }, + "strict": { + "type": "boolean" + } + }, + "required": [ + "contexts", + "checks" + ] + }, + "enforce_admins": { + "title": "Protected Branch Admin Enforced", + "description": "Protected Branch Admin Enforced", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "required_pull_request_reviews": { + "title": "Protected Branch Pull Request Review", + "description": "Protected Branch Pull Request Review", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" + ] + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "users": { + "description": "The list of users with review dismissal access.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams with review dismissal access.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps with review dismissal access.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" + ] + }, + "users_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" + ] + }, + "teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" + ] + } + } + }, + "bypass_pull_request_allowances": { + "type": "object", + "description": "Allow specific users, teams, or apps to bypass pull request requirements.", + "properties": { + "users": { + "description": "The list of users allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + } + }, + "dismiss_stale_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "require_code_owner_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "required_approving_review_count": { + "type": "integer", + "minimum": 0, + "maximum": 6, + "examples": [ + 2 ] } + }, + "required": [ + "dismiss_stale_reviews", + "require_code_owner_reviews" ] }, - "committer": { - "anyOf": [ - { - "type": "null" + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" }, - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" ] }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" - ] - } - }, - "required": [ - "sha", - "url" - ] + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } } }, - "stats": { + "allow_force_pushes": { "type": "object", "properties": { - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "total": { - "type": "integer" + "enabled": { + "type": "boolean" } } }, - "files": { - "type": "array", - "items": { - "title": "Diff Entry", - "description": "Diff Entry", - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "bbcd538c8e72b8c175046e27cc8f907076331401" - ] - }, - "filename": { - "type": "string", - "examples": [ - "file1.txt" - ] - }, - "status": { - "type": "string", - "enum": [ - "added", - "removed", - "modified", - "renamed", - "copied", - "changed", - "unchanged" - ], - "examples": [ - "added" - ] - }, - "additions": { - "type": "integer", - "examples": [ - 103 - ] - }, - "deletions": { - "type": "integer", - "examples": [ - 21 - ] - }, - "changes": { - "type": "integer", - "examples": [ - 124 - ] - }, - "blob_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "raw_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "contents_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "patch": { - "type": "string", - "examples": [ - "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" - ] - }, - "previous_filename": { - "type": "string", - "examples": [ - "file.txt" - ] - } - }, - "required": [ - "additions", - "blob_url", - "changes", - "contents_url", - "deletions", - "filename", - "raw_url", - "sha", - "status" - ] + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } } + }, + "name": { + "type": "string", + "examples": [ + "\"branch/with/protection\"" + ] + }, + "protection_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] } - }, - "required": [ - "url", - "sha", - "node_id", - "html_url", - "comments_url", - "commit", - "author", - "committer", - "parents" - ] + } } } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", "statusCodes": [ { - "httpStatusCode": "201", - "description": "

Successful Response (The resulting merge commit)

" - }, - { - "httpStatusCode": "204", - "description": "

Response when already merged

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" + "httpStatusCode": "200", + "description": "

OK

" }, { "httpStatusCode": "404", - "description": "

Not Found when the base or head does not exist

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict when there is a merge conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed

" + "description": "

Resource not found

" } ] - } - ], - "branch-protection": [ + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", + "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "title": "Get branch protection", + "title": "Update branch protection", "category": "branches", "subcategory": "branch-protection", "parameters": [ @@ -122489,205 +127501,289 @@ "x-multi-segment": true } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "object or null", + "name": "required_status_checks", + "in": "body", + "description": "

Require status checks to pass before merging. Set to null to disable.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "strict", + "description": "

Require branches to be up to date before merging.

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "contexts", + "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "isRequired": true + }, + { + "type": "array of objects", + "name": "checks", + "description": "

The list of status checks to require in order to merge into this branch.

", + "childParamsGroups": [ + { + "type": "string", + "name": "context", + "description": "

The name of the required check

", + "isRequired": true + }, + { + "type": "integer", + "name": "app_id", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" + } + ] + } + ] + }, + { + "type": "boolean or null", + "name": "enforce_admins", + "in": "body", + "description": "

Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "required_pull_request_reviews", + "in": "body", + "description": "

Require at least one approving review on a pull request, before merging. Set to null to disable.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "dismissal_restrictions", + "description": "

Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "users", + "description": "

The list of user logins with dismissal access

" + }, + { + "type": "array of strings", + "name": "teams", + "description": "

The list of team slugs with dismissal access

" + }, + { + "type": "array of strings", + "name": "apps", + "description": "

The list of app slugs with dismissal access

" + } + ] + }, + { + "type": "boolean", + "name": "dismiss_stale_reviews", + "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

" + }, + { + "type": "boolean", + "name": "require_code_owner_reviews", + "description": "

Blocks merging pull requests until code owners review them.

" + }, + { + "type": "integer", + "name": "required_approving_review_count", + "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

" + }, + { + "type": "object", + "name": "bypass_pull_request_allowances", + "description": "

Allow specific users, teams, or apps to bypass pull request requirements.

", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "users", + "description": "

The list of user logins allowed to bypass pull request requirements.

" + }, + { + "type": "array of strings", + "name": "teams", + "description": "

The list of team slugs allowed to bypass pull request requirements.

" + }, + { + "type": "array of strings", + "name": "apps", + "description": "

The list of app slugs allowed to bypass pull request requirements.

" + } + ] + } + ] + }, + { + "type": "object or null", + "name": "restrictions", + "in": "body", + "description": "

Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of strings", + "name": "users", + "description": "

The list of user logins with push access

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "teams", + "description": "

The list of team slugs with push access

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "apps", + "description": "

The list of app slugs with push access

" + } + ] + }, + { + "type": "boolean", + "name": "required_linear_history", + "in": "body", + "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

" + }, + { + "type": "boolean or null", + "name": "allow_force_pushes", + "in": "body", + "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

" + }, + { + "type": "boolean", + "name": "allow_deletions", + "in": "body", + "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

" + }, + { + "type": "boolean", + "name": "block_creations", + "in": "body", + "description": "

If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

" + }, + { + "type": "boolean", + "name": "required_conversation_resolution", + "in": "body", + "description": "

Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

" + } + ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { + "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection", + "bodyParameters": { "required_status_checks": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", + "strict": true, "contexts": [ "continuous-integration/travis-ci" - ], - "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts", - "enforcement_level": "non_admins" - }, - "enforce_admins": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", - "enabled": true + ] }, + "enforce_admins": true, "required_pull_request_reviews": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", "dismissal_restrictions": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", - "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", "users": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } + "octocat" ], "teams": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "apps": [ - { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] - } + "justice-league" ] }, "dismiss_stale_reviews": true, "require_code_owner_reviews": true, - "required_approving_review_count": 2 + "required_approving_review_count": 2, + "bypass_pull_request_allowances": { + "users": [ + "octocat" + ], + "teams": [ + "justice-league" + ] + } }, "restrictions": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", - "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams", - "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps", "users": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } + "octocat" ], "teams": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } + "justice-league" ], "apps": [ + "super-ci" + ] + }, + "required_linear_history": true, + "allow_force_pushes": true, + "allow_deletions": true, + "block_creations": true, + "required_conversation_resolution": true + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] + "context": "continuous-integration/travis-ci", + "app_id": null } ] }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [], + "teams": [], + "apps": [] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [], + "teams": [], + "apps": [] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, "required_linear_history": { "enabled": true }, @@ -122697,37 +127793,48 @@ "allow_deletions": { "enabled": true }, + "block_creations": { + "enabled": true + }, "required_conversation_resolution": { "enabled": true } }, "schema": { - "title": "Branch Protection", - "description": "Branch Protection", + "title": "Protected Branch", + "description": "Branch protections protect branches", "type": "object", "properties": { "url": { - "type": "string" - }, - "enabled": { - "type": "boolean" + "type": "string", + "format": "uri" }, "required_status_checks": { - "title": "Protected Branch Required Status Check", - "description": "Protected Branch Required Status Check", + "title": "Status Check Policy", + "description": "Status Check Policy", "type": "object", "properties": { "url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" + ] }, - "enforcement_level": { - "type": "string" + "strict": { + "type": "boolean", + "examples": [ + true + ] }, "contexts": { "type": "array", "items": { "type": "string" - } + }, + "examples": [ + "continuous-integration/travis-ci" + ] }, "checks": { "type": "array", @@ -122735,7 +127842,10 @@ "type": "object", "properties": { "context": { - "type": "string" + "type": "string", + "examples": [ + "continuous-integration/travis-ci" + ] }, "app_id": { "type": [ @@ -122751,58 +127861,53 @@ } }, "contexts_url": { - "type": "string" - }, - "strict": { - "type": "boolean" - } - }, - "required": [ - "contexts", - "checks" - ] - }, - "enforce_admins": { - "title": "Protected Branch Admin Enforced", - "description": "Protected Branch Admin Enforced", - "type": "object", - "properties": { - "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" - ] - }, - "enabled": { - "type": "boolean", - "examples": [ - true + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" ] } }, "required": [ "url", - "enabled" + "contexts_url", + "strict", + "contexts", + "checks" ] }, "required_pull_request_reviews": { - "title": "Protected Branch Pull Request Review", - "description": "Protected Branch Pull Request Review", "type": "object", "properties": { "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" - ] + "format": "uri" + }, + "dismiss_stale_reviews": { + "type": "boolean" + }, + "require_code_owner_reviews": { + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" }, "dismissal_restrictions": { "type": "object", "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, "users": { - "description": "The list of users with review dismissal access.", "type": "array", "items": { "title": "Simple User", @@ -122967,7 +128072,6 @@ } }, "teams": { - "description": "The list of teams with review dismissal access.", "type": "array", "items": { "title": "Team", @@ -123171,7 +128275,6 @@ } }, "apps": { - "description": "The list of apps with review dismissal access.", "type": "array", "items": { "title": "GitHub app", @@ -123498,33 +128601,20 @@ "events" ] } - }, - "url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" - ] - }, - "users_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" - ] - }, - "teams_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" - ] } - } + }, + "required": [ + "url", + "users_url", + "teams_url", + "users", + "teams" + ] }, "bypass_pull_request_allowances": { "type": "object", - "description": "Allow specific users, teams, or apps to bypass pull request requirements.", "properties": { "users": { - "description": "The list of users allowed to bypass pull request requirements.", "type": "array", "items": { "title": "Simple User", @@ -123689,7 +128779,6 @@ } }, "teams": { - "description": "The list of teams allowed to bypass pull request requirements.", "type": "array", "items": { "title": "Team", @@ -123893,7 +128982,6 @@ } }, "apps": { - "description": "The list of apps allowed to bypass pull request requirements.", "type": "array", "items": { "title": "GitHub app", @@ -124221,32 +129309,90 @@ ] } } - } - }, - "dismiss_stale_reviews": { - "type": "boolean", + }, + "required": [ + "users", + "teams" + ] + } + }, + "required": [ + "url" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", "examples": [ - true + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" ] }, - "require_code_owner_reviews": { + "enabled": { "type": "boolean", "examples": [ true ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "enforce_admins": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" }, - "required_approving_review_count": { - "type": "integer", - "minimum": 0, - "maximum": 6, - "examples": [ - 2 - ] + "enabled": { + "type": "boolean" } }, + "additionalProperties": false, "required": [ - "dismiss_stale_reviews", - "require_code_owner_reviews" + "url", + "enabled" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" ] }, "restrictions": { @@ -124558,29 +129704,14 @@ "apps" ] }, - "required_linear_history": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "allow_force_pushes": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "allow_deletions": { + "required_conversation_resolution": { "type": "object", "properties": { "enabled": { "type": "boolean" } - } + }, + "additionalProperties": false }, "block_creations": { "type": "object", @@ -124588,340 +129719,17 @@ "enabled": { "type": "boolean" } - } - }, - "required_conversation_resolution": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "name": { - "type": "string", - "examples": [ - "\"branch/with/protection\"" - ] - }, - "protection_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" - ] - }, - "required_signatures": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" - ] - }, - "enabled": { - "type": "boolean", - "examples": [ - true - ] - } }, + "additionalProperties": false, "required": [ - "url", "enabled" ] } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "title": "Update branch protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "object or null", - "name": "required_status_checks", - "in": "body", - "description": "

Require status checks to pass before merging. Set to null to disable.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "strict", - "description": "

Require branches to be up to date before merging.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "contexts", - "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "checks", - "description": "

The list of status checks to require in order to merge into this branch.

", - "childParamsGroups": [ - { - "type": "string", - "name": "context", - "description": "

The name of the required check

", - "isRequired": true - }, - { - "type": "integer", - "name": "app_id", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" - } - ] - } - ] - }, - { - "type": "boolean or null", - "name": "enforce_admins", - "in": "body", - "description": "

Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "required_pull_request_reviews", - "in": "body", - "description": "

Require at least one approving review on a pull request, before merging. Set to null to disable.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "dismissal_restrictions", - "description": "

Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "users", - "description": "

The list of user logins with dismissal access

" - }, - { - "type": "array of strings", - "name": "teams", - "description": "

The list of team slugs with dismissal access

" - }, - { - "type": "array of strings", - "name": "apps", - "description": "

The list of app slugs with dismissal access

" - } - ] - }, - { - "type": "boolean", - "name": "dismiss_stale_reviews", - "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

" - }, - { - "type": "boolean", - "name": "require_code_owner_reviews", - "description": "

Blocks merging pull requests until code owners review them.

" - }, - { - "type": "integer", - "name": "required_approving_review_count", - "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

" - }, - { - "type": "object", - "name": "bypass_pull_request_allowances", - "description": "

Allow specific users, teams, or apps to bypass pull request requirements.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "users", - "description": "

The list of user logins allowed to bypass pull request requirements.

" - }, - { - "type": "array of strings", - "name": "teams", - "description": "

The list of team slugs allowed to bypass pull request requirements.

" - }, - { - "type": "array of strings", - "name": "apps", - "description": "

The list of app slugs allowed to bypass pull request requirements.

" - } - ] - } - ] - }, - { - "type": "object or null", - "name": "restrictions", - "in": "body", - "description": "

Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of strings", - "name": "users", - "description": "

The list of user logins with push access

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "teams", - "description": "

The list of team slugs with push access

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "apps", - "description": "

The list of app slugs with push access

" - } - ] - }, - { - "type": "boolean", - "name": "required_linear_history", - "in": "body", - "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

" - }, - { - "type": "boolean or null", - "name": "allow_force_pushes", - "in": "body", - "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

" - }, - { - "type": "boolean", - "name": "allow_deletions", - "in": "body", - "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

" - }, - { - "type": "boolean", - "name": "block_creations", - "in": "body", - "description": "

If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

" - }, - { - "type": "boolean", - "name": "required_conversation_resolution", - "in": "body", - "description": "

Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

" - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "required_status_checks": { - "strict": true, - "contexts": [ - "continuous-integration/travis-ci" - ] - }, - "enforce_admins": true, - "required_pull_request_reviews": { - "dismissal_restrictions": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ] - }, - "dismiss_stale_reviews": true, - "require_code_owner_reviews": true, - "required_approving_review_count": 2, - "bypass_pull_request_allowances": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ] - } - }, - "restrictions": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ], - "apps": [ - "super-ci" - ] }, - "required_linear_history": true, - "allow_force_pushes": true, - "allow_deletions": true, - "block_creations": true, - "required_conversation_resolution": true - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" + "required": [ + "url" + ] } - }, - "response": { - "statusCode": "200", - "description": "

Response

" } } ], @@ -129127,36 +133935,347 @@ } ], "bodyParameters": [ - { - "type": "boolean", - "name": "strict", - "in": "body", - "description": "

Require branches to be up to date before merging.

" - }, + { + "type": "boolean", + "name": "strict", + "in": "body", + "description": "

Require branches to be up to date before merging.

" + }, + { + "type": "array of strings", + "name": "contexts", + "in": "body", + "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

" + }, + { + "type": "array of objects", + "name": "checks", + "in": "body", + "description": "

The list of status checks to require in order to merge into this branch.

", + "childParamsGroups": [ + { + "type": "string", + "name": "context", + "description": "

The name of the required check

", + "isRequired": true + }, + { + "type": "integer", + "name": "app_id", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" + } + ] + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ] + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + }, + "schema": { + "title": "Status Check Policy", + "description": "Status Check Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" + ] + }, + "strict": { + "type": "boolean", + "examples": [ + true + ] + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "continuous-integration/travis-ci" + ] + }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "examples": [ + "continuous-integration/travis-ci" + ] + }, + "app_id": { + "type": [ + "integer", + "null" + ] + } + }, + "required": [ + "context", + "app_id" + ] + } + }, + "contexts_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + ] + } + }, + "required": [ + "url", + "contexts_url", + "strict", + "contexts", + "checks" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + "title": "Remove status check protection", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "title": "Get all status check contexts", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + "continuous-integration/travis-ci" + ], + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "title": "Add status check contexts", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [ { "type": "array of strings", "name": "contexts", "in": "body", - "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

" - }, - { - "type": "array of objects", - "name": "checks", - "in": "body", - "description": "

The list of status checks to require in order to merge into this branch.

", - "childParamsGroups": [ - { - "type": "string", - "name": "context", - "description": "

The name of the required check

", - "isRequired": true - }, - { - "type": "integer", - "name": "app_id", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" - } - ] + "description": "

The name of the status checks

", + "isRequired": true } ], "enabledForGitHubApps": true, @@ -129165,12 +134284,12 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding status checks to a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "strict": true, "contexts": [ - "continuous-integration/travis-ci" + "continuous-integration/travis-ci", + "continuous-integration/jenkins" ] }, "parameters": { @@ -129179,311 +134298,6 @@ "branch": "BRANCH" } }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", - "strict": true, - "contexts": [ - "continuous-integration/travis-ci" - ], - "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" - }, - "schema": { - "title": "Status Check Policy", - "description": "Status Check Policy", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" - ] - }, - "strict": { - "type": "boolean", - "examples": [ - true - ] - }, - "contexts": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "continuous-integration/travis-ci" - ] - }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "examples": [ - "continuous-integration/travis-ci" - ] - }, - "app_id": { - "type": [ - "integer", - "null" - ] - } - }, - "required": [ - "context", - "app_id" - ] - } - }, - "contexts_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" - ] - } - }, - "required": [ - "url", - "contexts_url", - "strict", - "contexts", - "checks" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "title": "Remove status check protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "title": "Get all status check contexts", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - "continuous-integration/travis-ci" - ], - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "title": "Add status check contexts", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "contexts", - "in": "body", - "description": "

contexts parameter

", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, "response": { "statusCode": "200", "contentType": "application/json", @@ -129564,7 +134378,7 @@ "type": "array of strings", "name": "contexts", "in": "body", - "description": "

contexts parameter

", + "description": "

The name of the status checks

", "isRequired": true } ], @@ -129574,8 +134388,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example updating status checks for a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -129657,7 +134476,7 @@ "type": "array of strings", "name": "contexts", "in": "body", - "description": "

contexts parameter

", + "description": "

The name of the status checks

", "isRequired": true } ], @@ -129667,8 +134486,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing status checks from a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -132362,7 +137186,7 @@ "type": "array of strings", "name": "teams", "in": "body", - "description": "

teams parameter

", + "description": "

The slug values for teams

", "isRequired": true } ], @@ -132372,8 +137196,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -132661,7 +137490,7 @@ "type": "array of strings", "name": "teams", "in": "body", - "description": "

teams parameter

", + "description": "

The slug values for teams

", "isRequired": true } ], @@ -132671,8 +137500,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -132960,7 +137794,7 @@ "type": "array of strings", "name": "teams", "in": "body", - "description": "

teams parameter

", + "description": "

The slug values for teams

", "isRequired": true } ], @@ -132970,8 +137804,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -133516,7 +138355,7 @@ "type": "array of strings", "name": "users", "in": "body", - "description": "

users parameter

", + "description": "

The username for users

", "isRequired": true } ], @@ -133526,8 +138365,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -133782,7 +138626,7 @@ "type": "array of strings", "name": "users", "in": "body", - "description": "

users parameter

", + "description": "

The username for users

", "isRequired": true } ], @@ -133792,8 +138636,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -134048,7 +138897,7 @@ "type": "array of strings", "name": "users", "in": "body", - "description": "

users parameter

", + "description": "

The username for users

", "isRequired": true } ], @@ -134058,8 +138907,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -145179,6 +150033,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -148245,6 +153103,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -150829,6 +155691,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -153832,6 +158698,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -156942,6 +161812,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -158094,7 +162968,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -158436,6 +163311,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -158715,7 +163597,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -159057,6 +163940,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -159296,6 +164186,7 @@ "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "state": "open", "fixed_at": null, "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", @@ -160147,7 +165038,7 @@ "description": "

Service unavailable

" } ], - "descriptionHTML": "

Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the repo scope. For public repositories,\nyou must use an access token with public_repo scope.\nGitHub Apps must have the security_events write permission to use this endpoint.

\n

You can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.

\n

When you list the analyses for a repository,\none or more will be identified as deletable in the response:

\n
\"deletable\": true\n
\n

An analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:

\n
    \n
  • ref
  • \n
  • tool
  • \n
  • analysis_key
  • \n
  • environment
  • \n
\n

If you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:

\n
Analysis specified is not deletable.\n
\n

The response from a successful DELETE operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\nnext_analysis_url and confirm_delete_url.\nUse the next_analysis_url URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the confirm_delete_url URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of next_analysis_url and confirm_delete_url\nin the 200 response is null.

\n

As an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:

\n

Outer loop:

\n
    \n
  • \n

    List the analyses for the repository, filtered by tool.

    \n
  • \n
  • \n

    Parse this list to find a deletable analysis. If found:

    \n

    Inner loop:

    \n
      \n
    • Delete the identified analysis.
    • \n
    • Parse the response for the value of confirm_delete_url and, if found, use this in the next iteration.
    • \n
    \n
  • \n
\n

The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url value. Alternatively, you could use the next_analysis_url value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.

", + "descriptionHTML": "

Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the repo scope. For public repositories,\nyou must use an access token with public_repo scope.\nGitHub Apps must have the security_events write permission to use this endpoint.

\n

You can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.

\n

When you list the analyses for a repository,\none or more will be identified as deletable in the response:

\n
\"deletable\": true\n
\n

An analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:

\n
    \n
  • ref
  • \n
  • tool
  • \n
  • category
  • \n
\n

If you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:

\n
Analysis specified is not deletable.\n
\n

The response from a successful DELETE operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\nnext_analysis_url and confirm_delete_url.\nUse the next_analysis_url URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the confirm_delete_url URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of next_analysis_url and confirm_delete_url\nin the 200 response is null.

\n

As an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:

\n

Outer loop:

\n
    \n
  • \n

    List the analyses for the repository, filtered by tool.

    \n
  • \n
  • \n

    Parse this list to find a deletable analysis. If found:

    \n

    Inner loop:

    \n
      \n
    • Delete the identified analysis.
    • \n
    • Parse the response for the value of confirm_delete_url and, if found, use this in the next iteration.
    • \n
    \n
  • \n
\n

The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url value. Alternatively, you could use the next_analysis_url value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.

", "subcategory": "code-scanning" }, { @@ -163070,6 +167961,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -166151,6 +171046,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -166842,8 +171741,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example request body", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permissions": "write" + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -168864,6 +173766,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -171615,6 +176521,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -176708,6 +181618,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -178271,6 +183185,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -179784,6 +184702,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ] }, @@ -182365,6 +187287,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ] } @@ -186695,6 +191621,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -190230,6 +195160,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -208516,14 +213450,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -209746,14 +214672,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -210541,14 +215459,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -228171,6 +233081,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -231590,6 +236504,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -232426,7 +237344,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ], "schema": { @@ -234926,6 +239845,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -235702,7 +240625,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -238199,6 +243123,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -238942,7 +243870,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -241439,6 +246368,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -242034,6 +246967,12 @@ "closed" ] }, + { + "type": "string or null", + "name": "state_reason", + "in": "body", + "description": "

The reason for the current state

" + }, { "type": "null or string or integer or string or integer", "name": "milestone", @@ -242238,7 +247177,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -244735,6 +249675,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -248324,6 +253268,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -249406,7 +254354,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -251903,6 +256852,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -252640,7 +257593,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -255137,6 +260091,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -259768,7 +264726,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ], @@ -262497,6 +267456,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -264631,7 +269594,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } }, "schema": { @@ -267357,6 +272321,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -294846,6 +299814,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -302319,6 +307291,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -304231,6 +309207,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -306115,6 +311095,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -307979,6 +312963,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -309890,6 +314878,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -312131,6 +317123,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -313468,14 +318464,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -314344,14 +319332,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -315235,14 +320215,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -316038,14 +321010,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -316933,14 +321897,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -317737,14 +322693,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -318570,14 +323518,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -319445,14 +324385,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -322117,14 +327049,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -323058,7 +327982,7 @@ } ], "previews": [], - "descriptionHTML": "

List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.

\n

For more information on custom repository roles, see \"Managing custom repository roles for an organization\".

", + "descriptionHTML": "

List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.

\n

To use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with admin:org repo scope.\nGitHub Apps must have the organization_custom_roles:read organization permission to use this endpoint.

\n

For more information on custom repository roles, see \"Managing custom repository roles for an organization\".

", "statusCodes": [ { "httpStatusCode": "200", @@ -323345,10 +328269,6 @@ "httpStatusCode": "200", "description": "

OK

" }, - { - "httpStatusCode": "302", - "description": "

Response if requester is not an organization member

" - }, { "httpStatusCode": "422", "description": "

Validation failed

" @@ -340146,6 +345066,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -341709,6 +346633,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -350026,6 +354954,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ], "subcategory": "pulls" @@ -354931,6 +359863,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ], "subcategory": "pulls" @@ -363085,6 +368021,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -364648,6 +369588,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -368601,6 +373545,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -370164,6 +375112,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -391691,6 +396643,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -393568,6 +398524,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -396164,6 +401124,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -397824,6 +402788,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -399198,6 +404166,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -402203,6 +407175,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -403863,6 +408839,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -405237,6 +410217,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -408911,6 +413895,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -410650,6 +415638,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -410731,7 +415723,7 @@ } } ], - "descriptionHTML": "

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

\n

OAuth scope requirements

\n

When using OAuth, authorizations must include:

\n
    \n
  • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
  • \n
  • repo scope to create a private repository
  • \n
", + "descriptionHTML": "

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

\n

OAuth scope requirements

\n

When using OAuth, authorizations must include:

\n
    \n
  • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
  • \n
  • repo scope to create a private repository
  • \n
", "statusCodes": [ { "httpStatusCode": "201", @@ -412743,6 +417735,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -414549,6 +419545,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -416257,6 +421257,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -418455,6 +423459,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -418850,6 +423858,13 @@ "in": "body", "description": "

The URL must contain <num> for the reference number.

", "isRequired": true + }, + { + "type": "boolean", + "name": "is_alphanumeric", + "in": "body", + "description": "

Whether this autolink reference matches alphanumeric characters. If true, the <num> parameter of the url_template matches alphanumeric characters A-Z (case insensitive), 0-9, and -. If false, this autolink reference only matches numeric characters.

", + "default": "true" } ], "enabledForGitHubApps": true, @@ -418862,7 +423877,8 @@ "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=" + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true }, "parameters": { "owner": "OWNER", @@ -424521,6 +429537,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -427276,6 +432296,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -428936,6 +433960,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -430310,6 +435338,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -432796,6 +437828,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -435595,6 +440631,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -436088,7 +441128,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] }, @@ -438444,6 +443485,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -449896,6 +454941,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -452490,6 +457539,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -458307,6 +463360,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -460895,6 +465952,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ diff --git a/lib/rest/static/decorated/ghes-3.5.json b/lib/rest/static/decorated/ghes-3.5.json index 7cefd84492e9..a2565c89330f 100644 --- a/lib/rest/static/decorated/ghes-3.5.json +++ b/lib/rest/static/decorated/ghes-3.5.json @@ -3781,6 +3781,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -7383,6 +7387,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -13354,6 +13362,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -15921,6 +15933,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -17401,6 +17417,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -20112,6 +20132,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -21592,6 +21616,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -24329,6 +24357,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -25819,6 +25851,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -31385,6 +31421,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -33502,6 +33542,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -36631,6 +36675,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -38748,6 +38796,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -42304,6 +42356,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -44421,6 +44477,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -49467,6 +49527,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -51584,6 +51648,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -55216,6 +55284,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -59169,6 +59241,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -63116,6 +63192,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -67057,6 +67137,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -70988,6 +71072,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -74940,6 +75028,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -78871,6 +78963,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -82813,6 +82909,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -86755,6 +86855,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -90315,6 +90419,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -92725,6 +92833,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -95497,6 +95609,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -98226,6 +98342,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -99752,6 +99872,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -101588,6 +101712,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -102971,6 +103099,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -105671,6 +105803,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -107973,6 +108109,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -109540,14 +109680,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -110469,14 +110601,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -111091,15 +111215,6 @@ "write" ] }, - { - "type": "string", - "name": "organization_custom_roles", - "description": "

The level of permission to grant the access token for custom roles management.

", - "enum": [ - "read", - "write" - ] - }, { "type": "string", "name": "deployments", @@ -111542,14 +111657,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -113071,6 +113178,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -114171,14 +114282,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -115104,14 +115207,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -116035,14 +116130,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -117995,6 +118082,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -118648,14 +118739,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -120645,6 +120728,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -121353,14 +121440,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -122224,14 +122303,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -122863,15 +122934,6 @@ "write" ] }, - { - "type": "string", - "name": "organization_custom_roles", - "description": "

The level of permission to grant the access token for custom roles management.

", - "enum": [ - "read", - "write" - ] - }, { "type": "string", "name": "deployments", @@ -123503,14 +123565,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -127009,131 +127063,48 @@ }, "response": { "statusCode": "200", - "description": "

Response

" - } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "301", - "description": "

Moved permanently

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/rename", - "title": "Rename a branch", - "category": "branches", - "subcategory": "branches", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "new_name", - "in": "body", - "description": "

The new name of the branch.

", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "new_name": "my_renamed_branch" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "201", "contentType": "application/json", "description": "

Response

", "example": { - "name": "master", + "name": "main", "commit": { "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", - "node_id": "MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", "commit": { "author": { "name": "The Octocat", - "date": "2012-03-06T15:06:50-08:00", - "email": "octocat@nowhere.com" + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" }, - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", "tree": { "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" }, - "committer": { - "name": "The Octocat", - "date": "2012-03-06T15:06:50-08:00", - "email": "octocat@nowhere.com" - }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null - }, - "comment_count": 0 + } }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", "gravatar_id": "", - "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", "url": "https://api.github.com/users/octocat", - "id": 583231, - "login": "octocat", - "node_id": "MDQ6VXNlcjE=", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", @@ -127145,26 +127116,15 @@ "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", - "site_admin": true + "site_admin": false }, - "parents": [ - { - "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" - }, - { - "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303" - } - ], - "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", "gravatar_id": "", - "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", "url": "https://api.github.com/users/octocat", - "id": 583231, - "login": "octocat", - "node_id": "MDQ6VXNlcjE=", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", @@ -127176,26 +127136,35 @@ "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", - "site_admin": true + "site_admin": false }, - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] }, "_links": { - "html": "https://github.com/octocat/Hello-World/tree/master", - "self": "https://api.github.com/repos/octocat/Hello-World/branches/master" + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" }, - "protected": true, + "protected": false, "protection": { + "enabled": false, "required_status_checks": { - "enforcement_level": "non_admins", - "contexts": [ - "ci-test", - "linter" - ] + "enforcement_level": "off", + "contexts": [], + "checks": [] } }, - "protection_url": "https://api.github.com/repos/octocat/hello-world/branches/master/protection" + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" }, "schema": { "title": "Branch With Protection", @@ -129866,32 +129835,28 @@ } } ], + "descriptionHTML": "", "previews": [], - "descriptionHTML": "

Renames a branch in a repository.

\n

Note: Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".

\n

The permissions required to use this endpoint depends on whether you are renaming the default branch.

\n

To rename a non-default branch:

\n
    \n
  • Users must have push access.
  • \n
  • GitHub Apps must have the contents:write repository permission.
  • \n
\n

To rename the default branch:

\n
    \n
  • Users must have admin or owner permissions.
  • \n
  • GitHub Apps must have the administration:write repository permission.
  • \n
", "statusCodes": [ { - "httpStatusCode": "201", - "description": "

Created

" + "httpStatusCode": "200", + "description": "

OK

" }, { - "httpStatusCode": "403", - "description": "

Forbidden

" + "httpStatusCode": "301", + "description": "

Moved permanently

" }, { "httpStatusCode": "404", "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/merge-upstream", - "title": "Sync a fork branch with the upstream repository", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/rename", + "title": "Rename a branch", "category": "branches", "subcategory": "branches", "parameters": [ @@ -129912,130 +129877,25 @@ "schema": { "type": "string" } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "branch", - "in": "body", - "description": "

The name of the branch which should be updated to match upstream.

", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "branch": "main" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

The branch has been successfully synced with the upstream repository

", - "example": { - "message": "Successfully fetched and fast-forwarded from upstream defunkt:main", - "merge_type": "fast-forward", - "base_branch": "defunkt:main" - }, - "schema": { - "title": "Merged upstream", - "description": "Results of a successful merge upstream request", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "merge_type": { - "type": "string", - "enum": [ - "merge", - "fast-forward", - "none" - ] - }, - "base_branch": { - "type": "string" - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Sync a branch of a forked repository to keep it up-to-date with the upstream repository.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

The branch has been successfully synced with the upstream repository

" - }, - { - "httpStatusCode": "409", - "description": "

The branch could not be synced because of a merge conflict

" - }, - { - "httpStatusCode": "422", - "description": "

The branch could not be synced for some other reason

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/merges", - "title": "Merge a branch", - "category": "branches", - "subcategory": "branches", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", + "name": "branch", + "description": "

The name of the branch.

", "in": "path", "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true } ], "bodyParameters": [ { "type": "string", - "name": "base", - "in": "body", - "description": "

The name of the base branch that the head will be merged into.

", - "isRequired": true - }, - { - "type": "string", - "name": "head", + "name": "new_name", "in": "body", - "description": "

The head to merge. This can be a branch name or a commit SHA1.

", + "description": "

The new name of the branch.

", "isRequired": true - }, - { - "type": "string", - "name": "commit_message", - "in": "body", - "description": "

Commit message to use for the merge commit. If omitted, a default message will be used.

" } ], "enabledForGitHubApps": true, @@ -130047,153 +129907,129 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "base": "master", - "head": "cool_feature", - "commit_message": "Shipped cool_feature!" + "new_name": "my_renamed_branch" }, "parameters": { "owner": "OWNER", - "repo": "REPO" + "repo": "REPO", + "branch": "BRANCH" } }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "

Successful Response (The resulting merge commit)

", + "description": "

Response

", "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", + "name": "master", "commit": { - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==", + "commit": { + "author": { + "name": "The Octocat", + "date": "2012-03-06T15:06:50-08:00", + "email": "octocat@nowhere.com" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "committer": { + "name": "The Octocat", + "date": "2012-03-06T15:06:50-08:00", + "email": "octocat@nowhere.com" + }, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + }, + "comment_count": 0 + }, "author": { - "name": "Monalisa Octocat", - "email": "mona@github.com", - "date": "2011-04-14T16:00:49Z" + "gravatar_id": "", + "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", + "url": "https://api.github.com/users/octocat", + "id": 583231, + "login": "octocat", + "node_id": "MDQ6VXNlcjE=", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ], + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "committer": { - "name": "Monalisa Octocat", - "email": "mona@github.com", - "date": "2011-04-14T16:00:49Z" - }, - "message": "Fix all the bugs", - "tree": { - "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + "gravatar_id": "", + "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", + "url": "https://api.github.com/users/octocat", + "id": 583231, + "login": "octocat", + "node_id": "MDQ6VXNlcjE=", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true }, - "comment_count": 0, - "verification": { - "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null - } - }, - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" }, - "committer": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "_links": { + "html": "https://github.com/octocat/Hello-World/tree/master", + "self": "https://api.github.com/repos/octocat/Hello-World/branches/master" }, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + "protected": true, + "protection": { + "required_status_checks": { + "enforcement_level": "non_admins", + "contexts": [ + "ci-test", + "linter" + ] } - ], - "stats": { - "additions": 104, - "deletions": 4, - "total": 108 }, - "files": [ - { - "filename": "file1.txt", - "additions": 10, - "deletions": 2, - "changes": 12, - "status": "modified", - "raw_url": "https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", - "blob_url": "https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", - "patch": "@@ -29,7 +29,7 @@\n....." - } - ] + "protection_url": "https://api.github.com/repos/octocat/hello-world/branches/master/protection" }, "schema": { - "title": "Commit", - "description": "Commit", + "title": "Branch With Protection", + "description": "Branch With Protection", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "sha": { - "type": "string", - "examples": [ - "6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" - ] + "name": { + "type": "string" }, "commit": { + "title": "Commit", + "description": "Commit", "type": "object", "properties": { "url": { @@ -130203,35 +130039,345 @@ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, + "sha": { + "type": "string", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + ] + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { + "type": "string", + "examples": [ + "Fix all the bugs" + ] + }, + "comment_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" + ] + } + }, + "required": [ + "sha", + "url" + ] + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "payload": { + "type": [ + "string", + "null" + ] + }, + "signature": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature" + ] + } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, "author": { "anyOf": [ { "type": "null" }, { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", "examples": [ - "\"Chris Wanstrath\"" + "octocat" ] }, - "email": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", "examples": [ - "\"chris@ozmm.org\"" + "MDQ6VXNlcjE=" ] }, - "date": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "\"2007-10-29T02:42:39.000-07:00\"" + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } ] }, @@ -130241,639 +130387,5513 @@ "type": "null" }, { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", "examples": [ - "\"Chris Wanstrath\"" + "octocat" ] }, - "email": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", "examples": [ - "\"chris@ozmm.org\"" + "MDQ6VXNlcjE=" ] }, - "date": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "\"2007-10-29T02:42:39.000-07:00\"" + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } ] }, - "message": { - "type": "string", - "examples": [ - "Fix all the bugs" - ] - }, - "comment_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "tree": { - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "827efc6d56897b048c772eb4087f854f46256132" - ] + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + } }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" - ] - } - }, - "required": [ - "sha", - "url" - ] + "required": [ + "sha", + "url" + ] + } }, - "verification": { - "title": "Verification", + "stats": { "type": "object", "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" + "additions": { + "type": "integer" }, - "payload": { - "type": [ - "string", - "null" - ] + "deletions": { + "type": "integer" }, - "signature": { - "type": [ - "string", - "null" - ] + "total": { + "type": "integer" } - }, - "required": [ - "verified", - "reason", - "payload", - "signature" - ] - } - }, - "required": [ - "author", - "committer", - "comment_count", - "message", - "tree", - "url" - ] - }, - "author": { - "anyOf": [ - { - "type": "null" + } }, - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "files": { + "type": "array", + "items": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" + ] + }, + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "examples": [ + "added" + ] + }, + "additions": { + "type": "integer", + "examples": [ + 103 + ] + }, + "deletions": { + "type": "integer", + "examples": [ + 21 + ] + }, + "changes": { + "type": "integer", + "examples": [ + 124 + ] + }, + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" + ] + } }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + } + } + }, + "required": [ + "url", + "sha", + "node_id", + "html_url", + "comments_url", + "commit", + "author", + "committer", + "parents" + ] + }, + "_links": { + "type": "object", + "properties": { + "html": { + "type": "string" + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "html", + "self" + ] + }, + "protected": { + "type": "boolean" + }, + "protection": { + "title": "Branch Protection", + "description": "Branch Protection", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", + "type": "object", + "properties": { + "url": { + "type": "string" }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "enforcement_level": { + "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "contexts": { + "type": "array", + "items": { + "type": "string" + } }, - "repos_url": { + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": [ + "integer", + "null" + ] + } + }, + "required": [ + "context", + "app_id" + ] + } + }, + "contexts_url": { + "type": "string" + }, + "strict": { + "type": "boolean" + } + }, + "required": [ + "contexts", + "checks" + ] + }, + "enforce_admins": { + "title": "Protected Branch Admin Enforced", + "description": "Protected Branch Admin Enforced", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" ] }, - "events_url": { - "type": "string", + "enabled": { + "type": "boolean", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + true ] - }, - "received_events_url": { + } + }, + "required": [ + "url", + "enabled" + ] + }, + "required_pull_request_reviews": { + "title": "Protected Branch Pull Request Review", + "description": "Protected Branch Pull Request Review", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" ] }, - "site_admin": { - "type": "boolean" + "dismissal_restrictions": { + "type": "object", + "properties": { + "users": { + "description": "The list of users with review dismissal access.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams with review dismissal access.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps with review dismissal access.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" + ] + }, + "users_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" + ] + }, + "teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" + ] + } + } }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "bypass_pull_request_allowances": { + "type": "object", + "description": "Allow specific users, teams, or apps to bypass pull request requirements.", + "properties": { + "users": { + "description": "The list of users allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + } + } + }, + "dismiss_stale_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "require_code_owner_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "required_approving_review_count": { + "type": "integer", + "minimum": 0, + "maximum": 6, + "examples": [ + 2 + ] + } + }, + "required": [ + "dismiss_stale_reviews", + "require_code_owner_reviews" + ] + }, + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "name": { + "type": "string", + "examples": [ + "\"branch/with/protection\"" + ] + }, + "protection_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + } + } + }, + "protection_url": { + "type": "string", + "format": "uri" + }, + "pattern": { + "type": "string", + "examples": [ + "\"mas*\"" + ] + }, + "required_approving_review_count": { + "type": "integer", + "examples": [ + 1 + ] + } + }, + "required": [ + "name", + "commit", + "_links", + "protection", + "protected", + "protection_url" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Renames a branch in a repository.

\n

Note: Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".

\n

The permissions required to use this endpoint depends on whether you are renaming the default branch.

\n

To rename a non-default branch:

\n
    \n
  • Users must have push access.
  • \n
  • GitHub Apps must have the contents:write repository permission.
  • \n
\n

To rename the default branch:

\n
    \n
  • Users must have admin or owner permissions.
  • \n
  • GitHub Apps must have the administration:write repository permission.
  • \n
", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/merge-upstream", + "title": "Sync a fork branch with the upstream repository", + "category": "branches", + "subcategory": "branches", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "branch", + "in": "body", + "description": "

The name of the branch which should be updated to match upstream.

", + "isRequired": true + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "branch": "main" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

The branch has been successfully synced with the upstream repository

", + "example": { + "message": "Successfully fetched and fast-forwarded from upstream defunkt:main", + "merge_type": "fast-forward", + "base_branch": "defunkt:main" + }, + "schema": { + "title": "Merged upstream", + "description": "Results of a successful merge upstream request", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "merge_type": { + "type": "string", + "enum": [ + "merge", + "fast-forward", + "none" + ] + }, + "base_branch": { + "type": "string" + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Sync a branch of a forked repository to keep it up-to-date with the upstream repository.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

The branch has been successfully synced with the upstream repository

" + }, + { + "httpStatusCode": "409", + "description": "

The branch could not be synced because of a merge conflict

" + }, + { + "httpStatusCode": "422", + "description": "

The branch could not be synced for some other reason

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/merges", + "title": "Merge a branch", + "category": "branches", + "subcategory": "branches", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "base", + "in": "body", + "description": "

The name of the base branch that the head will be merged into.

", + "isRequired": true + }, + { + "type": "string", + "name": "head", + "in": "body", + "description": "

The head to merge. This can be a branch name or a commit SHA1.

", + "isRequired": true + }, + { + "type": "string", + "name": "commit_message", + "in": "body", + "description": "

Commit message to use for the merge commit. If omitted, a default message will be used.

" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "base": "master", + "head": "cool_feature", + "commit_message": "Shipped cool_feature!" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Successful Response (The resulting merge commit)

", + "example": { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", + "commit": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "author": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "committer": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "message": "Fix all the bugs", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "comment_count": 0, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + ], + "stats": { + "additions": 104, + "deletions": 4, + "total": 108 + }, + "files": [ + { + "filename": "file1.txt", + "additions": 10, + "deletions": 2, + "changes": 12, + "status": "modified", + "raw_url": "https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", + "blob_url": "https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", + "patch": "@@ -29,7 +29,7 @@\n....." + } + ] + }, + "schema": { + "title": "Commit", + "description": "Commit", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "sha": { + "type": "string", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + ] + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { + "type": "string", + "examples": [ + "Fix all the bugs" + ] + }, + "comment_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" + ] + } + }, + "required": [ + "sha", + "url" + ] + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "payload": { + "type": [ + "string", + "null" + ] + }, + "signature": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature" + ] + } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + } + }, + "required": [ + "sha", + "url" + ] + } + }, + "stats": { + "type": "object", + "properties": { + "additions": { + "type": "integer" + }, + "deletions": { + "type": "integer" + }, + "total": { + "type": "integer" + } + } + }, + "files": { + "type": "array", + "items": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" + ] + }, + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "examples": [ + "added" + ] + }, + "additions": { + "type": "integer", + "examples": [ + 103 + ] + }, + "deletions": { + "type": "integer", + "examples": [ + 21 + ] + }, + "changes": { + "type": "integer", + "examples": [ + 124 + ] + }, + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" + ] + } + }, + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + } + } + }, + "required": [ + "url", + "sha", + "node_id", + "html_url", + "comments_url", + "commit", + "author", + "committer", + "parents" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Successful Response (The resulting merge commit)

" + }, + { + "httpStatusCode": "204", + "description": "

Response when already merged

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Not Found when the base or head does not exist

" + }, + { + "httpStatusCode": "409", + "description": "

Conflict when there is a merge conflict

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed

" + } + ] + } + ], + "branch-protection": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", + "title": "Get branch protection", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts", + "enforcement_level": "non_admins" + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", + "enabled": true + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", + "users": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "apps": [ + { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + } + ] + }, + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2 + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps", + "users": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "apps": [ + { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + } + ] + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + }, + "schema": { + "title": "Branch Protection", + "description": "Branch Protection", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enforcement_level": { + "type": "string" + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + } + }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": [ + "integer", + "null" + ] + } + }, + "required": [ + "context", + "app_id" + ] + } + }, + "contexts_url": { + "type": "string" + }, + "strict": { + "type": "boolean" + } + }, + "required": [ + "contexts", + "checks" + ] + }, + "enforce_admins": { + "title": "Protected Branch Admin Enforced", + "description": "Protected Branch Admin Enforced", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "required_pull_request_reviews": { + "title": "Protected Branch Pull Request Review", + "description": "Protected Branch Pull Request Review", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" + ] + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "users": { + "description": "The list of users with review dismissal access.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams with review dismissal access.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps with review dismissal access.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" + ] + }, + "users_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" + ] + }, + "teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" + ] + } + } + }, + "bypass_pull_request_allowances": { + "type": "object", + "description": "Allow specific users, teams, or apps to bypass pull request requirements.", + "properties": { + "users": { + "description": "The list of users allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + } + }, + "dismiss_stale_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "require_code_owner_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "required_approving_review_count": { + "type": "integer", + "minimum": 0, + "maximum": 6, + "examples": [ + 2 ] } + }, + "required": [ + "dismiss_stale_reviews", + "require_code_owner_reviews" ] }, - "committer": { - "anyOf": [ - { - "type": "null" + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" }, - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" ] }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" - ] - } - }, - "required": [ - "sha", - "url" - ] + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } } }, - "stats": { + "allow_force_pushes": { "type": "object", "properties": { - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "total": { - "type": "integer" + "enabled": { + "type": "boolean" } } }, - "files": { - "type": "array", - "items": { - "title": "Diff Entry", - "description": "Diff Entry", - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "bbcd538c8e72b8c175046e27cc8f907076331401" - ] - }, - "filename": { - "type": "string", - "examples": [ - "file1.txt" - ] - }, - "status": { - "type": "string", - "enum": [ - "added", - "removed", - "modified", - "renamed", - "copied", - "changed", - "unchanged" - ], - "examples": [ - "added" - ] - }, - "additions": { - "type": "integer", - "examples": [ - 103 - ] - }, - "deletions": { - "type": "integer", - "examples": [ - 21 - ] - }, - "changes": { - "type": "integer", - "examples": [ - 124 - ] - }, - "blob_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "raw_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "contents_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "patch": { - "type": "string", - "examples": [ - "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" - ] - }, - "previous_filename": { - "type": "string", - "examples": [ - "file.txt" - ] - } - }, - "required": [ - "additions", - "blob_url", - "changes", - "contents_url", - "deletions", - "filename", - "raw_url", - "sha", - "status" - ] + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } } + }, + "name": { + "type": "string", + "examples": [ + "\"branch/with/protection\"" + ] + }, + "protection_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] } - }, - "required": [ - "url", - "sha", - "node_id", - "html_url", - "comments_url", - "commit", - "author", - "committer", - "parents" - ] + } } } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", "statusCodes": [ { - "httpStatusCode": "201", - "description": "

Successful Response (The resulting merge commit)

" - }, - { - "httpStatusCode": "204", - "description": "

Response when already merged

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" + "httpStatusCode": "200", + "description": "

OK

" }, { "httpStatusCode": "404", - "description": "

Not Found when the base or head does not exist

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict when there is a merge conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed

" + "description": "

Resource not found

" } ] - } - ], - "branch-protection": [ + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", + "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "title": "Get branch protection", + "title": "Update branch protection", "category": "branches", "subcategory": "branch-protection", "parameters": [ @@ -130906,205 +135926,289 @@ "x-multi-segment": true } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "object or null", + "name": "required_status_checks", + "in": "body", + "description": "

Require status checks to pass before merging. Set to null to disable.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "strict", + "description": "

Require branches to be up to date before merging.

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "contexts", + "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "isRequired": true + }, + { + "type": "array of objects", + "name": "checks", + "description": "

The list of status checks to require in order to merge into this branch.

", + "childParamsGroups": [ + { + "type": "string", + "name": "context", + "description": "

The name of the required check

", + "isRequired": true + }, + { + "type": "integer", + "name": "app_id", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" + } + ] + } + ] + }, + { + "type": "boolean or null", + "name": "enforce_admins", + "in": "body", + "description": "

Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "required_pull_request_reviews", + "in": "body", + "description": "

Require at least one approving review on a pull request, before merging. Set to null to disable.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "dismissal_restrictions", + "description": "

Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "users", + "description": "

The list of user logins with dismissal access

" + }, + { + "type": "array of strings", + "name": "teams", + "description": "

The list of team slugs with dismissal access

" + }, + { + "type": "array of strings", + "name": "apps", + "description": "

The list of app slugs with dismissal access

" + } + ] + }, + { + "type": "boolean", + "name": "dismiss_stale_reviews", + "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

" + }, + { + "type": "boolean", + "name": "require_code_owner_reviews", + "description": "

Blocks merging pull requests until code owners review them.

" + }, + { + "type": "integer", + "name": "required_approving_review_count", + "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

" + }, + { + "type": "object", + "name": "bypass_pull_request_allowances", + "description": "

Allow specific users, teams, or apps to bypass pull request requirements.

", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "users", + "description": "

The list of user logins allowed to bypass pull request requirements.

" + }, + { + "type": "array of strings", + "name": "teams", + "description": "

The list of team slugs allowed to bypass pull request requirements.

" + }, + { + "type": "array of strings", + "name": "apps", + "description": "

The list of app slugs allowed to bypass pull request requirements.

" + } + ] + } + ] + }, + { + "type": "object or null", + "name": "restrictions", + "in": "body", + "description": "

Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of strings", + "name": "users", + "description": "

The list of user logins with push access

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "teams", + "description": "

The list of team slugs with push access

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "apps", + "description": "

The list of app slugs with push access

" + } + ] + }, + { + "type": "boolean", + "name": "required_linear_history", + "in": "body", + "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

" + }, + { + "type": "boolean or null", + "name": "allow_force_pushes", + "in": "body", + "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

" + }, + { + "type": "boolean", + "name": "allow_deletions", + "in": "body", + "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

" + }, + { + "type": "boolean", + "name": "block_creations", + "in": "body", + "description": "

If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

" + }, + { + "type": "boolean", + "name": "required_conversation_resolution", + "in": "body", + "description": "

Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

" + } + ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { + "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection", + "bodyParameters": { "required_status_checks": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", + "strict": true, "contexts": [ "continuous-integration/travis-ci" - ], - "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts", - "enforcement_level": "non_admins" - }, - "enforce_admins": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", - "enabled": true + ] }, + "enforce_admins": true, "required_pull_request_reviews": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", "dismissal_restrictions": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", - "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", "users": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } + "octocat" ], "teams": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "apps": [ - { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] - } + "justice-league" ] }, "dismiss_stale_reviews": true, "require_code_owner_reviews": true, - "required_approving_review_count": 2 + "required_approving_review_count": 2, + "bypass_pull_request_allowances": { + "users": [ + "octocat" + ], + "teams": [ + "justice-league" + ] + } }, "restrictions": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", - "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams", - "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps", "users": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } + "octocat" ], "teams": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } + "justice-league" ], "apps": [ + "super-ci" + ] + }, + "required_linear_history": true, + "allow_force_pushes": true, + "allow_deletions": true, + "block_creations": true, + "required_conversation_resolution": true + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] + "context": "continuous-integration/travis-ci", + "app_id": null } ] }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [], + "teams": [], + "apps": [] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [], + "teams": [], + "apps": [] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, "required_linear_history": { "enabled": true }, @@ -131114,37 +136218,48 @@ "allow_deletions": { "enabled": true }, + "block_creations": { + "enabled": true + }, "required_conversation_resolution": { "enabled": true } }, "schema": { - "title": "Branch Protection", - "description": "Branch Protection", + "title": "Protected Branch", + "description": "Branch protections protect branches", "type": "object", "properties": { "url": { - "type": "string" - }, - "enabled": { - "type": "boolean" + "type": "string", + "format": "uri" }, "required_status_checks": { - "title": "Protected Branch Required Status Check", - "description": "Protected Branch Required Status Check", + "title": "Status Check Policy", + "description": "Status Check Policy", "type": "object", "properties": { "url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" + ] }, - "enforcement_level": { - "type": "string" + "strict": { + "type": "boolean", + "examples": [ + true + ] }, "contexts": { "type": "array", "items": { "type": "string" - } + }, + "examples": [ + "continuous-integration/travis-ci" + ] }, "checks": { "type": "array", @@ -131152,7 +136267,10 @@ "type": "object", "properties": { "context": { - "type": "string" + "type": "string", + "examples": [ + "continuous-integration/travis-ci" + ] }, "app_id": { "type": [ @@ -131168,58 +136286,53 @@ } }, "contexts_url": { - "type": "string" - }, - "strict": { - "type": "boolean" - } - }, - "required": [ - "contexts", - "checks" - ] - }, - "enforce_admins": { - "title": "Protected Branch Admin Enforced", - "description": "Protected Branch Admin Enforced", - "type": "object", - "properties": { - "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" - ] - }, - "enabled": { - "type": "boolean", - "examples": [ - true + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" ] } }, "required": [ "url", - "enabled" + "contexts_url", + "strict", + "contexts", + "checks" ] }, "required_pull_request_reviews": { - "title": "Protected Branch Pull Request Review", - "description": "Protected Branch Pull Request Review", "type": "object", "properties": { "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" - ] + "format": "uri" + }, + "dismiss_stale_reviews": { + "type": "boolean" + }, + "require_code_owner_reviews": { + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" }, "dismissal_restrictions": { "type": "object", "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, "users": { - "description": "The list of users with review dismissal access.", "type": "array", "items": { "title": "Simple User", @@ -131384,7 +136497,6 @@ } }, "teams": { - "description": "The list of teams with review dismissal access.", "type": "array", "items": { "title": "Team", @@ -131588,7 +136700,6 @@ } }, "apps": { - "description": "The list of apps with review dismissal access.", "type": "array", "items": { "title": "GitHub app", @@ -131915,33 +137026,20 @@ "events" ] } - }, - "url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" - ] - }, - "users_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" - ] - }, - "teams_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" - ] } - } + }, + "required": [ + "url", + "users_url", + "teams_url", + "users", + "teams" + ] }, "bypass_pull_request_allowances": { "type": "object", - "description": "Allow specific users, teams, or apps to bypass pull request requirements.", "properties": { "users": { - "description": "The list of users allowed to bypass pull request requirements.", "type": "array", "items": { "title": "Simple User", @@ -132106,7 +137204,6 @@ } }, "teams": { - "description": "The list of teams allowed to bypass pull request requirements.", "type": "array", "items": { "title": "Team", @@ -132310,7 +137407,6 @@ } }, "apps": { - "description": "The list of apps allowed to bypass pull request requirements.", "type": "array", "items": { "title": "GitHub app", @@ -132638,32 +137734,90 @@ ] } } - } - }, - "dismiss_stale_reviews": { - "type": "boolean", + }, + "required": [ + "users", + "teams" + ] + } + }, + "required": [ + "url" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", "examples": [ - true + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" ] }, - "require_code_owner_reviews": { + "enabled": { "type": "boolean", "examples": [ true ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "enforce_admins": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" }, - "required_approving_review_count": { - "type": "integer", - "minimum": 0, - "maximum": 6, - "examples": [ - 2 - ] + "enabled": { + "type": "boolean" } }, + "additionalProperties": false, "required": [ - "dismiss_stale_reviews", - "require_code_owner_reviews" + "url", + "enabled" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" ] }, "restrictions": { @@ -132975,29 +138129,14 @@ "apps" ] }, - "required_linear_history": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "allow_force_pushes": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "allow_deletions": { + "required_conversation_resolution": { "type": "object", "properties": { "enabled": { "type": "boolean" } - } + }, + "additionalProperties": false }, "block_creations": { "type": "object", @@ -133005,340 +138144,17 @@ "enabled": { "type": "boolean" } - } - }, - "required_conversation_resolution": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "name": { - "type": "string", - "examples": [ - "\"branch/with/protection\"" - ] - }, - "protection_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" - ] - }, - "required_signatures": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" - ] - }, - "enabled": { - "type": "boolean", - "examples": [ - true - ] - } }, + "additionalProperties": false, "required": [ - "url", "enabled" ] } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "title": "Update branch protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "object or null", - "name": "required_status_checks", - "in": "body", - "description": "

Require status checks to pass before merging. Set to null to disable.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "strict", - "description": "

Require branches to be up to date before merging.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "contexts", - "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "checks", - "description": "

The list of status checks to require in order to merge into this branch.

", - "childParamsGroups": [ - { - "type": "string", - "name": "context", - "description": "

The name of the required check

", - "isRequired": true - }, - { - "type": "integer", - "name": "app_id", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" - } - ] - } - ] - }, - { - "type": "boolean or null", - "name": "enforce_admins", - "in": "body", - "description": "

Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "required_pull_request_reviews", - "in": "body", - "description": "

Require at least one approving review on a pull request, before merging. Set to null to disable.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "dismissal_restrictions", - "description": "

Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "users", - "description": "

The list of user logins with dismissal access

" - }, - { - "type": "array of strings", - "name": "teams", - "description": "

The list of team slugs with dismissal access

" - }, - { - "type": "array of strings", - "name": "apps", - "description": "

The list of app slugs with dismissal access

" - } - ] - }, - { - "type": "boolean", - "name": "dismiss_stale_reviews", - "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

" - }, - { - "type": "boolean", - "name": "require_code_owner_reviews", - "description": "

Blocks merging pull requests until code owners review them.

" - }, - { - "type": "integer", - "name": "required_approving_review_count", - "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

" - }, - { - "type": "object", - "name": "bypass_pull_request_allowances", - "description": "

Allow specific users, teams, or apps to bypass pull request requirements.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "users", - "description": "

The list of user logins allowed to bypass pull request requirements.

" - }, - { - "type": "array of strings", - "name": "teams", - "description": "

The list of team slugs allowed to bypass pull request requirements.

" - }, - { - "type": "array of strings", - "name": "apps", - "description": "

The list of app slugs allowed to bypass pull request requirements.

" - } - ] - } - ] - }, - { - "type": "object or null", - "name": "restrictions", - "in": "body", - "description": "

Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of strings", - "name": "users", - "description": "

The list of user logins with push access

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "teams", - "description": "

The list of team slugs with push access

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "apps", - "description": "

The list of app slugs with push access

" - } - ] - }, - { - "type": "boolean", - "name": "required_linear_history", - "in": "body", - "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

" - }, - { - "type": "boolean or null", - "name": "allow_force_pushes", - "in": "body", - "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

" - }, - { - "type": "boolean", - "name": "allow_deletions", - "in": "body", - "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

" - }, - { - "type": "boolean", - "name": "block_creations", - "in": "body", - "description": "

If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

" - }, - { - "type": "boolean", - "name": "required_conversation_resolution", - "in": "body", - "description": "

Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

" - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "required_status_checks": { - "strict": true, - "contexts": [ - "continuous-integration/travis-ci" - ] - }, - "enforce_admins": true, - "required_pull_request_reviews": { - "dismissal_restrictions": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ] - }, - "dismiss_stale_reviews": true, - "require_code_owner_reviews": true, - "required_approving_review_count": 2, - "bypass_pull_request_allowances": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ] - } - }, - "restrictions": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ], - "apps": [ - "super-ci" - ] }, - "required_linear_history": true, - "allow_force_pushes": true, - "allow_deletions": true, - "block_creations": true, - "required_conversation_resolution": true - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" + "required": [ + "url" + ] } - }, - "response": { - "statusCode": "200", - "description": "

Response

" } } ], @@ -137544,36 +142360,347 @@ } ], "bodyParameters": [ - { - "type": "boolean", - "name": "strict", - "in": "body", - "description": "

Require branches to be up to date before merging.

" - }, + { + "type": "boolean", + "name": "strict", + "in": "body", + "description": "

Require branches to be up to date before merging.

" + }, + { + "type": "array of strings", + "name": "contexts", + "in": "body", + "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

" + }, + { + "type": "array of objects", + "name": "checks", + "in": "body", + "description": "

The list of status checks to require in order to merge into this branch.

", + "childParamsGroups": [ + { + "type": "string", + "name": "context", + "description": "

The name of the required check

", + "isRequired": true + }, + { + "type": "integer", + "name": "app_id", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" + } + ] + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ] + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + }, + "schema": { + "title": "Status Check Policy", + "description": "Status Check Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" + ] + }, + "strict": { + "type": "boolean", + "examples": [ + true + ] + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "continuous-integration/travis-ci" + ] + }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "examples": [ + "continuous-integration/travis-ci" + ] + }, + "app_id": { + "type": [ + "integer", + "null" + ] + } + }, + "required": [ + "context", + "app_id" + ] + } + }, + "contexts_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + ] + } + }, + "required": [ + "url", + "contexts_url", + "strict", + "contexts", + "checks" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + "title": "Remove status check protection", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "title": "Get all status check contexts", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + "continuous-integration/travis-ci" + ], + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "title": "Add status check contexts", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [ { "type": "array of strings", "name": "contexts", "in": "body", - "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

" - }, - { - "type": "array of objects", - "name": "checks", - "in": "body", - "description": "

The list of status checks to require in order to merge into this branch.

", - "childParamsGroups": [ - { - "type": "string", - "name": "context", - "description": "

The name of the required check

", - "isRequired": true - }, - { - "type": "integer", - "name": "app_id", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" - } - ] + "description": "

The name of the status checks

", + "isRequired": true } ], "enabledForGitHubApps": true, @@ -137582,12 +142709,12 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding status checks to a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "strict": true, "contexts": [ - "continuous-integration/travis-ci" + "continuous-integration/travis-ci", + "continuous-integration/jenkins" ] }, "parameters": { @@ -137596,311 +142723,6 @@ "branch": "BRANCH" } }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", - "strict": true, - "contexts": [ - "continuous-integration/travis-ci" - ], - "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" - }, - "schema": { - "title": "Status Check Policy", - "description": "Status Check Policy", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" - ] - }, - "strict": { - "type": "boolean", - "examples": [ - true - ] - }, - "contexts": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "continuous-integration/travis-ci" - ] - }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "examples": [ - "continuous-integration/travis-ci" - ] - }, - "app_id": { - "type": [ - "integer", - "null" - ] - } - }, - "required": [ - "context", - "app_id" - ] - } - }, - "contexts_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" - ] - } - }, - "required": [ - "url", - "contexts_url", - "strict", - "contexts", - "checks" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "title": "Remove status check protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "title": "Get all status check contexts", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - "continuous-integration/travis-ci" - ], - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "title": "Add status check contexts", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "contexts", - "in": "body", - "description": "

contexts parameter

", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, "response": { "statusCode": "200", "contentType": "application/json", @@ -137981,7 +142803,7 @@ "type": "array of strings", "name": "contexts", "in": "body", - "description": "

contexts parameter

", + "description": "

The name of the status checks

", "isRequired": true } ], @@ -137991,8 +142813,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example updating status checks for a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -138074,7 +142901,7 @@ "type": "array of strings", "name": "contexts", "in": "body", - "description": "

contexts parameter

", + "description": "

The name of the status checks

", "isRequired": true } ], @@ -138084,8 +142911,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing status checks from a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -140779,7 +145611,7 @@ "type": "array of strings", "name": "teams", "in": "body", - "description": "

teams parameter

", + "description": "

The slug values for teams

", "isRequired": true } ], @@ -140789,8 +145621,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -141078,7 +145915,7 @@ "type": "array of strings", "name": "teams", "in": "body", - "description": "

teams parameter

", + "description": "

The slug values for teams

", "isRequired": true } ], @@ -141088,8 +145925,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -141377,7 +146219,7 @@ "type": "array of strings", "name": "teams", "in": "body", - "description": "

teams parameter

", + "description": "

The slug values for teams

", "isRequired": true } ], @@ -141387,8 +146229,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -141933,7 +146780,7 @@ "type": "array of strings", "name": "users", "in": "body", - "description": "

users parameter

", + "description": "

The username for users

", "isRequired": true } ], @@ -141943,8 +146790,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -142199,7 +147051,7 @@ "type": "array of strings", "name": "users", "in": "body", - "description": "

users parameter

", + "description": "

The username for users

", "isRequired": true } ], @@ -142209,8 +147061,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -142465,7 +147322,7 @@ "type": "array of strings", "name": "users", "in": "body", - "description": "

users parameter

", + "description": "

The username for users

", "isRequired": true } ], @@ -142475,8 +147332,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -153602,6 +158464,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -156674,6 +161540,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -159264,6 +164134,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -162273,6 +167147,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -165389,6 +170267,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -166446,6 +171328,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -167933,7 +172822,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -168275,6 +173165,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -168554,7 +173451,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -168896,6 +173794,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -169135,6 +174040,7 @@ "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "state": "open", "fixed_at": null, "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", @@ -169986,7 +174892,7 @@ "description": "

Service unavailable

" } ], - "descriptionHTML": "

Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the repo scope. For public repositories,\nyou must use an access token with public_repo scope.\nGitHub Apps must have the security_events write permission to use this endpoint.

\n

You can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.

\n

When you list the analyses for a repository,\none or more will be identified as deletable in the response:

\n
\"deletable\": true\n
\n

An analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:

\n
    \n
  • ref
  • \n
  • tool
  • \n
  • analysis_key
  • \n
  • environment
  • \n
\n

If you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:

\n
Analysis specified is not deletable.\n
\n

The response from a successful DELETE operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\nnext_analysis_url and confirm_delete_url.\nUse the next_analysis_url URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the confirm_delete_url URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of next_analysis_url and confirm_delete_url\nin the 200 response is null.

\n

As an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:

\n

Outer loop:

\n
    \n
  • \n

    List the analyses for the repository, filtered by tool.

    \n
  • \n
  • \n

    Parse this list to find a deletable analysis. If found:

    \n

    Inner loop:

    \n
      \n
    • Delete the identified analysis.
    • \n
    • Parse the response for the value of confirm_delete_url and, if found, use this in the next iteration.
    • \n
    \n
  • \n
\n

The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url value. Alternatively, you could use the next_analysis_url value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.

", + "descriptionHTML": "

Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the repo scope. For public repositories,\nyou must use an access token with public_repo scope.\nGitHub Apps must have the security_events write permission to use this endpoint.

\n

You can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.

\n

When you list the analyses for a repository,\none or more will be identified as deletable in the response:

\n
\"deletable\": true\n
\n

An analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:

\n
    \n
  • ref
  • \n
  • tool
  • \n
  • category
  • \n
\n

If you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:

\n
Analysis specified is not deletable.\n
\n

The response from a successful DELETE operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\nnext_analysis_url and confirm_delete_url.\nUse the next_analysis_url URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the confirm_delete_url URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of next_analysis_url and confirm_delete_url\nin the 200 response is null.

\n

As an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:

\n

Outer loop:

\n
    \n
  • \n

    List the analyses for the repository, filtered by tool.

    \n
  • \n
  • \n

    Parse this list to find a deletable analysis. If found:

    \n

    Inner loop:

    \n
      \n
    • Delete the identified analysis.
    • \n
    • Parse the response for the value of confirm_delete_url and, if found, use this in the next iteration.
    • \n
    \n
  • \n
\n

The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url value. Alternatively, you could use the next_analysis_url value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.

", "subcategory": "code-scanning" }, { @@ -172924,6 +177830,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -176025,6 +180935,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -176716,8 +181630,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example request body", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permissions": "write" + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -178744,6 +183661,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -181501,6 +186422,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -186594,6 +191519,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -188157,6 +193086,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -189670,6 +194603,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ] }, @@ -192251,6 +197188,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ] } @@ -196587,6 +201528,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -200128,6 +205073,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -218414,14 +223363,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -219644,14 +224585,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -220439,14 +225372,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -238069,6 +242994,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -241488,6 +246417,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -242324,7 +247257,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ], "schema": { @@ -244824,6 +249758,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -245600,7 +250538,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -248097,6 +253036,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -248840,7 +253783,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -251337,6 +256281,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -251932,6 +256880,12 @@ "closed" ] }, + { + "type": "string or null", + "name": "state_reason", + "in": "body", + "description": "

The reason for the current state

" + }, { "type": "null or string or integer or string or integer", "name": "milestone", @@ -252136,7 +257090,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -254633,6 +259588,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -258222,6 +263181,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -259304,7 +264267,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -261801,6 +266765,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -262538,7 +267506,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -265035,6 +270004,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -269666,7 +274639,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ], @@ -272395,6 +277369,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -274529,7 +279507,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } }, "schema": { @@ -277255,6 +282234,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -304744,6 +309727,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -312217,6 +317204,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -314129,6 +319120,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -316013,6 +321008,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -317877,6 +322876,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -319788,6 +324791,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -322035,6 +327042,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -323372,14 +328383,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -324248,14 +329251,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -325139,14 +330134,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -325942,14 +330929,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -326837,14 +331816,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -327641,14 +332612,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -328474,14 +333437,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -329349,14 +334304,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -332021,14 +336968,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -332962,7 +337901,7 @@ } ], "previews": [], - "descriptionHTML": "

List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.

\n

For more information on custom repository roles, see \"Managing custom repository roles for an organization\".

", + "descriptionHTML": "

List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.

\n

To use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with admin:org repo scope.\nGitHub Apps must have the organization_custom_roles:read organization permission to use this endpoint.

\n

For more information on custom repository roles, see \"Managing custom repository roles for an organization\".

", "statusCodes": [ { "httpStatusCode": "200", @@ -333249,10 +338188,6 @@ "httpStatusCode": "200", "description": "

OK

" }, - { - "httpStatusCode": "302", - "description": "

Response if requester is not an organization member

" - }, { "httpStatusCode": "422", "description": "

Validation failed

" @@ -350050,6 +354985,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -351613,6 +356552,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -359930,6 +364873,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ], "subcategory": "pulls" @@ -364835,6 +369782,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ], "subcategory": "pulls" @@ -372989,6 +377940,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -374552,6 +379507,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -378505,6 +383464,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -380068,6 +385031,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -401540,6 +406507,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -403417,6 +408388,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -406013,6 +410988,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -407673,6 +412652,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -409047,6 +414030,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -412052,6 +417039,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -413712,6 +418703,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -415086,6 +420081,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -418934,6 +423933,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -420673,6 +425676,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -420754,7 +425761,7 @@ } } ], - "descriptionHTML": "

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

\n

OAuth scope requirements

\n

When using OAuth, authorizations must include:

\n
    \n
  • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
  • \n
  • repo scope to create a private repository
  • \n
", + "descriptionHTML": "

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

\n

OAuth scope requirements

\n

When using OAuth, authorizations must include:

\n
    \n
  • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
  • \n
  • repo scope to create a private repository
  • \n
", "statusCodes": [ { "httpStatusCode": "201", @@ -422772,6 +427779,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -424578,6 +429589,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -426286,6 +431301,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -428490,6 +433509,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -428885,6 +433908,13 @@ "in": "body", "description": "

The URL must contain <num> for the reference number.

", "isRequired": true + }, + { + "type": "boolean", + "name": "is_alphanumeric", + "in": "body", + "description": "

Whether this autolink reference matches alphanumeric characters. If true, the <num> parameter of the url_template matches alphanumeric characters A-Z (case insensitive), 0-9, and -. If false, this autolink reference only matches numeric characters.

", + "default": "true" } ], "enabledForGitHubApps": true, @@ -428897,7 +433927,8 @@ "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=" + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true }, "parameters": { "owner": "OWNER", @@ -434562,6 +439593,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -437317,6 +442352,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -438977,6 +444016,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -440351,6 +445394,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -443150,6 +448197,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -445955,6 +451006,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -446448,7 +451503,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] }, @@ -448804,6 +453860,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -460284,6 +465344,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -462886,6 +467950,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -468709,6 +473777,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -471305,6 +476377,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ diff --git a/lib/rest/static/decorated/ghes-3.6.json b/lib/rest/static/decorated/ghes-3.6.json index 6c3384f9c569..36e90a37d5c1 100644 --- a/lib/rest/static/decorated/ghes-3.6.json +++ b/lib/rest/static/decorated/ghes-3.6.json @@ -4035,6 +4035,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -7880,6 +7884,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -13956,6 +13964,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -16610,6 +16622,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -18171,6 +18187,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -20963,6 +20983,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -22524,6 +22548,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -25342,6 +25370,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -26913,6 +26945,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -32600,6 +32636,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -34804,6 +34844,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -38070,6 +38114,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -40274,6 +40322,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -43967,6 +44019,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -46171,6 +46227,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -51351,6 +51411,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -53555,6 +53619,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -57274,6 +57342,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -61308,6 +61380,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -65336,6 +65412,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -69358,6 +69438,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -73370,6 +73454,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -77403,6 +77491,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -81415,6 +81507,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -85438,6 +85534,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -89461,6 +89561,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -93102,6 +93206,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -95599,6 +95707,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -98458,6 +98570,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -101274,6 +101390,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -102881,6 +103001,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -104798,6 +104922,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -106262,6 +106390,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -109043,6 +109175,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -111432,6 +111568,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -113005,14 +113145,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -113934,14 +114066,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -114556,15 +114680,6 @@ "write" ] }, - { - "type": "string", - "name": "organization_custom_roles", - "description": "

The level of permission to grant the access token for custom roles management.

", - "enum": [ - "read", - "write" - ] - }, { "type": "string", "name": "deployments", @@ -115007,14 +115122,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -116617,6 +116724,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -117717,14 +117828,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -118650,14 +118753,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -119581,14 +119676,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -121622,6 +121709,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -122275,14 +122366,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -124353,6 +124436,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -125061,14 +125148,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -125932,14 +126011,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -126571,15 +126642,6 @@ "write" ] }, - { - "type": "string", - "name": "organization_custom_roles", - "description": "

The level of permission to grant the access token for custom roles management.

", - "enum": [ - "read", - "write" - ] - }, { "type": "string", "name": "deployments", @@ -127211,14 +127273,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -130717,131 +130771,48 @@ }, "response": { "statusCode": "200", - "description": "

Response

" - } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "301", - "description": "

Moved permanently

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/rename", - "title": "Rename a branch", - "category": "branches", - "subcategory": "branches", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "new_name", - "in": "body", - "description": "

The new name of the branch.

", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "new_name": "my_renamed_branch" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "201", "contentType": "application/json", "description": "

Response

", "example": { - "name": "master", + "name": "main", "commit": { "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", - "node_id": "MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", "commit": { "author": { "name": "The Octocat", - "date": "2012-03-06T15:06:50-08:00", - "email": "octocat@nowhere.com" + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" }, - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", "tree": { "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" }, - "committer": { - "name": "The Octocat", - "date": "2012-03-06T15:06:50-08:00", - "email": "octocat@nowhere.com" - }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null - }, - "comment_count": 0 + } }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", "gravatar_id": "", - "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", "url": "https://api.github.com/users/octocat", - "id": 583231, - "login": "octocat", - "node_id": "MDQ6VXNlcjE=", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", @@ -130853,26 +130824,15 @@ "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", - "site_admin": true + "site_admin": false }, - "parents": [ - { - "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" - }, - { - "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", - "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303" - } - ], - "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", "gravatar_id": "", - "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", "url": "https://api.github.com/users/octocat", - "id": 583231, - "login": "octocat", - "node_id": "MDQ6VXNlcjE=", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", @@ -130884,26 +130844,35 @@ "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", - "site_admin": true + "site_admin": false }, - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] }, "_links": { - "html": "https://github.com/octocat/Hello-World/tree/master", - "self": "https://api.github.com/repos/octocat/Hello-World/branches/master" + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" }, - "protected": true, + "protected": false, "protection": { + "enabled": false, "required_status_checks": { - "enforcement_level": "non_admins", - "contexts": [ - "ci-test", - "linter" - ] + "enforcement_level": "off", + "contexts": [], + "checks": [] } }, - "protection_url": "https://api.github.com/repos/octocat/hello-world/branches/master/protection" + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" }, "schema": { "title": "Branch With Protection", @@ -133574,32 +133543,28 @@ } } ], + "descriptionHTML": "", "previews": [], - "descriptionHTML": "

Renames a branch in a repository.

\n

Note: Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".

\n

The permissions required to use this endpoint depends on whether you are renaming the default branch.

\n

To rename a non-default branch:

\n
    \n
  • Users must have push access.
  • \n
  • GitHub Apps must have the contents:write repository permission.
  • \n
\n

To rename the default branch:

\n
    \n
  • Users must have admin or owner permissions.
  • \n
  • GitHub Apps must have the administration:write repository permission.
  • \n
", "statusCodes": [ { - "httpStatusCode": "201", - "description": "

Created

" + "httpStatusCode": "200", + "description": "

OK

" }, { - "httpStatusCode": "403", - "description": "

Forbidden

" + "httpStatusCode": "301", + "description": "

Moved permanently

" }, { "httpStatusCode": "404", "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/merge-upstream", - "title": "Sync a fork branch with the upstream repository", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/rename", + "title": "Rename a branch", "category": "branches", "subcategory": "branches", "parameters": [ @@ -133620,130 +133585,25 @@ "schema": { "type": "string" } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "branch", - "in": "body", - "description": "

The name of the branch which should be updated to match upstream.

", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "branch": "main" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

The branch has been successfully synced with the upstream repository

", - "example": { - "message": "Successfully fetched and fast-forwarded from upstream defunkt:main", - "merge_type": "fast-forward", - "base_branch": "defunkt:main" - }, - "schema": { - "title": "Merged upstream", - "description": "Results of a successful merge upstream request", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "merge_type": { - "type": "string", - "enum": [ - "merge", - "fast-forward", - "none" - ] - }, - "base_branch": { - "type": "string" - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Sync a branch of a forked repository to keep it up-to-date with the upstream repository.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

The branch has been successfully synced with the upstream repository

" - }, - { - "httpStatusCode": "409", - "description": "

The branch could not be synced because of a merge conflict

" - }, - { - "httpStatusCode": "422", - "description": "

The branch could not be synced for some other reason

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/merges", - "title": "Merge a branch", - "category": "branches", - "subcategory": "branches", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", + "name": "branch", + "description": "

The name of the branch.

", "in": "path", "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true } ], "bodyParameters": [ { "type": "string", - "name": "base", - "in": "body", - "description": "

The name of the base branch that the head will be merged into.

", - "isRequired": true - }, - { - "type": "string", - "name": "head", + "name": "new_name", "in": "body", - "description": "

The head to merge. This can be a branch name or a commit SHA1.

", + "description": "

The new name of the branch.

", "isRequired": true - }, - { - "type": "string", - "name": "commit_message", - "in": "body", - "description": "

Commit message to use for the merge commit. If omitted, a default message will be used.

" } ], "enabledForGitHubApps": true, @@ -133755,153 +133615,129 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "base": "master", - "head": "cool_feature", - "commit_message": "Shipped cool_feature!" + "new_name": "my_renamed_branch" }, "parameters": { "owner": "OWNER", - "repo": "REPO" + "repo": "REPO", + "branch": "BRANCH" } }, "response": { "statusCode": "201", "contentType": "application/json", - "description": "

Successful Response (The resulting merge commit)

", + "description": "

Response

", "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", + "name": "master", "commit": { - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==", + "commit": { + "author": { + "name": "The Octocat", + "date": "2012-03-06T15:06:50-08:00", + "email": "octocat@nowhere.com" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "committer": { + "name": "The Octocat", + "date": "2012-03-06T15:06:50-08:00", + "email": "octocat@nowhere.com" + }, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + }, + "comment_count": 0 + }, "author": { - "name": "Monalisa Octocat", - "email": "mona@github.com", - "date": "2011-04-14T16:00:49Z" + "gravatar_id": "", + "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", + "url": "https://api.github.com/users/octocat", + "id": 583231, + "login": "octocat", + "node_id": "MDQ6VXNlcjE=", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ], + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", "committer": { - "name": "Monalisa Octocat", - "email": "mona@github.com", - "date": "2011-04-14T16:00:49Z" - }, - "message": "Fix all the bugs", - "tree": { - "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + "gravatar_id": "", + "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", + "url": "https://api.github.com/users/octocat", + "id": 583231, + "login": "octocat", + "node_id": "MDQ6VXNlcjE=", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true }, - "comment_count": 0, - "verification": { - "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null - } - }, - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" }, - "committer": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "_links": { + "html": "https://github.com/octocat/Hello-World/tree/master", + "self": "https://api.github.com/repos/octocat/Hello-World/branches/master" }, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + "protected": true, + "protection": { + "required_status_checks": { + "enforcement_level": "non_admins", + "contexts": [ + "ci-test", + "linter" + ] } - ], - "stats": { - "additions": 104, - "deletions": 4, - "total": 108 }, - "files": [ - { - "filename": "file1.txt", - "additions": 10, - "deletions": 2, - "changes": 12, - "status": "modified", - "raw_url": "https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", - "blob_url": "https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", - "patch": "@@ -29,7 +29,7 @@\n....." - } - ] + "protection_url": "https://api.github.com/repos/octocat/hello-world/branches/master/protection" }, "schema": { - "title": "Commit", - "description": "Commit", + "title": "Branch With Protection", + "description": "Branch With Protection", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "sha": { - "type": "string", - "examples": [ - "6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" - ] + "name": { + "type": "string" }, "commit": { + "title": "Commit", + "description": "Commit", "type": "object", "properties": { "url": { @@ -133911,35 +133747,345 @@ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, + "sha": { + "type": "string", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + ] + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { + "type": "string", + "examples": [ + "Fix all the bugs" + ] + }, + "comment_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" + ] + } + }, + "required": [ + "sha", + "url" + ] + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "payload": { + "type": [ + "string", + "null" + ] + }, + "signature": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature" + ] + } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, "author": { "anyOf": [ { "type": "null" }, { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", "examples": [ - "\"Chris Wanstrath\"" + "octocat" ] }, - "email": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", "examples": [ - "\"chris@ozmm.org\"" + "MDQ6VXNlcjE=" ] }, - "date": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "\"2007-10-29T02:42:39.000-07:00\"" + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } ] }, @@ -133949,639 +134095,5513 @@ "type": "null" }, { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", "examples": [ - "\"Chris Wanstrath\"" + "octocat" ] }, - "email": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", "examples": [ - "\"chris@ozmm.org\"" + "MDQ6VXNlcjE=" ] }, - "date": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "\"2007-10-29T02:42:39.000-07:00\"" + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } ] }, - "message": { - "type": "string", - "examples": [ - "Fix all the bugs" - ] - }, - "comment_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "tree": { - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "827efc6d56897b048c772eb4087f854f46256132" - ] + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + } }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" - ] - } - }, - "required": [ - "sha", - "url" - ] + "required": [ + "sha", + "url" + ] + } }, - "verification": { - "title": "Verification", + "stats": { "type": "object", "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" + "additions": { + "type": "integer" }, - "payload": { - "type": [ - "string", - "null" - ] + "deletions": { + "type": "integer" }, - "signature": { - "type": [ - "string", - "null" - ] + "total": { + "type": "integer" } - }, - "required": [ - "verified", - "reason", - "payload", - "signature" - ] - } - }, - "required": [ - "author", - "committer", - "comment_count", - "message", - "tree", - "url" - ] - }, - "author": { - "anyOf": [ - { - "type": "null" + } }, - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "files": { + "type": "array", + "items": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" + ] + }, + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "examples": [ + "added" + ] + }, + "additions": { + "type": "integer", + "examples": [ + 103 + ] + }, + "deletions": { + "type": "integer", + "examples": [ + 21 + ] + }, + "changes": { + "type": "integer", + "examples": [ + 124 + ] + }, + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" + ] + } }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + } + } + }, + "required": [ + "url", + "sha", + "node_id", + "html_url", + "comments_url", + "commit", + "author", + "committer", + "parents" + ] + }, + "_links": { + "type": "object", + "properties": { + "html": { + "type": "string" + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "html", + "self" + ] + }, + "protected": { + "type": "boolean" + }, + "protection": { + "title": "Branch Protection", + "description": "Branch Protection", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", + "type": "object", + "properties": { + "url": { + "type": "string" }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "enforcement_level": { + "type": "string" }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "contexts": { + "type": "array", + "items": { + "type": "string" + } }, - "repos_url": { + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": [ + "integer", + "null" + ] + } + }, + "required": [ + "context", + "app_id" + ] + } + }, + "contexts_url": { + "type": "string" + }, + "strict": { + "type": "boolean" + } + }, + "required": [ + "contexts", + "checks" + ] + }, + "enforce_admins": { + "title": "Protected Branch Admin Enforced", + "description": "Protected Branch Admin Enforced", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" ] }, - "events_url": { - "type": "string", + "enabled": { + "type": "boolean", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + true ] - }, - "received_events_url": { + } + }, + "required": [ + "url", + "enabled" + ] + }, + "required_pull_request_reviews": { + "title": "Protected Branch Pull Request Review", + "description": "Protected Branch Pull Request Review", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" ] }, - "site_admin": { - "type": "boolean" + "dismissal_restrictions": { + "type": "object", + "properties": { + "users": { + "description": "The list of users with review dismissal access.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams with review dismissal access.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps with review dismissal access.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" + ] + }, + "users_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" + ] + }, + "teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" + ] + } + } }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "bypass_pull_request_allowances": { + "type": "object", + "description": "Allow specific users, teams, or apps to bypass pull request requirements.", + "properties": { + "users": { + "description": "The list of users allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + } + } + }, + "dismiss_stale_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "require_code_owner_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "required_approving_review_count": { + "type": "integer", + "minimum": 0, + "maximum": 6, + "examples": [ + 2 + ] + } + }, + "required": [ + "dismiss_stale_reviews", + "require_code_owner_reviews" + ] + }, + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "name": { + "type": "string", + "examples": [ + "\"branch/with/protection\"" + ] + }, + "protection_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + } + } + }, + "protection_url": { + "type": "string", + "format": "uri" + }, + "pattern": { + "type": "string", + "examples": [ + "\"mas*\"" + ] + }, + "required_approving_review_count": { + "type": "integer", + "examples": [ + 1 + ] + } + }, + "required": [ + "name", + "commit", + "_links", + "protection", + "protected", + "protection_url" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Renames a branch in a repository.

\n

Note: Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".

\n

The permissions required to use this endpoint depends on whether you are renaming the default branch.

\n

To rename a non-default branch:

\n
    \n
  • Users must have push access.
  • \n
  • GitHub Apps must have the contents:write repository permission.
  • \n
\n

To rename the default branch:

\n
    \n
  • Users must have admin or owner permissions.
  • \n
  • GitHub Apps must have the administration:write repository permission.
  • \n
", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/merge-upstream", + "title": "Sync a fork branch with the upstream repository", + "category": "branches", + "subcategory": "branches", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "branch", + "in": "body", + "description": "

The name of the branch which should be updated to match upstream.

", + "isRequired": true + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "branch": "main" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

The branch has been successfully synced with the upstream repository

", + "example": { + "message": "Successfully fetched and fast-forwarded from upstream defunkt:main", + "merge_type": "fast-forward", + "base_branch": "defunkt:main" + }, + "schema": { + "title": "Merged upstream", + "description": "Results of a successful merge upstream request", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "merge_type": { + "type": "string", + "enum": [ + "merge", + "fast-forward", + "none" + ] + }, + "base_branch": { + "type": "string" + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Sync a branch of a forked repository to keep it up-to-date with the upstream repository.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

The branch has been successfully synced with the upstream repository

" + }, + { + "httpStatusCode": "409", + "description": "

The branch could not be synced because of a merge conflict

" + }, + { + "httpStatusCode": "422", + "description": "

The branch could not be synced for some other reason

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/merges", + "title": "Merge a branch", + "category": "branches", + "subcategory": "branches", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "base", + "in": "body", + "description": "

The name of the base branch that the head will be merged into.

", + "isRequired": true + }, + { + "type": "string", + "name": "head", + "in": "body", + "description": "

The head to merge. This can be a branch name or a commit SHA1.

", + "isRequired": true + }, + { + "type": "string", + "name": "commit_message", + "in": "body", + "description": "

Commit message to use for the merge commit. If omitted, a default message will be used.

" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "base": "master", + "head": "cool_feature", + "commit_message": "Shipped cool_feature!" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Successful Response (The resulting merge commit)

", + "example": { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", + "commit": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "author": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "committer": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "message": "Fix all the bugs", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "comment_count": 0, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + ], + "stats": { + "additions": 104, + "deletions": 4, + "total": 108 + }, + "files": [ + { + "filename": "file1.txt", + "additions": 10, + "deletions": 2, + "changes": 12, + "status": "modified", + "raw_url": "https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", + "blob_url": "https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", + "patch": "@@ -29,7 +29,7 @@\n....." + } + ] + }, + "schema": { + "title": "Commit", + "description": "Commit", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "sha": { + "type": "string", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + ] + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { + "type": "string", + "examples": [ + "Fix all the bugs" + ] + }, + "comment_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" + ] + } + }, + "required": [ + "sha", + "url" + ] + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "payload": { + "type": [ + "string", + "null" + ] + }, + "signature": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature" + ] + } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + } + }, + "required": [ + "sha", + "url" + ] + } + }, + "stats": { + "type": "object", + "properties": { + "additions": { + "type": "integer" + }, + "deletions": { + "type": "integer" + }, + "total": { + "type": "integer" + } + } + }, + "files": { + "type": "array", + "items": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" + ] + }, + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "examples": [ + "added" + ] + }, + "additions": { + "type": "integer", + "examples": [ + 103 + ] + }, + "deletions": { + "type": "integer", + "examples": [ + 21 + ] + }, + "changes": { + "type": "integer", + "examples": [ + 124 + ] + }, + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" + ] + } + }, + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + } + } + }, + "required": [ + "url", + "sha", + "node_id", + "html_url", + "comments_url", + "commit", + "author", + "committer", + "parents" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Successful Response (The resulting merge commit)

" + }, + { + "httpStatusCode": "204", + "description": "

Response when already merged

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Not Found when the base or head does not exist

" + }, + { + "httpStatusCode": "409", + "description": "

Conflict when there is a merge conflict

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed

" + } + ] + } + ], + "branch-protection": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", + "title": "Get branch protection", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts", + "enforcement_level": "non_admins" + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", + "enabled": true + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", + "users": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "apps": [ + { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + } + ] + }, + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2 + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps", + "users": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "apps": [ + { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + } + ] + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + }, + "schema": { + "title": "Branch Protection", + "description": "Branch Protection", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enforcement_level": { + "type": "string" + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + } + }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": [ + "integer", + "null" + ] + } + }, + "required": [ + "context", + "app_id" + ] + } + }, + "contexts_url": { + "type": "string" + }, + "strict": { + "type": "boolean" + } + }, + "required": [ + "contexts", + "checks" + ] + }, + "enforce_admins": { + "title": "Protected Branch Admin Enforced", + "description": "Protected Branch Admin Enforced", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "required_pull_request_reviews": { + "title": "Protected Branch Pull Request Review", + "description": "Protected Branch Pull Request Review", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" + ] + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "users": { + "description": "The list of users with review dismissal access.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams with review dismissal access.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps with review dismissal access.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" + ] + }, + "users_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" + ] + }, + "teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" + ] + } + } + }, + "bypass_pull_request_allowances": { + "type": "object", + "description": "Allow specific users, teams, or apps to bypass pull request requirements.", + "properties": { + "users": { + "description": "The list of users allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + } + }, + "dismiss_stale_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "require_code_owner_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "required_approving_review_count": { + "type": "integer", + "minimum": 0, + "maximum": 6, + "examples": [ + 2 ] } + }, + "required": [ + "dismiss_stale_reviews", + "require_code_owner_reviews" ] }, - "committer": { - "anyOf": [ - { - "type": "null" + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" }, - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" ] }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" - ] - } - }, - "required": [ - "sha", - "url" - ] + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } } }, - "stats": { + "allow_force_pushes": { "type": "object", "properties": { - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "total": { - "type": "integer" + "enabled": { + "type": "boolean" } } }, - "files": { - "type": "array", - "items": { - "title": "Diff Entry", - "description": "Diff Entry", - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "bbcd538c8e72b8c175046e27cc8f907076331401" - ] - }, - "filename": { - "type": "string", - "examples": [ - "file1.txt" - ] - }, - "status": { - "type": "string", - "enum": [ - "added", - "removed", - "modified", - "renamed", - "copied", - "changed", - "unchanged" - ], - "examples": [ - "added" - ] - }, - "additions": { - "type": "integer", - "examples": [ - 103 - ] - }, - "deletions": { - "type": "integer", - "examples": [ - 21 - ] - }, - "changes": { - "type": "integer", - "examples": [ - 124 - ] - }, - "blob_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "raw_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "contents_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "patch": { - "type": "string", - "examples": [ - "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" - ] - }, - "previous_filename": { - "type": "string", - "examples": [ - "file.txt" - ] - } - }, - "required": [ - "additions", - "blob_url", - "changes", - "contents_url", - "deletions", - "filename", - "raw_url", - "sha", - "status" - ] + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } } + }, + "name": { + "type": "string", + "examples": [ + "\"branch/with/protection\"" + ] + }, + "protection_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] } - }, - "required": [ - "url", - "sha", - "node_id", - "html_url", - "comments_url", - "commit", - "author", - "committer", - "parents" - ] + } } } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", "statusCodes": [ { - "httpStatusCode": "201", - "description": "

Successful Response (The resulting merge commit)

" - }, - { - "httpStatusCode": "204", - "description": "

Response when already merged

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" + "httpStatusCode": "200", + "description": "

OK

" }, { "httpStatusCode": "404", - "description": "

Not Found when the base or head does not exist

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict when there is a merge conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed

" + "description": "

Resource not found

" } ] - } - ], - "branch-protection": [ + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", + "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "title": "Get branch protection", + "title": "Update branch protection", "category": "branches", "subcategory": "branch-protection", "parameters": [ @@ -134614,205 +139634,289 @@ "x-multi-segment": true } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "object or null", + "name": "required_status_checks", + "in": "body", + "description": "

Require status checks to pass before merging. Set to null to disable.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "strict", + "description": "

Require branches to be up to date before merging.

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "contexts", + "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "isRequired": true + }, + { + "type": "array of objects", + "name": "checks", + "description": "

The list of status checks to require in order to merge into this branch.

", + "childParamsGroups": [ + { + "type": "string", + "name": "context", + "description": "

The name of the required check

", + "isRequired": true + }, + { + "type": "integer", + "name": "app_id", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" + } + ] + } + ] + }, + { + "type": "boolean or null", + "name": "enforce_admins", + "in": "body", + "description": "

Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "required_pull_request_reviews", + "in": "body", + "description": "

Require at least one approving review on a pull request, before merging. Set to null to disable.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "dismissal_restrictions", + "description": "

Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "users", + "description": "

The list of user logins with dismissal access

" + }, + { + "type": "array of strings", + "name": "teams", + "description": "

The list of team slugs with dismissal access

" + }, + { + "type": "array of strings", + "name": "apps", + "description": "

The list of app slugs with dismissal access

" + } + ] + }, + { + "type": "boolean", + "name": "dismiss_stale_reviews", + "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

" + }, + { + "type": "boolean", + "name": "require_code_owner_reviews", + "description": "

Blocks merging pull requests until code owners review them.

" + }, + { + "type": "integer", + "name": "required_approving_review_count", + "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

" + }, + { + "type": "object", + "name": "bypass_pull_request_allowances", + "description": "

Allow specific users, teams, or apps to bypass pull request requirements.

", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "users", + "description": "

The list of user logins allowed to bypass pull request requirements.

" + }, + { + "type": "array of strings", + "name": "teams", + "description": "

The list of team slugs allowed to bypass pull request requirements.

" + }, + { + "type": "array of strings", + "name": "apps", + "description": "

The list of app slugs allowed to bypass pull request requirements.

" + } + ] + } + ] + }, + { + "type": "object or null", + "name": "restrictions", + "in": "body", + "description": "

Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of strings", + "name": "users", + "description": "

The list of user logins with push access

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "teams", + "description": "

The list of team slugs with push access

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "apps", + "description": "

The list of app slugs with push access

" + } + ] + }, + { + "type": "boolean", + "name": "required_linear_history", + "in": "body", + "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

" + }, + { + "type": "boolean or null", + "name": "allow_force_pushes", + "in": "body", + "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

" + }, + { + "type": "boolean", + "name": "allow_deletions", + "in": "body", + "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

" + }, + { + "type": "boolean", + "name": "block_creations", + "in": "body", + "description": "

If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

" + }, + { + "type": "boolean", + "name": "required_conversation_resolution", + "in": "body", + "description": "

Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

" + } + ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { + "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection", + "bodyParameters": { "required_status_checks": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", + "strict": true, "contexts": [ "continuous-integration/travis-ci" - ], - "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts", - "enforcement_level": "non_admins" - }, - "enforce_admins": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", - "enabled": true + ] }, + "enforce_admins": true, "required_pull_request_reviews": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", "dismissal_restrictions": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", - "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", "users": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } + "octocat" ], "teams": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "apps": [ - { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] - } + "justice-league" ] }, "dismiss_stale_reviews": true, "require_code_owner_reviews": true, - "required_approving_review_count": 2 + "required_approving_review_count": 2, + "bypass_pull_request_allowances": { + "users": [ + "octocat" + ], + "teams": [ + "justice-league" + ] + } }, "restrictions": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", - "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams", - "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps", "users": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } + "octocat" ], "teams": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } + "justice-league" ], "apps": [ + "super-ci" + ] + }, + "required_linear_history": true, + "allow_force_pushes": true, + "allow_deletions": true, + "block_creations": true, + "required_conversation_resolution": true + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] + "context": "continuous-integration/travis-ci", + "app_id": null } ] }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [], + "teams": [], + "apps": [] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [], + "teams": [], + "apps": [] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, "required_linear_history": { "enabled": true }, @@ -134822,37 +139926,48 @@ "allow_deletions": { "enabled": true }, + "block_creations": { + "enabled": true + }, "required_conversation_resolution": { "enabled": true } }, "schema": { - "title": "Branch Protection", - "description": "Branch Protection", + "title": "Protected Branch", + "description": "Branch protections protect branches", "type": "object", "properties": { "url": { - "type": "string" - }, - "enabled": { - "type": "boolean" + "type": "string", + "format": "uri" }, "required_status_checks": { - "title": "Protected Branch Required Status Check", - "description": "Protected Branch Required Status Check", + "title": "Status Check Policy", + "description": "Status Check Policy", "type": "object", "properties": { "url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" + ] }, - "enforcement_level": { - "type": "string" + "strict": { + "type": "boolean", + "examples": [ + true + ] }, "contexts": { "type": "array", "items": { "type": "string" - } + }, + "examples": [ + "continuous-integration/travis-ci" + ] }, "checks": { "type": "array", @@ -134860,7 +139975,10 @@ "type": "object", "properties": { "context": { - "type": "string" + "type": "string", + "examples": [ + "continuous-integration/travis-ci" + ] }, "app_id": { "type": [ @@ -134876,58 +139994,53 @@ } }, "contexts_url": { - "type": "string" - }, - "strict": { - "type": "boolean" - } - }, - "required": [ - "contexts", - "checks" - ] - }, - "enforce_admins": { - "title": "Protected Branch Admin Enforced", - "description": "Protected Branch Admin Enforced", - "type": "object", - "properties": { - "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" - ] - }, - "enabled": { - "type": "boolean", - "examples": [ - true + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" ] } }, "required": [ "url", - "enabled" + "contexts_url", + "strict", + "contexts", + "checks" ] }, "required_pull_request_reviews": { - "title": "Protected Branch Pull Request Review", - "description": "Protected Branch Pull Request Review", "type": "object", "properties": { "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" - ] + "format": "uri" + }, + "dismiss_stale_reviews": { + "type": "boolean" + }, + "require_code_owner_reviews": { + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" }, "dismissal_restrictions": { "type": "object", "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, "users": { - "description": "The list of users with review dismissal access.", "type": "array", "items": { "title": "Simple User", @@ -135092,7 +140205,6 @@ } }, "teams": { - "description": "The list of teams with review dismissal access.", "type": "array", "items": { "title": "Team", @@ -135296,7 +140408,6 @@ } }, "apps": { - "description": "The list of apps with review dismissal access.", "type": "array", "items": { "title": "GitHub app", @@ -135623,33 +140734,20 @@ "events" ] } - }, - "url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" - ] - }, - "users_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" - ] - }, - "teams_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" - ] } - } + }, + "required": [ + "url", + "users_url", + "teams_url", + "users", + "teams" + ] }, "bypass_pull_request_allowances": { "type": "object", - "description": "Allow specific users, teams, or apps to bypass pull request requirements.", "properties": { "users": { - "description": "The list of users allowed to bypass pull request requirements.", "type": "array", "items": { "title": "Simple User", @@ -135814,7 +140912,6 @@ } }, "teams": { - "description": "The list of teams allowed to bypass pull request requirements.", "type": "array", "items": { "title": "Team", @@ -136018,7 +141115,6 @@ } }, "apps": { - "description": "The list of apps allowed to bypass pull request requirements.", "type": "array", "items": { "title": "GitHub app", @@ -136346,32 +141442,90 @@ ] } } - } - }, - "dismiss_stale_reviews": { - "type": "boolean", + }, + "required": [ + "users", + "teams" + ] + } + }, + "required": [ + "url" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", "examples": [ - true + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" ] }, - "require_code_owner_reviews": { + "enabled": { "type": "boolean", "examples": [ true ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "enforce_admins": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" }, - "required_approving_review_count": { - "type": "integer", - "minimum": 0, - "maximum": 6, - "examples": [ - 2 - ] + "enabled": { + "type": "boolean" } }, + "additionalProperties": false, "required": [ - "dismiss_stale_reviews", - "require_code_owner_reviews" + "url", + "enabled" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" ] }, "restrictions": { @@ -136683,29 +141837,14 @@ "apps" ] }, - "required_linear_history": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "allow_force_pushes": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "allow_deletions": { + "required_conversation_resolution": { "type": "object", "properties": { "enabled": { "type": "boolean" } - } + }, + "additionalProperties": false }, "block_creations": { "type": "object", @@ -136713,340 +141852,17 @@ "enabled": { "type": "boolean" } - } - }, - "required_conversation_resolution": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "name": { - "type": "string", - "examples": [ - "\"branch/with/protection\"" - ] - }, - "protection_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" - ] - }, - "required_signatures": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" - ] - }, - "enabled": { - "type": "boolean", - "examples": [ - true - ] - } }, + "additionalProperties": false, "required": [ - "url", "enabled" ] } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "title": "Update branch protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "object or null", - "name": "required_status_checks", - "in": "body", - "description": "

Require status checks to pass before merging. Set to null to disable.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "strict", - "description": "

Require branches to be up to date before merging.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "contexts", - "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "checks", - "description": "

The list of status checks to require in order to merge into this branch.

", - "childParamsGroups": [ - { - "type": "string", - "name": "context", - "description": "

The name of the required check

", - "isRequired": true - }, - { - "type": "integer", - "name": "app_id", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" - } - ] - } - ] - }, - { - "type": "boolean or null", - "name": "enforce_admins", - "in": "body", - "description": "

Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "required_pull_request_reviews", - "in": "body", - "description": "

Require at least one approving review on a pull request, before merging. Set to null to disable.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "dismissal_restrictions", - "description": "

Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "users", - "description": "

The list of user logins with dismissal access

" - }, - { - "type": "array of strings", - "name": "teams", - "description": "

The list of team slugs with dismissal access

" - }, - { - "type": "array of strings", - "name": "apps", - "description": "

The list of app slugs with dismissal access

" - } - ] - }, - { - "type": "boolean", - "name": "dismiss_stale_reviews", - "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

" - }, - { - "type": "boolean", - "name": "require_code_owner_reviews", - "description": "

Blocks merging pull requests until code owners review them.

" - }, - { - "type": "integer", - "name": "required_approving_review_count", - "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

" - }, - { - "type": "object", - "name": "bypass_pull_request_allowances", - "description": "

Allow specific users, teams, or apps to bypass pull request requirements.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "users", - "description": "

The list of user logins allowed to bypass pull request requirements.

" - }, - { - "type": "array of strings", - "name": "teams", - "description": "

The list of team slugs allowed to bypass pull request requirements.

" - }, - { - "type": "array of strings", - "name": "apps", - "description": "

The list of app slugs allowed to bypass pull request requirements.

" - } - ] - } - ] - }, - { - "type": "object or null", - "name": "restrictions", - "in": "body", - "description": "

Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of strings", - "name": "users", - "description": "

The list of user logins with push access

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "teams", - "description": "

The list of team slugs with push access

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "apps", - "description": "

The list of app slugs with push access

" - } - ] - }, - { - "type": "boolean", - "name": "required_linear_history", - "in": "body", - "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

" - }, - { - "type": "boolean or null", - "name": "allow_force_pushes", - "in": "body", - "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

" - }, - { - "type": "boolean", - "name": "allow_deletions", - "in": "body", - "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

" - }, - { - "type": "boolean", - "name": "block_creations", - "in": "body", - "description": "

If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

" - }, - { - "type": "boolean", - "name": "required_conversation_resolution", - "in": "body", - "description": "

Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

" - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "required_status_checks": { - "strict": true, - "contexts": [ - "continuous-integration/travis-ci" - ] - }, - "enforce_admins": true, - "required_pull_request_reviews": { - "dismissal_restrictions": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ] - }, - "dismiss_stale_reviews": true, - "require_code_owner_reviews": true, - "required_approving_review_count": 2, - "bypass_pull_request_allowances": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ] - } - }, - "restrictions": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ], - "apps": [ - "super-ci" - ] }, - "required_linear_history": true, - "allow_force_pushes": true, - "allow_deletions": true, - "block_creations": true, - "required_conversation_resolution": true - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" + "required": [ + "url" + ] } - }, - "response": { - "statusCode": "200", - "description": "

Response

" } } ], @@ -141252,36 +146068,347 @@ } ], "bodyParameters": [ - { - "type": "boolean", - "name": "strict", - "in": "body", - "description": "

Require branches to be up to date before merging.

" - }, + { + "type": "boolean", + "name": "strict", + "in": "body", + "description": "

Require branches to be up to date before merging.

" + }, + { + "type": "array of strings", + "name": "contexts", + "in": "body", + "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

" + }, + { + "type": "array of objects", + "name": "checks", + "in": "body", + "description": "

The list of status checks to require in order to merge into this branch.

", + "childParamsGroups": [ + { + "type": "string", + "name": "context", + "description": "

The name of the required check

", + "isRequired": true + }, + { + "type": "integer", + "name": "app_id", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" + } + ] + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ] + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + }, + "schema": { + "title": "Status Check Policy", + "description": "Status Check Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" + ] + }, + "strict": { + "type": "boolean", + "examples": [ + true + ] + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "continuous-integration/travis-ci" + ] + }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "examples": [ + "continuous-integration/travis-ci" + ] + }, + "app_id": { + "type": [ + "integer", + "null" + ] + } + }, + "required": [ + "context", + "app_id" + ] + } + }, + "contexts_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + ] + } + }, + "required": [ + "url", + "contexts_url", + "strict", + "contexts", + "checks" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + "title": "Remove status check protection", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "title": "Get all status check contexts", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + "continuous-integration/travis-ci" + ], + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "title": "Add status check contexts", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [ { "type": "array of strings", "name": "contexts", "in": "body", - "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

" - }, - { - "type": "array of objects", - "name": "checks", - "in": "body", - "description": "

The list of status checks to require in order to merge into this branch.

", - "childParamsGroups": [ - { - "type": "string", - "name": "context", - "description": "

The name of the required check

", - "isRequired": true - }, - { - "type": "integer", - "name": "app_id", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" - } - ] + "description": "

The name of the status checks

", + "isRequired": true } ], "enabledForGitHubApps": true, @@ -141290,12 +146417,12 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding status checks to a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "strict": true, "contexts": [ - "continuous-integration/travis-ci" + "continuous-integration/travis-ci", + "continuous-integration/jenkins" ] }, "parameters": { @@ -141304,311 +146431,6 @@ "branch": "BRANCH" } }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", - "strict": true, - "contexts": [ - "continuous-integration/travis-ci" - ], - "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" - }, - "schema": { - "title": "Status Check Policy", - "description": "Status Check Policy", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" - ] - }, - "strict": { - "type": "boolean", - "examples": [ - true - ] - }, - "contexts": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "continuous-integration/travis-ci" - ] - }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "examples": [ - "continuous-integration/travis-ci" - ] - }, - "app_id": { - "type": [ - "integer", - "null" - ] - } - }, - "required": [ - "context", - "app_id" - ] - } - }, - "contexts_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" - ] - } - }, - "required": [ - "url", - "contexts_url", - "strict", - "contexts", - "checks" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "title": "Remove status check protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "title": "Get all status check contexts", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - "continuous-integration/travis-ci" - ], - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "title": "Add status check contexts", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "contexts", - "in": "body", - "description": "

contexts parameter

", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, "response": { "statusCode": "200", "contentType": "application/json", @@ -141689,7 +146511,7 @@ "type": "array of strings", "name": "contexts", "in": "body", - "description": "

contexts parameter

", + "description": "

The name of the status checks

", "isRequired": true } ], @@ -141699,8 +146521,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example updating status checks for a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -141782,7 +146609,7 @@ "type": "array of strings", "name": "contexts", "in": "body", - "description": "

contexts parameter

", + "description": "

The name of the status checks

", "isRequired": true } ], @@ -141792,8 +146619,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing status checks from a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -144487,7 +149319,7 @@ "type": "array of strings", "name": "teams", "in": "body", - "description": "

teams parameter

", + "description": "

The slug values for teams

", "isRequired": true } ], @@ -144497,8 +149329,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -144786,7 +149623,7 @@ "type": "array of strings", "name": "teams", "in": "body", - "description": "

teams parameter

", + "description": "

The slug values for teams

", "isRequired": true } ], @@ -144796,8 +149633,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -145085,7 +149927,7 @@ "type": "array of strings", "name": "teams", "in": "body", - "description": "

teams parameter

", + "description": "

The slug values for teams

", "isRequired": true } ], @@ -145095,8 +149937,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -145641,7 +150488,7 @@ "type": "array of strings", "name": "users", "in": "body", - "description": "

users parameter

", + "description": "

The username for users

", "isRequired": true } ], @@ -145651,8 +150498,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -145907,7 +150759,7 @@ "type": "array of strings", "name": "users", "in": "body", - "description": "

users parameter

", + "description": "

The username for users

", "isRequired": true } ], @@ -145917,8 +150769,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -146173,7 +151030,7 @@ "type": "array of strings", "name": "users", "in": "body", - "description": "

users parameter

", + "description": "

The username for users

", "isRequired": true } ], @@ -146183,8 +151040,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -157391,6 +162253,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -160550,6 +165416,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -163227,6 +168097,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -166323,6 +171197,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -169526,6 +174404,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -170599,6 +175481,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -172098,7 +176987,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -172448,6 +177338,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -172735,7 +177632,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -173085,6 +177983,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -173324,6 +178229,7 @@ "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "state": "open", "fixed_at": null, "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", @@ -174175,7 +179081,7 @@ "description": "

Service unavailable

" } ], - "descriptionHTML": "

Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the repo scope. For public repositories,\nyou must use an access token with public_repo scope.\nGitHub Apps must have the security_events write permission to use this endpoint.

\n

You can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.

\n

When you list the analyses for a repository,\none or more will be identified as deletable in the response:

\n
\"deletable\": true\n
\n

An analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:

\n
    \n
  • ref
  • \n
  • tool
  • \n
  • analysis_key
  • \n
  • environment
  • \n
\n

If you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:

\n
Analysis specified is not deletable.\n
\n

The response from a successful DELETE operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\nnext_analysis_url and confirm_delete_url.\nUse the next_analysis_url URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the confirm_delete_url URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of next_analysis_url and confirm_delete_url\nin the 200 response is null.

\n

As an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:

\n

Outer loop:

\n
    \n
  • \n

    List the analyses for the repository, filtered by tool.

    \n
  • \n
  • \n

    Parse this list to find a deletable analysis. If found:

    \n

    Inner loop:

    \n
      \n
    • Delete the identified analysis.
    • \n
    • Parse the response for the value of confirm_delete_url and, if found, use this in the next iteration.
    • \n
    \n
  • \n
\n

The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url value. Alternatively, you could use the next_analysis_url value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.

", + "descriptionHTML": "

Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the repo scope. For public repositories,\nyou must use an access token with public_repo scope.\nGitHub Apps must have the security_events write permission to use this endpoint.

\n

You can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.

\n

When you list the analyses for a repository,\none or more will be identified as deletable in the response:

\n
\"deletable\": true\n
\n

An analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:

\n
    \n
  • ref
  • \n
  • tool
  • \n
  • category
  • \n
\n

If you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:

\n
Analysis specified is not deletable.\n
\n

The response from a successful DELETE operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\nnext_analysis_url and confirm_delete_url.\nUse the next_analysis_url URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the confirm_delete_url URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of next_analysis_url and confirm_delete_url\nin the 200 response is null.

\n

As an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:

\n

Outer loop:

\n
    \n
  • \n

    List the analyses for the repository, filtered by tool.

    \n
  • \n
  • \n

    Parse this list to find a deletable analysis. If found:

    \n

    Inner loop:

    \n
      \n
    • Delete the identified analysis.
    • \n
    • Parse the response for the value of confirm_delete_url and, if found, use this in the next iteration.
    • \n
    \n
  • \n
\n

The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url value. Alternatively, you could use the next_analysis_url value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.

", "subcategory": "code-scanning" }, { @@ -177194,6 +182100,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -180382,6 +185292,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -181079,8 +185993,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example request body", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permissions": "write" + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -183188,6 +188105,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -186032,6 +190953,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -191212,6 +196137,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -192856,6 +197785,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -194369,6 +199302,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ] }, @@ -196950,6 +201887,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ] } @@ -201367,6 +206308,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -204995,6 +209940,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -223532,14 +228481,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -224762,14 +229703,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -225557,14 +230490,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -243268,6 +248193,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -246768,6 +251697,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -247604,7 +252537,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ], "schema": { @@ -250185,6 +255119,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -250961,7 +255899,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -253539,6 +258478,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -254282,7 +259225,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -256860,6 +261804,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -257455,6 +262403,12 @@ "closed" ] }, + { + "type": "string or null", + "name": "state_reason", + "in": "body", + "description": "

The reason for the current state

" + }, { "type": "null or string or integer or string or integer", "name": "milestone", @@ -257659,7 +262613,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -260237,6 +265192,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -263907,6 +268866,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -264989,7 +269952,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -267567,6 +272531,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -268304,7 +273272,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -270882,6 +275851,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -275513,7 +280486,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ], @@ -278323,6 +283297,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -280457,7 +285435,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } }, "schema": { @@ -283264,6 +288243,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -310834,6 +315817,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -318388,6 +323375,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -320381,6 +325372,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -322346,6 +327341,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -324291,6 +329290,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -326283,6 +331286,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -328611,6 +333618,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -329954,14 +334965,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -330830,14 +335833,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -331721,14 +336716,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -332524,14 +337511,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -333419,14 +338398,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -334223,14 +339194,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -335056,14 +340019,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -335931,14 +340886,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -338622,14 +343569,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -339563,7 +344502,7 @@ } ], "previews": [], - "descriptionHTML": "

List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.

\n

For more information on custom repository roles, see \"Managing custom repository roles for an organization\".

", + "descriptionHTML": "

List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.

\n

To use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with admin:org repo scope.\nGitHub Apps must have the organization_custom_roles:read organization permission to use this endpoint.

\n

For more information on custom repository roles, see \"Managing custom repository roles for an organization\".

", "statusCodes": [ { "httpStatusCode": "200", @@ -339850,10 +344789,6 @@ "httpStatusCode": "200", "description": "

OK

" }, - { - "httpStatusCode": "302", - "description": "

Response if requester is not an organization member

" - }, { "httpStatusCode": "422", "description": "

Validation failed

" @@ -356732,6 +361667,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -358376,6 +363315,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -366705,6 +371648,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ], "subcategory": "pulls" @@ -371616,6 +376563,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ], "subcategory": "pulls" @@ -379851,6 +384802,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -381495,6 +386450,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -385529,6 +390488,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -387173,6 +392136,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -408726,6 +413693,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -410690,6 +415661,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -413367,6 +418342,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -415166,6 +420145,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -416621,6 +421604,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -419715,6 +424702,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -421514,6 +426505,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -422969,6 +427964,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -426898,6 +431897,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -428724,6 +433727,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -428805,7 +433812,7 @@ } } ], - "descriptionHTML": "

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

\n

OAuth scope requirements

\n

When using OAuth, authorizations must include:

\n
    \n
  • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
  • \n
  • repo scope to create a private repository
  • \n
", + "descriptionHTML": "

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

\n

OAuth scope requirements

\n

When using OAuth, authorizations must include:

\n
    \n
  • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
  • \n
  • repo scope to create a private repository
  • \n
", "statusCodes": [ { "httpStatusCode": "201", @@ -430904,6 +435911,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -432797,6 +437808,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -434586,6 +439601,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -436871,6 +441890,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -437272,6 +442295,13 @@ "in": "body", "description": "

The URL must contain <num> for the reference number.

", "isRequired": true + }, + { + "type": "boolean", + "name": "is_alphanumeric", + "in": "body", + "description": "

Whether this autolink reference matches alphanumeric characters. If true, the <num> parameter of the url_template matches alphanumeric characters A-Z (case insensitive), 0-9, and -. If false, this autolink reference only matches numeric characters.

", + "default": "true" } ], "enabledForGitHubApps": true, @@ -437284,7 +442314,8 @@ "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=" + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true }, "parameters": { "owner": "OWNER", @@ -443030,6 +448061,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -445874,6 +450909,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -447673,6 +452712,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -449128,6 +454171,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -452008,6 +457055,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -454900,6 +459951,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -455399,7 +460454,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] }, @@ -457836,6 +462892,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -470504,6 +475564,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -473193,6 +478257,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -479123,6 +484191,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -481806,6 +486878,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 114449dd8859..b72ebec96d09 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -3191,6 +3191,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -6516,6 +6520,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -10845,6 +10853,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -12330,6 +12342,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -14355,6 +14371,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -15840,6 +15860,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -17895,6 +17919,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -19390,6 +19418,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -24179,6 +24211,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -26307,6 +26343,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -29497,6 +29537,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -31625,6 +31669,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -34887,6 +34935,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -37015,6 +37067,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -40888,6 +40944,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -43016,6 +43076,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -46806,6 +46870,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -50742,6 +50810,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -54699,6 +54771,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -58268,6 +58344,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -60689,6 +60769,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -63472,6 +63556,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -66212,6 +66300,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -67743,6 +67835,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -69584,6 +69680,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -70972,6 +71072,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -73677,6 +73781,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -75990,6 +76098,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -77563,14 +77675,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -78492,14 +78596,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -79114,15 +79210,6 @@ "write" ] }, - { - "type": "string", - "name": "organization_custom_roles", - "description": "

The level of permission to grant the access token for custom roles management.

", - "enum": [ - "read", - "write" - ] - }, { "type": "string", "name": "deployments", @@ -79565,14 +79652,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -81099,6 +81178,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -82199,14 +82282,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -83132,14 +83207,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -84063,14 +84130,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -86028,6 +86087,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -86681,14 +86744,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -88683,6 +88738,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -89391,880 +89450,864 @@ "write" ] }, - "organization_custom_roles": { + "deployments": { + "type": "string", + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" + ] + }, + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] + }, + "organization_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_packages": { + "type": "string", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "description": "The level of permission to grant the access token to manage team discussions and related comments.", + "enum": [ + "read", + "write" + ] + } + }, + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "single_file_name": { + "type": [ + "string", + "null" + ], + "examples": [ + "config.yaml" + ] + }, + "has_multiple_single_files": { + "type": "boolean", + "examples": [ + true + ] + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "account": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "permissions", + "repository_selection", + "single_file_name", + "repositories_url", + "account" + ] + } + ] + }, + "expires_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + }, + "required": [ + "app", + "id", + "note", + "note_url", + "scopes", + "token", + "hashed_token", + "token_last_eight", + "fingerprint", + "url", + "created_at", + "updated_at", + "expires_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use Basic Authentication to use this endpoint, where the username is the OAuth application client_id and the password is its client_secret. Invalid tokens will return 404 NOT FOUND.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed

" + } + ] + }, + { + "serverUrl": "https://HOSTNAME/api/v3", + "verb": "patch", + "requestPath": "/applications/{client_id}/token", + "title": "Reset a token", + "category": "apps", + "subcategory": "oauth-applications", + "parameters": [ + { + "name": "client_id", + "in": "path", + "required": true, + "description": "

The client ID of the GitHub app.

", + "schema": { + "type": "string" + }, + "examples": { + "default": { + "value": "Iv1.8a61f9b3a7aba766" + } + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "access_token", + "in": "body", + "description": "

The access_token of the OAuth application.

", + "isRequired": true + } + ], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" + }, + "parameters": { + "client_id": "Iv1.8a61f9b3a7aba766" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 1, + "url": "https://api.github.com/authorizations/1", + "scopes": [ + "public_repo", + "user" + ], + "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", + "token_last_eight": "Ae178B4a", + "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", + "app": { + "url": "http://my-github-app.com", + "name": "my github app", + "client_id": "Iv1.8a61f9b3a7aba766" + }, + "note": "optional note", + "note_url": "http://optional/note/url", + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "fingerprint": "jklmnop12345678", + "expires_at": "2011-09-08T17:26:27Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "schema": { + "title": "Authorization", + "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + }, + "scopes": { + "description": "A list of scopes that this authorization is in.", + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, + "token": { + "type": "string" + }, + "token_last_eight": { + "type": [ + "string", + "null" + ] + }, + "hashed_token": { + "type": [ + "string", + "null" + ] + }, + "app": { + "type": "object", + "properties": { + "client_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "client_id", + "name", + "url" + ] + }, + "note": { + "type": [ + "string", + "null" + ] + }, + "note_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "fingerprint": { + "type": [ + "string", + "null" + ] + }, + "user": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "installation": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Scoped Installation", + "type": "object", + "properties": { + "permissions": { + "title": "App Permissions", + "type": "object", + "description": "The permissions granted to the user-to-server access token.", + "properties": { + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" + ] + }, + "checks": { "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] - }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] - }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] - }, - "metadata": { - "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] - }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] - }, - "pull_requests": { - "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] - }, - "repository_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] - }, - "repository_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] - }, - "secret_scanning_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] - }, - "security_events": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] - }, - "single_file": { - "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] - }, - "statuses": { - "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] - }, - "vulnerability_alerts": { - "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] - }, - "workflows": { - "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] - }, - "members": { - "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { - "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_hooks": { - "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] - }, - "organization_projects": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "enum": [ - "read", - "write", - "admin" - ] - }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] - }, - "organization_secrets": { - "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] - }, - "organization_self_hosted_runners": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] - }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] - }, - "team_discussions": { - "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "enum": [ - "read", - "write" - ] - } - }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - } - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "single_file_name": { - "type": [ - "string", - "null" - ], - "examples": [ - "config.yaml" - ] - }, - "has_multiple_single_files": { - "type": "boolean", - "examples": [ - true - ] - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "account": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - }, - "required": [ - "permissions", - "repository_selection", - "single_file_name", - "repositories_url", - "account" - ] - } - ] - }, - "expires_at": { - "type": [ - "string", - "null" - ], - "format": "date-time" - } - }, - "required": [ - "app", - "id", - "note", - "note_url", - "scopes", - "token", - "hashed_token", - "token_last_eight", - "fingerprint", - "url", - "created_at", - "updated_at", - "expires_at" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "

OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use Basic Authentication to use this endpoint, where the username is the OAuth application client_id and the password is its client_secret. Invalid tokens will return 404 NOT FOUND.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed

" - } - ] - }, - { - "serverUrl": "https://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/applications/{client_id}/token", - "title": "Reset a token", - "category": "apps", - "subcategory": "oauth-applications", - "parameters": [ - { - "name": "client_id", - "in": "path", - "required": true, - "description": "

The client ID of the GitHub app.

", - "schema": { - "type": "string" - }, - "examples": { - "default": { - "value": "Iv1.8a61f9b3a7aba766" - } - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "access_token", - "in": "body", - "description": "

The access_token of the OAuth application.

", - "isRequired": true - } - ], - "enabledForGitHubApps": false, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" - }, - "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "id": 1, - "url": "https://api.github.com/authorizations/1", - "scopes": [ - "public_repo", - "user" - ], - "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", - "token_last_eight": "Ae178B4a", - "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", - "app": { - "url": "http://my-github-app.com", - "name": "my github app", - "client_id": "Iv1.8a61f9b3a7aba766" - }, - "note": "optional note", - "note_url": "http://optional/note/url", - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "fingerprint": "jklmnop12345678", - "expires_at": "2011-09-08T17:26:27Z", - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - }, - "schema": { - "title": "Authorization", - "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - }, - "scopes": { - "description": "A list of scopes that this authorization is in.", - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - }, - "token": { - "type": "string" - }, - "token_last_eight": { - "type": [ - "string", - "null" - ] - }, - "hashed_token": { - "type": [ - "string", - "null" - ] - }, - "app": { - "type": "object", - "properties": { - "client_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "client_id", - "name", - "url" - ] - }, - "note": { - "type": [ - "string", - "null" - ] - }, - "note_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "fingerprint": { - "type": [ - "string", - "null" - ] - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] - }, - "installation": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Scoped Installation", - "type": "object", - "properties": { - "permissions": { - "title": "App Permissions", - "type": "object", - "description": "The permissions granted to the user-to-server access token.", - "properties": { - "actions": { - "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] - }, - "administration": { - "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] - }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] - }, - "contents": { - "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] - }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", "enum": [ "read", "write" @@ -91193,14 +91236,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -94514,334 +94549,120 @@ }, "response": { "statusCode": "200", - "description": "

Response

" - } - } - ], - "descriptionHTML": "", - "previews": [], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "301", - "description": "

Moved permanently

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ] - }, - { - "serverUrl": "https://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/merge-upstream", - "title": "Sync a fork branch with the upstream repository", - "category": "branches", - "subcategory": "branches", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "branch", - "in": "body", - "description": "

The name of the branch which should be updated to match upstream.

", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "branch": "main" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

The branch has been successfully synced with the upstream repository

", - "example": { - "message": "Successfully fetched and fast-forwarded from upstream defunkt:main", - "merge_type": "fast-forward", - "base_branch": "defunkt:main" - }, - "schema": { - "title": "Merged upstream", - "description": "Results of a successful merge upstream request", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "merge_type": { - "type": "string", - "enum": [ - "merge", - "fast-forward", - "none" - ] - }, - "base_branch": { - "type": "string" - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Sync a branch of a forked repository to keep it up-to-date with the upstream repository.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

The branch has been successfully synced with the upstream repository

" - }, - { - "httpStatusCode": "409", - "description": "

The branch could not be synced because of a merge conflict

" - }, - { - "httpStatusCode": "422", - "description": "

The branch could not be synced for some other reason

" - } - ] - }, - { - "serverUrl": "https://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/merges", - "title": "Merge a branch", - "category": "branches", - "subcategory": "branches", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "base", - "in": "body", - "description": "

The name of the base branch that the head will be merged into.

", - "isRequired": true - }, - { - "type": "string", - "name": "head", - "in": "body", - "description": "

The head to merge. This can be a branch name or a commit SHA1.

", - "isRequired": true - }, - { - "type": "string", - "name": "commit_message", - "in": "body", - "description": "

Commit message to use for the merge commit. If omitted, a default message will be used.

" - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "base": "master", - "head": "cool_feature", - "commit_message": "Shipped cool_feature!" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO" - } - }, - "response": { - "statusCode": "201", "contentType": "application/json", - "description": "

Successful Response (The resulting merge commit)

", + "description": "

Response

", "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", - "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", + "name": "main", "commit": { - "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", + "commit": { + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", "author": { - "name": "Monalisa Octocat", - "email": "mona@github.com", - "date": "2011-04-14T16:00:49Z" + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false }, "committer": { - "name": "Monalisa Octocat", - "email": "mona@github.com", - "date": "2011-04-14T16:00:49Z" - }, - "message": "Fix all the bugs", - "tree": { - "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false }, - "comment_count": 0, - "verification": { - "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null - } - }, - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] }, - "committer": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" }, - "parents": [ - { - "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + "protected": false, + "protection": { + "enabled": false, + "required_status_checks": { + "enforcement_level": "off", + "contexts": [], + "checks": [] } - ], - "stats": { - "additions": 104, - "deletions": 4, - "total": 108 }, - "files": [ - { - "filename": "file1.txt", - "additions": 10, - "deletions": 2, - "changes": 12, - "status": "modified", - "raw_url": "https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", - "blob_url": "https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", - "patch": "@@ -29,7 +29,7 @@\n....." - } - ] + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" }, "schema": { - "title": "Commit", - "description": "Commit", + "title": "Branch With Protection", + "description": "Branch With Protection", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "sha": { - "type": "string", - "examples": [ - "6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "comments_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" - ] + "name": { + "type": "string" }, "commit": { + "title": "Commit", + "description": "Commit", "type": "object", "properties": { "url": { @@ -94851,35 +94672,345 @@ "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, + "sha": { + "type": "string", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + ] + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { + "type": "string", + "examples": [ + "Fix all the bugs" + ] + }, + "comment_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" + ] + } + }, + "required": [ + "sha", + "url" + ] + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "payload": { + "type": [ + "string", + "null" + ] + }, + "signature": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature" + ] + } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, "author": { "anyOf": [ { "type": "null" }, { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", "examples": [ - "\"Chris Wanstrath\"" + "octocat" ] }, - "email": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", "examples": [ - "\"chris@ozmm.org\"" + "MDQ6VXNlcjE=" ] }, - "date": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "\"2007-10-29T02:42:39.000-07:00\"" + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } ] }, @@ -94889,639 +95020,5509 @@ "type": "null" }, { - "title": "Git User", - "description": "Metaproperties for Git author/committer information.", + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { "type": "string", "examples": [ - "\"Chris Wanstrath\"" + "octocat" ] }, - "email": { + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { "type": "string", "examples": [ - "\"chris@ozmm.org\"" + "MDQ6VXNlcjE=" ] }, - "date": { + "avatar_url": { "type": "string", + "format": "uri", "examples": [ - "\"2007-10-29T02:42:39.000-07:00\"" + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" ] } - } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] } ] }, - "message": { - "type": "string", - "examples": [ - "Fix all the bugs" - ] - }, - "comment_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "tree": { - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "827efc6d56897b048c772eb4087f854f46256132" - ] + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + } }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" - ] - } - }, - "required": [ - "sha", - "url" - ] + "required": [ + "sha", + "url" + ] + } }, - "verification": { - "title": "Verification", + "stats": { "type": "object", "properties": { - "verified": { - "type": "boolean" - }, - "reason": { - "type": "string" + "additions": { + "type": "integer" }, - "payload": { - "type": [ - "string", - "null" - ] + "deletions": { + "type": "integer" }, - "signature": { - "type": [ - "string", - "null" - ] + "total": { + "type": "integer" } - }, - "required": [ - "verified", - "reason", - "payload", - "signature" - ] - } - }, - "required": [ - "author", - "committer", - "comment_count", - "message", - "tree", - "url" - ] - }, - "author": { - "anyOf": [ - { - "type": "null" + } }, - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] + "files": { + "type": "array", + "items": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" + ] + }, + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "examples": [ + "added" + ] + }, + "additions": { + "type": "integer", + "examples": [ + 103 + ] + }, + "deletions": { + "type": "integer", + "examples": [ + 21 + ] + }, + "changes": { + "type": "integer", + "examples": [ + 124 + ] + }, + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" + ] + } }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + } + } + }, + "required": [ + "url", + "sha", + "node_id", + "html_url", + "comments_url", + "commit", + "author", + "committer", + "parents" + ] + }, + "_links": { + "type": "object", + "properties": { + "html": { + "type": "string" + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "html", + "self" + ] + }, + "protected": { + "type": "boolean" + }, + "protection": { + "title": "Branch Protection", + "description": "Branch Protection", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", + "type": "object", + "properties": { + "url": { + "type": "string" }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] + "enforcement_level": { + "type": "string" }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] + "contexts": { + "type": "array", + "items": { + "type": "string" + } }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": [ + "integer", + "null" + ] + } + }, + "required": [ + "context", + "app_id" + ] + } }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] + "contexts_url": { + "type": "string" }, - "repos_url": { + "strict": { + "type": "boolean" + } + }, + "required": [ + "contexts", + "checks" + ] + }, + "enforce_admins": { + "title": "Protected Branch Admin Enforced", + "description": "Protected Branch Admin Enforced", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/repos" + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" ] }, - "events_url": { - "type": "string", + "enabled": { + "type": "boolean", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + true ] - }, - "received_events_url": { + } + }, + "required": [ + "url", + "enabled" + ] + }, + "required_pull_request_reviews": { + "title": "Protected Branch Pull Request Review", + "description": "Protected Branch Pull Request Review", + "type": "object", + "properties": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" ] }, - "site_admin": { - "type": "boolean" + "dismissal_restrictions": { + "type": "object", + "properties": { + "users": { + "description": "The list of users with review dismissal access.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams with review dismissal access.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps with review dismissal access.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" + ] + }, + "users_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" + ] + }, + "teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" + ] + } + } }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "bypass_pull_request_allowances": { + "type": "object", + "description": "Allow specific users, teams, or apps to bypass pull request requirements.", + "properties": { + "users": { + "description": "The list of users allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + } + } + }, + "dismiss_stale_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "require_code_owner_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "required_approving_review_count": { + "type": "integer", + "minimum": 0, + "maximum": 6, + "examples": [ + 2 + ] + } + }, + "required": [ + "dismiss_stale_reviews", + "require_code_owner_reviews" + ] + }, + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "name": { + "type": "string", + "examples": [ + "\"branch/with/protection\"" + ] + }, + "protection_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + } + } + }, + "protection_url": { + "type": "string", + "format": "uri" + }, + "pattern": { + "type": "string", + "examples": [ + "\"mas*\"" + ] + }, + "required_approving_review_count": { + "type": "integer", + "examples": [ + 1 + ] + } + }, + "required": [ + "name", + "commit", + "_links", + "protection", + "protected", + "protection_url" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "301", + "description": "

Moved permanently

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/merge-upstream", + "title": "Sync a fork branch with the upstream repository", + "category": "branches", + "subcategory": "branches", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "branch", + "in": "body", + "description": "

The name of the branch which should be updated to match upstream.

", + "isRequired": true + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "branch": "main" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

The branch has been successfully synced with the upstream repository

", + "example": { + "message": "Successfully fetched and fast-forwarded from upstream defunkt:main", + "merge_type": "fast-forward", + "base_branch": "defunkt:main" + }, + "schema": { + "title": "Merged upstream", + "description": "Results of a successful merge upstream request", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "merge_type": { + "type": "string", + "enum": [ + "merge", + "fast-forward", + "none" + ] + }, + "base_branch": { + "type": "string" + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Sync a branch of a forked repository to keep it up-to-date with the upstream repository.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

The branch has been successfully synced with the upstream repository

" + }, + { + "httpStatusCode": "409", + "description": "

The branch could not be synced because of a merge conflict

" + }, + { + "httpStatusCode": "422", + "description": "

The branch could not be synced for some other reason

" + } + ] + }, + { + "serverUrl": "https://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/merges", + "title": "Merge a branch", + "category": "branches", + "subcategory": "branches", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "base", + "in": "body", + "description": "

The name of the base branch that the head will be merged into.

", + "isRequired": true + }, + { + "type": "string", + "name": "head", + "in": "body", + "description": "

The head to merge. This can be a branch name or a commit SHA1.

", + "isRequired": true + }, + { + "type": "string", + "name": "commit_message", + "in": "body", + "description": "

Commit message to use for the merge commit. If omitted, a default message will be used.

" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "base": "master", + "head": "cool_feature", + "commit_message": "Shipped cool_feature!" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Successful Response (The resulting merge commit)

", + "example": { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", + "commit": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "author": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "committer": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "message": "Fix all the bugs", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "comment_count": 0, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + ], + "stats": { + "additions": 104, + "deletions": 4, + "total": 108 + }, + "files": [ + { + "filename": "file1.txt", + "additions": 10, + "deletions": 2, + "changes": 12, + "status": "modified", + "raw_url": "https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", + "blob_url": "https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", + "patch": "@@ -29,7 +29,7 @@\n....." + } + ] + }, + "schema": { + "title": "Commit", + "description": "Commit", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "sha": { + "type": "string", + "examples": [ + "6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "comments_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + ] + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "\"Chris Wanstrath\"" + ] + }, + "email": { + "type": "string", + "examples": [ + "\"chris@ozmm.org\"" + ] + }, + "date": { + "type": "string", + "examples": [ + "\"2007-10-29T02:42:39.000-07:00\"" + ] + } + } + } + ] + }, + "message": { + "type": "string", + "examples": [ + "Fix all the bugs" + ] + }, + "comment_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" + ] + } + }, + "required": [ + "sha", + "url" + ] + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "payload": { + "type": [ + "string", + "null" + ] + }, + "signature": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature" + ] + } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, + "author": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "committer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + ] + } + }, + "required": [ + "sha", + "url" + ] + } + }, + "stats": { + "type": "object", + "properties": { + "additions": { + "type": "integer" + }, + "deletions": { + "type": "integer" + }, + "total": { + "type": "integer" + } + } + }, + "files": { + "type": "array", + "items": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "examples": [ + "bbcd538c8e72b8c175046e27cc8f907076331401" + ] + }, + "filename": { + "type": "string", + "examples": [ + "file1.txt" + ] + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "examples": [ + "added" + ] + }, + "additions": { + "type": "integer", + "examples": [ + 103 + ] + }, + "deletions": { + "type": "integer", + "examples": [ + 21 + ] + }, + "changes": { + "type": "integer", + "examples": [ + 124 + ] + }, + "blob_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "raw_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + ] + }, + "contents_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + ] + }, + "patch": { + "type": "string", + "examples": [ + "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + ] + }, + "previous_filename": { + "type": "string", + "examples": [ + "file.txt" + ] + } + }, + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + } + } + }, + "required": [ + "url", + "sha", + "node_id", + "html_url", + "comments_url", + "commit", + "author", + "committer", + "parents" + ] + } + } + } + ], + "descriptionHTML": "", + "previews": [], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Successful Response (The resulting merge commit)

" + }, + { + "httpStatusCode": "204", + "description": "

Response when already merged

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Not Found when the base or head does not exist

" + }, + { + "httpStatusCode": "409", + "description": "

Conflict when there is a merge conflict

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed

" + } + ] + } + ], + "branch-protection": [ + { + "serverUrl": "https://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", + "title": "Get branch protection", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts", + "enforcement_level": "non_admins" + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", + "enabled": true + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", + "users": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "apps": [ + { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + } + ] + }, + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2 + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps", + "users": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "apps": [ + { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + } + ] + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + }, + "schema": { + "title": "Branch Protection", + "description": "Branch Protection", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "required_status_checks": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enforcement_level": { + "type": "string" + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + } + }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": [ + "integer", + "null" + ] + } + }, + "required": [ + "context", + "app_id" + ] + } + }, + "contexts_url": { + "type": "string" + }, + "strict": { + "type": "boolean" + } + }, + "required": [ + "contexts", + "checks" + ] + }, + "enforce_admins": { + "title": "Protected Branch Admin Enforced", + "description": "Protected Branch Admin Enforced", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "required_pull_request_reviews": { + "title": "Protected Branch Pull Request Review", + "description": "Protected Branch Pull Request Review", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" + ] + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "users": { + "description": "The list of users with review dismissal access.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams with review dismissal access.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps with review dismissal access.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } + }, + "url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" + ] + }, + "users_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" + ] + }, + "teams_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" + ] + } + } + }, + "bypass_pull_request_allowances": { + "type": "object", + "description": "Allow specific users, teams, or apps to bypass pull request requirements.", + "properties": { + "users": { + "description": "The list of users allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "teams": { + "description": "The list of teams allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + } + }, + "apps": { + "description": "The list of apps allowed to bypass pull request requirements.", + "type": "array", + "items": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "examples": [ + 37 + ] + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string", + "examples": [ + "probot-owners" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOkludGVncmF0aW9uMQ==" + ] + }, + "owner": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "type": "string", + "examples": [ + "Probot Owners" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "The description of the app." + ] + }, + "external_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://example.com" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/apps/super-ci" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2017-07-08T16:18:44-04:00" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "label", + "deployment" + ] + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "type": "integer", + "examples": [ + 5 + ] + }, + "client_id": { + "type": "string", + "examples": [ + "\"Iv1.25b5d1e65ffc4022\"" + ] + }, + "client_secret": { + "type": "string", + "examples": [ + "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + ] + }, + "webhook_secret": { + "type": [ + "string", + "null" + ], + "examples": [ + "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + ] + }, + "pem": { + "type": "string", + "examples": [ + "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + ] + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + } } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + } + }, + "dismiss_stale_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "require_code_owner_reviews": { + "type": "boolean", + "examples": [ + true + ] + }, + "required_approving_review_count": { + "type": "integer", + "minimum": 0, + "maximum": 6, + "examples": [ + 2 ] } + }, + "required": [ + "dismiss_stale_reviews", + "require_code_owner_reviews" ] }, - "committer": { - "anyOf": [ - { - "type": "null" + "restrictions": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" }, - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": [ + "string", + "null" + ] + } + } + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "examples": [ + "\"\"" + ] + }, + "html_url": { + "type": "string", + "examples": [ + "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + ] + }, + "followers_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + ] + }, + "subscriptions_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + ] + }, + "organizations_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + ] + }, + "received_events_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + ] + }, + "type": { + "type": "string", + "examples": [ + "\"Organization\"" + ] + }, + "site_admin": { + "type": "boolean", + "examples": [ + false + ] + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" ] }, - "parents": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" - ] - } - }, - "required": [ - "sha", - "url" - ] + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } } }, - "stats": { + "allow_force_pushes": { "type": "object", "properties": { - "additions": { - "type": "integer" - }, - "deletions": { - "type": "integer" - }, - "total": { - "type": "integer" + "enabled": { + "type": "boolean" } } }, - "files": { - "type": "array", - "items": { - "title": "Diff Entry", - "description": "Diff Entry", - "type": "object", - "properties": { - "sha": { - "type": "string", - "examples": [ - "bbcd538c8e72b8c175046e27cc8f907076331401" - ] - }, - "filename": { - "type": "string", - "examples": [ - "file1.txt" - ] - }, - "status": { - "type": "string", - "enum": [ - "added", - "removed", - "modified", - "renamed", - "copied", - "changed", - "unchanged" - ], - "examples": [ - "added" - ] - }, - "additions": { - "type": "integer", - "examples": [ - 103 - ] - }, - "deletions": { - "type": "integer", - "examples": [ - 21 - ] - }, - "changes": { - "type": "integer", - "examples": [ - 124 - ] - }, - "blob_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "raw_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" - ] - }, - "contents_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" - ] - }, - "patch": { - "type": "string", - "examples": [ - "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" - ] - }, - "previous_filename": { - "type": "string", - "examples": [ - "file.txt" - ] - } - }, - "required": [ - "additions", - "blob_url", - "changes", - "contents_url", - "deletions", - "filename", - "raw_url", - "sha", - "status" - ] + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } } + }, + "name": { + "type": "string", + "examples": [ + "\"branch/with/protection\"" + ] + }, + "protection_url": { + "type": "string", + "examples": [ + "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + ] + }, + "enabled": { + "type": "boolean", + "examples": [ + true + ] + } + }, + "required": [ + "url", + "enabled" + ] } - }, - "required": [ - "url", - "sha", - "node_id", - "html_url", - "comments_url", - "commit", - "author", - "committer", - "parents" - ] + } } } } ], - "descriptionHTML": "", "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", "statusCodes": [ { - "httpStatusCode": "201", - "description": "

Successful Response (The resulting merge commit)

" - }, - { - "httpStatusCode": "204", - "description": "

Response when already merged

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" + "httpStatusCode": "200", + "description": "

OK

" }, { "httpStatusCode": "404", - "description": "

Not Found when the base or head does not exist

" - }, - { - "httpStatusCode": "409", - "description": "

Conflict when there is a merge conflict

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed

" + "description": "

Resource not found

" } ] - } - ], - "branch-protection": [ + }, { "serverUrl": "https://HOSTNAME/api/v3", - "verb": "get", + "verb": "put", "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "title": "Get branch protection", + "title": "Update branch protection", "category": "branches", "subcategory": "branch-protection", "parameters": [ @@ -95554,205 +100555,289 @@ "x-multi-segment": true } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "object or null", + "name": "required_status_checks", + "in": "body", + "description": "

Require status checks to pass before merging. Set to null to disable.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "boolean", + "name": "strict", + "description": "

Require branches to be up to date before merging.

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "contexts", + "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", + "isRequired": true + }, + { + "type": "array of objects", + "name": "checks", + "description": "

The list of status checks to require in order to merge into this branch.

", + "childParamsGroups": [ + { + "type": "string", + "name": "context", + "description": "

The name of the required check

", + "isRequired": true + }, + { + "type": "integer", + "name": "app_id", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" + } + ] + } + ] + }, + { + "type": "boolean or null", + "name": "enforce_admins", + "in": "body", + "description": "

Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", + "isRequired": true + }, + { + "type": "object or null", + "name": "required_pull_request_reviews", + "in": "body", + "description": "

Require at least one approving review on a pull request, before merging. Set to null to disable.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "dismissal_restrictions", + "description": "

Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "users", + "description": "

The list of user logins with dismissal access

" + }, + { + "type": "array of strings", + "name": "teams", + "description": "

The list of team slugs with dismissal access

" + }, + { + "type": "array of strings", + "name": "apps", + "description": "

The list of app slugs with dismissal access

" + } + ] + }, + { + "type": "boolean", + "name": "dismiss_stale_reviews", + "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

" + }, + { + "type": "boolean", + "name": "require_code_owner_reviews", + "description": "

Blocks merging pull requests until code owners review them.

" + }, + { + "type": "integer", + "name": "required_approving_review_count", + "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

" + }, + { + "type": "object", + "name": "bypass_pull_request_allowances", + "description": "

Allow specific users, teams, or apps to bypass pull request requirements.

", + "childParamsGroups": [ + { + "type": "array of strings", + "name": "users", + "description": "

The list of user logins allowed to bypass pull request requirements.

" + }, + { + "type": "array of strings", + "name": "teams", + "description": "

The list of team slugs allowed to bypass pull request requirements.

" + }, + { + "type": "array of strings", + "name": "apps", + "description": "

The list of app slugs allowed to bypass pull request requirements.

" + } + ] + } + ] + }, + { + "type": "object or null", + "name": "restrictions", + "in": "body", + "description": "

Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of strings", + "name": "users", + "description": "

The list of user logins with push access

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "teams", + "description": "

The list of team slugs with push access

", + "isRequired": true + }, + { + "type": "array of strings", + "name": "apps", + "description": "

The list of app slugs with push access

" + } + ] + }, + { + "type": "boolean", + "name": "required_linear_history", + "in": "body", + "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

" + }, + { + "type": "boolean or null", + "name": "allow_force_pushes", + "in": "body", + "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

" + }, + { + "type": "boolean", + "name": "allow_deletions", + "in": "body", + "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

" + }, + { + "type": "boolean", + "name": "block_creations", + "in": "body", + "description": "

If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

" + }, + { + "type": "boolean", + "name": "required_conversation_resolution", + "in": "body", + "description": "

Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

" + } + ], "enabledForGitHubApps": true, "codeExamples": [ { "key": "default", "request": { + "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection", + "bodyParameters": { "required_status_checks": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", + "strict": true, "contexts": [ "continuous-integration/travis-ci" - ], - "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts", - "enforcement_level": "non_admins" - }, - "enforce_admins": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", - "enabled": true + ] }, + "enforce_admins": true, "required_pull_request_reviews": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", "dismissal_restrictions": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", - "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", "users": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } + "octocat" ], "teams": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - ], - "apps": [ - { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] - } + "justice-league" ] }, "dismiss_stale_reviews": true, "require_code_owner_reviews": true, - "required_approving_review_count": 2 + "required_approving_review_count": 2, + "bypass_pull_request_allowances": { + "users": [ + "octocat" + ], + "teams": [ + "justice-league" + ] + } }, "restrictions": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", - "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams", - "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps", "users": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } + "octocat" ], "teams": [ - { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } + "justice-league" ], "apps": [ + "super-ci" + ] + }, + "required_linear_history": true, + "allow_force_pushes": true, + "allow_deletions": true, + "block_creations": true, + "required_conversation_resolution": true + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] + "context": "continuous-integration/travis-ci", + "app_id": null } ] }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [], + "teams": [], + "apps": [] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [], + "teams": [], + "apps": [] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, "required_linear_history": { "enabled": true }, @@ -95762,37 +100847,48 @@ "allow_deletions": { "enabled": true }, + "block_creations": { + "enabled": true + }, "required_conversation_resolution": { "enabled": true } }, "schema": { - "title": "Branch Protection", - "description": "Branch Protection", + "title": "Protected Branch", + "description": "Branch protections protect branches", "type": "object", "properties": { "url": { - "type": "string" - }, - "enabled": { - "type": "boolean" + "type": "string", + "format": "uri" }, "required_status_checks": { - "title": "Protected Branch Required Status Check", - "description": "Protected Branch Required Status Check", + "title": "Status Check Policy", + "description": "Status Check Policy", "type": "object", "properties": { "url": { - "type": "string" + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" + ] }, - "enforcement_level": { - "type": "string" + "strict": { + "type": "boolean", + "examples": [ + true + ] }, "contexts": { "type": "array", "items": { "type": "string" - } + }, + "examples": [ + "continuous-integration/travis-ci" + ] }, "checks": { "type": "array", @@ -95800,7 +100896,10 @@ "type": "object", "properties": { "context": { - "type": "string" + "type": "string", + "examples": [ + "continuous-integration/travis-ci" + ] }, "app_id": { "type": [ @@ -95816,58 +100915,53 @@ } }, "contexts_url": { - "type": "string" - }, - "strict": { - "type": "boolean" - } - }, - "required": [ - "contexts", - "checks" - ] - }, - "enforce_admins": { - "title": "Protected Branch Admin Enforced", - "description": "Protected Branch Admin Enforced", - "type": "object", - "properties": { - "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" - ] - }, - "enabled": { - "type": "boolean", - "examples": [ - true + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" ] } }, "required": [ "url", - "enabled" + "contexts_url", + "strict", + "contexts", + "checks" ] }, "required_pull_request_reviews": { - "title": "Protected Branch Pull Request Review", - "description": "Protected Branch Pull Request Review", "type": "object", "properties": { "url": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" - ] + "format": "uri" + }, + "dismiss_stale_reviews": { + "type": "boolean" + }, + "require_code_owner_reviews": { + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" }, "dismissal_restrictions": { "type": "object", "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, "users": { - "description": "The list of users with review dismissal access.", "type": "array", "items": { "title": "Simple User", @@ -96032,7 +101126,6 @@ } }, "teams": { - "description": "The list of teams with review dismissal access.", "type": "array", "items": { "title": "Team", @@ -96236,7 +101329,6 @@ } }, "apps": { - "description": "The list of apps with review dismissal access.", "type": "array", "items": { "title": "GitHub app", @@ -96563,33 +101655,20 @@ "events" ] } - }, - "url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" - ] - }, - "users_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" - ] - }, - "teams_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" - ] } - } + }, + "required": [ + "url", + "users_url", + "teams_url", + "users", + "teams" + ] }, "bypass_pull_request_allowances": { "type": "object", - "description": "Allow specific users, teams, or apps to bypass pull request requirements.", "properties": { "users": { - "description": "The list of users allowed to bypass pull request requirements.", "type": "array", "items": { "title": "Simple User", @@ -96754,7 +101833,6 @@ } }, "teams": { - "description": "The list of teams allowed to bypass pull request requirements.", "type": "array", "items": { "title": "Team", @@ -96958,7 +102036,6 @@ } }, "apps": { - "description": "The list of apps allowed to bypass pull request requirements.", "type": "array", "items": { "title": "GitHub app", @@ -97286,32 +102363,90 @@ ] } } - } - }, - "dismiss_stale_reviews": { - "type": "boolean", + }, + "required": [ + "users", + "teams" + ] + } + }, + "required": [ + "url" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", "examples": [ - true + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" ] }, - "require_code_owner_reviews": { + "enabled": { "type": "boolean", "examples": [ true ] + } + }, + "required": [ + "url", + "enabled" + ] + }, + "enforce_admins": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" }, - "required_approving_review_count": { - "type": "integer", - "minimum": 0, - "maximum": 6, - "examples": [ - 2 - ] + "enabled": { + "type": "boolean" } }, + "additionalProperties": false, "required": [ - "dismiss_stale_reviews", - "require_code_owner_reviews" + "url", + "enabled" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" ] }, "restrictions": { @@ -97623,29 +102758,14 @@ "apps" ] }, - "required_linear_history": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "allow_force_pushes": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "allow_deletions": { + "required_conversation_resolution": { "type": "object", "properties": { "enabled": { "type": "boolean" } - } + }, + "additionalProperties": false }, "block_creations": { "type": "object", @@ -97653,340 +102773,17 @@ "enabled": { "type": "boolean" } - } - }, - "required_conversation_resolution": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "name": { - "type": "string", - "examples": [ - "\"branch/with/protection\"" - ] - }, - "protection_url": { - "type": "string", - "examples": [ - "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" - ] - }, - "required_signatures": { - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" - ] - }, - "enabled": { - "type": "boolean", - "examples": [ - true - ] - } }, + "additionalProperties": false, "required": [ - "url", "enabled" ] } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ] - }, - { - "serverUrl": "https://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection", - "title": "Update branch protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "object or null", - "name": "required_status_checks", - "in": "body", - "description": "

Require status checks to pass before merging. Set to null to disable.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "boolean", - "name": "strict", - "description": "

Require branches to be up to date before merging.

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "contexts", - "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

", - "isRequired": true - }, - { - "type": "array of objects", - "name": "checks", - "description": "

The list of status checks to require in order to merge into this branch.

", - "childParamsGroups": [ - { - "type": "string", - "name": "context", - "description": "

The name of the required check

", - "isRequired": true - }, - { - "type": "integer", - "name": "app_id", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" - } - ] - } - ] - }, - { - "type": "boolean or null", - "name": "enforce_admins", - "in": "body", - "description": "

Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

", - "isRequired": true - }, - { - "type": "object or null", - "name": "required_pull_request_reviews", - "in": "body", - "description": "

Require at least one approving review on a pull request, before merging. Set to null to disable.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "object", - "name": "dismissal_restrictions", - "description": "

Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "users", - "description": "

The list of user logins with dismissal access

" - }, - { - "type": "array of strings", - "name": "teams", - "description": "

The list of team slugs with dismissal access

" - }, - { - "type": "array of strings", - "name": "apps", - "description": "

The list of app slugs with dismissal access

" - } - ] - }, - { - "type": "boolean", - "name": "dismiss_stale_reviews", - "description": "

Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

" - }, - { - "type": "boolean", - "name": "require_code_owner_reviews", - "description": "

Blocks merging pull requests until code owners review them.

" - }, - { - "type": "integer", - "name": "required_approving_review_count", - "description": "

Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.

" - }, - { - "type": "object", - "name": "bypass_pull_request_allowances", - "description": "

Allow specific users, teams, or apps to bypass pull request requirements.

", - "childParamsGroups": [ - { - "type": "array of strings", - "name": "users", - "description": "

The list of user logins allowed to bypass pull request requirements.

" - }, - { - "type": "array of strings", - "name": "teams", - "description": "

The list of team slugs allowed to bypass pull request requirements.

" - }, - { - "type": "array of strings", - "name": "apps", - "description": "

The list of app slugs allowed to bypass pull request requirements.

" - } - ] - } - ] - }, - { - "type": "object or null", - "name": "restrictions", - "in": "body", - "description": "

Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of strings", - "name": "users", - "description": "

The list of user logins with push access

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "teams", - "description": "

The list of team slugs with push access

", - "isRequired": true - }, - { - "type": "array of strings", - "name": "apps", - "description": "

The list of app slugs with push access

" - } - ] - }, - { - "type": "boolean", - "name": "required_linear_history", - "in": "body", - "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

" - }, - { - "type": "boolean or null", - "name": "allow_force_pushes", - "in": "body", - "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

" - }, - { - "type": "boolean", - "name": "allow_deletions", - "in": "body", - "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

" - }, - { - "type": "boolean", - "name": "block_creations", - "in": "body", - "description": "

If set to true, the restrictions branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to true to restrict new branch creation. Default: false.

" - }, - { - "type": "boolean", - "name": "required_conversation_resolution", - "in": "body", - "description": "

Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to false to disable. Default: false.

" - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "required_status_checks": { - "strict": true, - "contexts": [ - "continuous-integration/travis-ci" - ] - }, - "enforce_admins": true, - "required_pull_request_reviews": { - "dismissal_restrictions": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ] - }, - "dismiss_stale_reviews": true, - "require_code_owner_reviews": true, - "required_approving_review_count": 2, - "bypass_pull_request_allowances": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ] - } - }, - "restrictions": { - "users": [ - "octocat" - ], - "teams": [ - "justice-league" - ], - "apps": [ - "super-ci" - ] }, - "required_linear_history": true, - "allow_force_pushes": true, - "allow_deletions": true, - "block_creations": true, - "required_conversation_resolution": true - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" + "required": [ + "url" + ] } - }, - "response": { - "statusCode": "200", - "description": "

Response

" } } ], @@ -102192,36 +106989,347 @@ } ], "bodyParameters": [ - { - "type": "boolean", - "name": "strict", - "in": "body", - "description": "

Require branches to be up to date before merging.

" - }, + { + "type": "boolean", + "name": "strict", + "in": "body", + "description": "

Require branches to be up to date before merging.

" + }, + { + "type": "array of strings", + "name": "contexts", + "in": "body", + "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

" + }, + { + "type": "array of objects", + "name": "checks", + "in": "body", + "description": "

The list of status checks to require in order to merge into this branch.

", + "childParamsGroups": [ + { + "type": "string", + "name": "context", + "description": "

The name of the required check

", + "isRequired": true + }, + { + "type": "integer", + "name": "app_id", + "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" + } + ] + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ] + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + }, + "schema": { + "title": "Status Check Policy", + "description": "Status Check Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" + ] + }, + "strict": { + "type": "boolean", + "examples": [ + true + ] + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "continuous-integration/travis-ci" + ] + }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "examples": [ + "continuous-integration/travis-ci" + ] + }, + "app_id": { + "type": [ + "integer", + "null" + ] + } + }, + "required": [ + "context", + "app_id" + ] + } + }, + "contexts_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + ] + } + }, + "required": [ + "url", + "contexts_url", + "strict", + "contexts", + "checks" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed

" + } + ] + }, + { + "serverUrl": "https://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + "title": "Remove status check protection", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + } + ] + }, + { + "serverUrl": "https://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "title": "Get all status check contexts", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "branch": "BRANCH" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + "continuous-integration/travis-ci" + ], + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "title": "Add status check contexts", + "category": "branches", + "subcategory": "branch-protection", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "

The name of the branch.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "bodyParameters": [ { "type": "array of strings", "name": "contexts", "in": "body", - "description": "

Deprecated: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use checks instead of contexts for more fine-grained control.

" - }, - { - "type": "array of objects", - "name": "checks", - "in": "body", - "description": "

The list of status checks to require in order to merge into this branch.

", - "childParamsGroups": [ - { - "type": "string", - "name": "context", - "description": "

The name of the required check

", - "isRequired": true - }, - { - "type": "integer", - "name": "app_id", - "description": "

The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.

" - } - ] + "description": "

The name of the status checks

", + "isRequired": true } ], "enabledForGitHubApps": true, @@ -102230,12 +107338,12 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding status checks to a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "strict": true, "contexts": [ - "continuous-integration/travis-ci" + "continuous-integration/travis-ci", + "continuous-integration/jenkins" ] }, "parameters": { @@ -102244,311 +107352,6 @@ "branch": "BRANCH" } }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", - "strict": true, - "contexts": [ - "continuous-integration/travis-ci" - ], - "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" - }, - "schema": { - "title": "Status Check Policy", - "description": "Status Check Policy", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" - ] - }, - "strict": { - "type": "boolean", - "examples": [ - true - ] - }, - "contexts": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "continuous-integration/travis-ci" - ] - }, - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "context": { - "type": "string", - "examples": [ - "continuous-integration/travis-ci" - ] - }, - "app_id": { - "type": [ - "integer", - "null" - ] - } - }, - "required": [ - "context", - "app_id" - ] - } - }, - "contexts_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" - ] - } - }, - "required": [ - "url", - "contexts_url", - "strict", - "contexts", - "checks" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed

" - } - ] - }, - { - "serverUrl": "https://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "title": "Remove status check protection", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - } - ] - }, - { - "serverUrl": "https://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "title": "Get all status check contexts", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - "continuous-integration/travis-ci" - ], - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ] - }, - { - "serverUrl": "https://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "title": "Add status check contexts", - "category": "branches", - "subcategory": "branch-protection", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "branch", - "description": "

The name of the branch.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "x-multi-segment": true - } - ], - "bodyParameters": [ - { - "type": "array of strings", - "name": "contexts", - "in": "body", - "description": "

contexts parameter

", - "isRequired": true - } - ], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "branch": "BRANCH" - } - }, "response": { "statusCode": "200", "contentType": "application/json", @@ -102629,7 +107432,7 @@ "type": "array of strings", "name": "contexts", "in": "body", - "description": "

contexts parameter

", + "description": "

The name of the status checks

", "isRequired": true } ], @@ -102639,8 +107442,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example updating status checks for a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -102722,7 +107530,7 @@ "type": "array of strings", "name": "contexts", "in": "body", - "description": "

contexts parameter

", + "description": "

The name of the status checks

", "isRequired": true } ], @@ -102732,8 +107540,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing status checks from a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "contexts": [ + "continuous-integration/travis-ci" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -105427,7 +110240,7 @@ "type": "array of strings", "name": "teams", "in": "body", - "description": "

teams parameter

", + "description": "

The slug values for teams

", "isRequired": true } ], @@ -105437,8 +110250,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -105726,7 +110544,7 @@ "type": "array of strings", "name": "teams", "in": "body", - "description": "

teams parameter

", + "description": "

The slug values for teams

", "isRequired": true } ], @@ -105736,8 +110554,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -106025,7 +110848,7 @@ "type": "array of strings", "name": "teams", "in": "body", - "description": "

teams parameter

", + "description": "

The slug values for teams

", "isRequired": true } ], @@ -106035,8 +110858,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a team in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "teams": [ + "justice-league" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -106581,7 +111409,7 @@ "type": "array of strings", "name": "users", "in": "body", - "description": "

users parameter

", + "description": "

The username for users

", "isRequired": true } ], @@ -106591,8 +111419,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example adding a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -106847,7 +111680,7 @@ "type": "array of strings", "name": "users", "in": "body", - "description": "

users parameter

", + "description": "

The username for users

", "isRequired": true } ], @@ -106857,8 +111690,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example replacing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -107113,7 +111951,7 @@ "type": "array of strings", "name": "users", "in": "body", - "description": "

users parameter

", + "description": "

The username for users

", "isRequired": true } ], @@ -107123,8 +111961,13 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example removing a user in a branch protection rule", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "users": [ + "octocat" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -118255,6 +123098,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -121338,6 +126185,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -123939,6 +128790,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -126959,6 +131814,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -130086,6 +134945,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -131178,7 +136041,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -131505,6 +136369,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -131781,7 +136652,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -132108,6 +136980,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -132315,275 +137194,302 @@ }, { "name": "ref", - "description": "

The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

", + "description": "

The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "alert_number": "ALERT_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "lib/ab12-gen.js", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "library" + ] + }, + { + "ref": "refs/pull/3740/merge", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "state": "fixed", + "commit_sha": "b09da05606e27f463a2b49287684b4ae777092f2", + "message": { + "text": "This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1." + }, + "location": { + "path": "app/script.js", + "start_line": 2, + "end_line": 2, + "start_column": 10, + "end_column": 50 + }, + "classifications": [ + "source" + ] + } + ], + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." + }, + "analysis_key": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." + }, + "environment": { + "type": "string", + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed." + }, + "category": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code." + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "closed", + "dismissed", + "fixed" + ] + }, + "commit_sha": { + "type": "string" + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "location": { + "type": "object", + "description": "Describe a region within a file for the alert.", + "properties": { + "path": { + "type": "string" + }, + "start_line": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "start_column": { + "type": "integer" + }, + "end_column": { + "type": "integer" + } + } + }, + "html_url": { + "type": "string" + }, + "classifications": { + "type": "array", + "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.", + "items": { + "type": [ + "string", + "null" + ], + "description": "A classification of the file. For example to identify it as generated.", + "enum": [ + "source", + "generated", + "test", + "library", + null + ] + } + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists all instances of the specified code scanning alert. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events read permission to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "403", + "description": "

Response if GitHub Advanced Security is not enabled for this repository

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" + } + ], + "subcategory": "code-scanning" + }, + { + "serverUrl": "https://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses", + "title": "List code scanning analyses for a repository", + "category": "code-scanning", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "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": "page", + "description": "

Page number of the results to fetch.

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100).

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "ref", "in": "query", + "description": "

The Git reference for the analyses you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

", "required": false, "schema": { "type": "string", "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." } - } - ], - "bodyParameters": [], - "enabledForGitHubApps": true, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "alert_number": "ALERT_NUMBER" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "ref": "refs/heads/main", - "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "environment": "", - "state": "open", - "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", - "message": { - "text": "This path depends on a user-provided value." - }, - "location": { - "path": "lib/ab12-gen.js", - "start_line": 917, - "end_line": 917, - "start_column": 7, - "end_column": 18 - }, - "classifications": [ - "library" - ] - }, - { - "ref": "refs/pull/3740/merge", - "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "environment": "", - "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "state": "fixed", - "commit_sha": "b09da05606e27f463a2b49287684b4ae777092f2", - "message": { - "text": "This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1." - }, - "location": { - "path": "app/script.js", - "start_line": 2, - "end_line": 2, - "start_column": 10, - "end_column": 50 - }, - "classifications": [ - "source" - ] - } - ], - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "ref": { - "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." - }, - "analysis_key": { - "type": "string", - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." - }, - "environment": { - "type": "string", - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed." - }, - "category": { - "type": "string", - "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code." - }, - "state": { - "type": "string", - "description": "State of a code scanning alert.", - "enum": [ - "open", - "closed", - "dismissed", - "fixed" - ] - }, - "commit_sha": { - "type": "string" - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - }, - "location": { - "type": "object", - "description": "Describe a region within a file for the alert.", - "properties": { - "path": { - "type": "string" - }, - "start_line": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "start_column": { - "type": "integer" - }, - "end_column": { - "type": "integer" - } - } - }, - "html_url": { - "type": "string" - }, - "classifications": { - "type": "array", - "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.", - "items": { - "type": [ - "string", - "null" - ], - "description": "A classification of the file. For example to identify it as generated.", - "enum": [ - "source", - "generated", - "test", - "library", - null - ] - } - } - } - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Lists all instances of the specified code scanning alert. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events read permission to use this endpoint.

", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "403", - "description": "

Response if GitHub Advanced Security is not enabled for this repository

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "503", - "description": "

Service unavailable

" - } - ], - "subcategory": "code-scanning" - }, - { - "serverUrl": "https://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses", - "title": "List code scanning analyses for a repository", - "category": "code-scanning", - "parameters": [ - { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, { - "name": "repo", - "description": "

The name of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "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.

", + "name": "sarif_id", "in": "query", + "description": "

Filter analyses belonging to the same SARIF upload.

", "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": "page", - "description": "

Page number of the results to fetch.

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100).

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 + "description": "An identifier for the upload.", + "examples": [ + "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53" + ] } }, { - "name": "ref", + "name": "direction", + "description": "

The direction to sort the results by.

", "in": "query", - "description": "

The Git reference for the analyses you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

", "required": false, "schema": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." + "enum": [ + "asc", + "desc" + ], + "default": "desc" } }, { - "name": "sarif_id", + "name": "sort", + "description": "

The property by which to sort the results.

", "in": "query", - "description": "

Filter analyses belonging to the same SARIF upload.

", "required": false, "schema": { "type": "string", - "description": "An identifier for the upload.", - "examples": [ - "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53" - ] + "enum": [ + "created" + ], + "default": "created" } } ], @@ -136139,6 +141045,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -139251,6 +144161,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -139948,8 +144862,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example request body", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permissions": "write" + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -141981,6 +146898,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -144749,6 +149670,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -149853,6 +154778,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -151421,6 +156350,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -152934,6 +157867,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ] }, @@ -155515,6 +160452,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ] } @@ -159856,6 +164797,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -175369,14 +180314,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -176293,14 +181230,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -177088,14 +182017,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -194633,6 +199554,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -198057,6 +202982,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -198893,7 +203822,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ], "schema": { @@ -201398,6 +206328,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -202174,7 +207108,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -204676,6 +209611,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -205419,7 +210358,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -207921,6 +212861,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -208516,6 +213460,12 @@ "closed" ] }, + { + "type": "string or null", + "name": "state_reason", + "in": "body", + "description": "

The reason for the current state

" + }, { "type": "null or string or integer or string or integer", "name": "milestone", @@ -208720,7 +213670,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -211222,6 +216173,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -214816,6 +219771,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -215898,7 +220857,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -218400,6 +223360,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -219137,7 +224101,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" }, "schema": { "title": "Issue", @@ -221639,6 +226604,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -226270,7 +231239,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ], @@ -229004,6 +233974,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -231138,7 +236112,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } }, "schema": { @@ -233869,6 +238844,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -261363,6 +266342,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -268949,6 +273932,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -270866,6 +275853,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -272755,6 +277746,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -274624,6 +279619,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -276540,6 +281539,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -278792,6 +283795,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -279654,6 +284661,48 @@ "updated_at": { "type": "string", "format": "date-time" + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] } }, "required": [ @@ -279857,6 +284906,42 @@ "name": "blog", "in": "body", "description": "" + }, + { + "type": "boolean", + "name": "advanced_security_enabled_for_new_repositories", + "in": "body", + "description": "

Whether GitHub Advanced Security is automatically enabled for new repositories.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + }, + { + "type": "boolean", + "name": "dependabot_alerts_enabled_for_new_repositories", + "in": "body", + "description": "

Whether Dependabot alerts is automatically enabled for new repositories.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + }, + { + "type": "boolean", + "name": "dependabot_security_updates_enabled_for_new_repositories", + "in": "body", + "description": "

Whether Dependabot security updates is automatically enabled for new repositories.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + }, + { + "type": "boolean", + "name": "dependency_graph_enabled_for_new_repositories", + "in": "body", + "description": "

Whether dependency graph is automatically enabled for new repositories.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + }, + { + "type": "boolean", + "name": "secret_scanning_enabled_for_new_repositories", + "in": "body", + "description": "

Whether secret scanning is automatically enabled for new repositories.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + }, + { + "type": "boolean", + "name": "secret_scanning_push_protection_enabled_for_new_repositories", + "in": "body", + "description": "

Whether secret scanning push protection is automatically enabled for new repositories.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" } ], "enabledForGitHubApps": true, @@ -280285,6 +285370,48 @@ "updated_at": { "type": "string", "format": "date-time" + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] } }, "required": [ @@ -281203,14 +286330,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -282336,10 +287455,6 @@ "httpStatusCode": "200", "description": "

OK

" }, - { - "httpStatusCode": "302", - "description": "

Response if requester is not an organization member

" - }, { "httpStatusCode": "422", "description": "

Validation failed

" @@ -298718,6 +303833,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -300286,6 +305405,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -308615,6 +313738,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ], "subcategory": "pulls" @@ -313526,6 +318653,10 @@ { "httpStatusCode": "500", "description": "

Internal Error

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ], "subcategory": "pulls" @@ -321685,6 +326816,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -323253,6 +328388,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -327211,6 +332350,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -328779,6 +333922,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -348861,6 +354008,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -350749,6 +355900,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -353350,6 +358505,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -355027,6 +360186,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -356406,6 +361569,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -359424,6 +364591,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -361101,6 +366272,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -362480,6 +367655,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -366183,6 +371362,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -367933,6 +373116,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -368015,7 +373202,7 @@ } ], "previews": [], - "descriptionHTML": "

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

\n

OAuth scope requirements

\n

When using OAuth, authorizations must include:

\n
    \n
  • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
  • \n
  • repo scope to create a private repository
  • \n
", + "descriptionHTML": "

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

\n

OAuth scope requirements

\n

When using OAuth, authorizations must include:

\n
    \n
  • public_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.
  • \n
  • repo scope to create a private repository
  • \n
", "statusCodes": [ { "httpStatusCode": "201", @@ -369582,6 +374769,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -371295,6 +376486,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -373504,6 +378699,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -373905,6 +379104,13 @@ "in": "body", "description": "

The URL must contain <num> for the reference number.

", "isRequired": true + }, + { + "type": "boolean", + "name": "is_alphanumeric", + "in": "body", + "description": "

Whether this autolink reference matches alphanumeric characters. If true, the <num> parameter of the url_template matches alphanumeric characters A-Z (case insensitive), 0-9, and -. If false, this autolink reference only matches numeric characters.

", + "default": "true" } ], "enabledForGitHubApps": true, @@ -373917,7 +379123,8 @@ "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=" + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true }, "parameters": { "owner": "OWNER", @@ -379587,6 +384794,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -382355,6 +387566,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -384032,6 +389247,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -385411,6 +390630,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -387908,6 +393131,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -390724,6 +395951,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -391223,7 +396454,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] }, @@ -393584,6 +398816,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -402660,6 +407896,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -405273,6 +410513,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -411130,6 +416374,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -413737,6 +418985,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index dcaeca741dc8..81a0f9d5df9f 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -2854,14 +2854,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -3006,6 +2998,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -3791,14 +3791,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -3943,6 +3935,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -4514,14 +4514,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -4666,6 +4658,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -4807,14 +4807,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -4959,6 +4951,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -6417,6 +6417,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -7458,14 +7462,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -7610,6 +7606,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -8432,14 +8436,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -8584,6 +8580,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -9278,14 +9282,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -9430,6 +9426,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -9826,14 +9830,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -9978,6 +9974,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -17674,6 +17678,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -19233,6 +19241,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -21225,6 +21237,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -27158,6 +27177,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -42191,6 +42214,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -45236,6 +45263,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -52091,6 +52122,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -55498,6 +55533,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -58171,6 +58210,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -59363,7 +59406,7 @@ "/organizations/{organization_id}/custom_roles": { "get": { "summary": "List custom repository roles in an organization", - "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".", + "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.\nGitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".", "tags": [ "orgs" ], @@ -59823,6 +59866,48 @@ "updated_at": { "type": "string", "format": "date-time" + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] } }, "required": [ @@ -60077,6 +60162,30 @@ "examples": [ "\"http://github.blog\"" ] + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether Dependabot alerts is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether Dependabot security updates is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether dependency graph is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning push protection is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." } } }, @@ -60448,6 +60557,48 @@ "updated_at": { "type": "string", "format": "date-time" + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] } }, "required": [ @@ -62677,6 +62828,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -66135,6 +66290,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -68994,6 +69153,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -70553,6 +70716,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -74303,6 +74470,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -76029,6 +76200,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -79431,6 +79609,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -79970,6 +80152,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -83370,6 +83562,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -86622,6 +86818,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -91569,14 +91769,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -91721,6 +91913,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -92520,14 +92720,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -92672,6 +92864,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -97395,6 +97595,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -98486,17 +98690,6 @@ } } }, - "302": { - "description": "Response if requester is not an organization member", - "headers": { - "Location": { - "example": "https://api.github.com/orgs/github/public_members", - "schema": { - "type": "string" - } - } - } - }, "422": { "description": "Validation failed", "content": { @@ -101250,6 +101443,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -101789,6 +101986,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -104870,6 +105077,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -106899,6 +107110,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -108955,6 +109170,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -111531,6 +111750,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -114648,6 +114871,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -117297,6 +117524,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -122201,6 +122432,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -124127,6 +124362,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -139636,6 +139875,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -142185,6 +142428,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -143462,6 +143709,78 @@ } } }, + "/orgs/{org}/{security_product}/{enablement}": { + "post": { + "summary": "Enable or disable a security feature for an organization", + "description": "Enables or disables the specified security feature for all repositories in an organization.\n\nTo use this endpoint, you must be an organization owner or be member of a team with the security manager role.\nA token with the 'write:org' scope is also required.\n\nGitHub Apps must have the `organization_administration:write` permission to use this endpoint.\n\nFor more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", + "tags": [ + "orgs" + ], + "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#enable-or-disable-security-product-on-all-org-repos" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "security_product", + "in": "path", + "description": "The security feature to enable or disable.", + "required": true, + "schema": { + "type": "string", + "enum": [ + "dependency_graph", + "dependabot_alerts", + "dependabot_security_updates", + "advanced_security", + "secret_scanning", + "secret_scanning_push_protection" + ] + } + }, + { + "name": "enablement", + "in": "path", + "description": "The action to take.\n\n`enable_all` means to enable the specified security feature for all repositories in the organization.\n`disable_all` means to disable the specified security feature for all repositories in the organization.", + "required": true, + "schema": { + "type": "string", + "enum": [ + "enable_all", + "disable_all" + ] + } + } + ], + "responses": { + "204": { + "description": "Action started" + }, + "422": { + "description": "The action could not be taken due to an in progress enablement, or a policy is preventing enablement" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/projects/columns/cards/{card_id}": { "get": { "summary": "Get a project card", @@ -151722,6 +152041,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -153521,6 +153844,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -154976,6 +155303,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -158099,6 +158430,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -159898,6 +160233,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -161353,6 +161692,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -166950,6 +167293,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -168518,6 +168865,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -172609,6 +172960,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -174813,6 +175168,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -178072,6 +178431,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -180276,6 +180639,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -184338,6 +184705,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -186542,6 +186913,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -194150,6 +194525,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -196354,6 +196733,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -197443,14 +197826,18 @@ ] }, "is_alphanumeric": { - "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference is a legacy autolink that only matches numeric characters.", - "type": "boolean" + "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.", + "type": "boolean", + "examples": [ + true + ] } }, "required": [ "id", "key_prefix", - "url_template" + "url_template", + "is_alphanumeric" ] } }, @@ -197517,11 +197904,16 @@ "properties": { "key_prefix": { "type": "string", - "description": "The prefix appended by alphanumeric characters will generate a link any time it is found in an issue, pull request, or commit." + "description": "This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit." }, "url_template": { "type": "string", - "description": "The URL must contain `` for the reference number. `` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`." + "description": "The URL must contain `` for the reference number. `` matches different characters depending on the value of `is_alphanumeric`." + }, + "is_alphanumeric": { + "type": "boolean", + "default": "true", + "description": "Whether this autolink reference matches alphanumeric characters. If true, the `` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters." } }, "required": [ @@ -197533,7 +197925,8 @@ "default": { "value": { "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=" + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true } } } @@ -197571,14 +197964,18 @@ ] }, "is_alphanumeric": { - "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference is a legacy autolink that only matches numeric characters.", - "type": "boolean" + "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.", + "type": "boolean", + "examples": [ + true + ] } }, "required": [ "id", "key_prefix", - "url_template" + "url_template", + "is_alphanumeric" ] }, "examples": { @@ -197758,14 +198155,18 @@ ] }, "is_alphanumeric": { - "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference is a legacy autolink that only matches numeric characters.", - "type": "boolean" + "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.", + "type": "boolean", + "examples": [ + true + ] } }, "required": [ "id", "key_prefix", - "url_template" + "url_template", + "is_alphanumeric" ] }, "examples": { @@ -202802,6 +203203,115 @@ "protected", "protection_url" ] + }, + "examples": { + "default": { + "value": { + "name": "main", + "commit": { + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", + "commit": { + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", + "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] + }, + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" + }, + "protected": false, + "protection": { + "enabled": false, + "required_status_checks": { + "enforcement_level": "off", + "contexts": [ + + ], + "checks": [ + + ] + } + }, + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" + } + } } } } @@ -207309,6 +207819,85 @@ "required": [ "url" ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ + { + "context": "continuous-integration/travis-ci", + "app_id": null + } + ] + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "block_creations": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + } + } } } } @@ -212195,7 +212784,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -212212,12 +212801,23 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding status checks to a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci", + "continuous-integration/jenkins" + ] + } + } } } } @@ -212432,7 +213032,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -212449,12 +213049,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example updating status checks for a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -212641,7 +213251,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -212658,12 +213268,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing status checks from a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -215785,7 +216405,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -215802,12 +216422,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -216179,7 +216809,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -216190,18 +216820,28 @@ ], "example": { "teams": [ - "my-team" + "justice-league" ] } }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -216572,7 +217212,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -216589,12 +217229,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -217241,7 +217891,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -217263,6 +217913,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example adding a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -217601,7 +218261,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -217623,6 +218283,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -217960,7 +218630,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -217982,6 +218652,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example removing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -228410,6 +229090,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -231562,6 +232246,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -234310,6 +234998,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -237341,6 +238033,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -240497,6 +241193,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -240666,7 +241369,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -241205,6 +241909,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -241374,7 +242085,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -241659,6 +242371,7 @@ "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "state": "open", "fixed_at": null, "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", @@ -241880,6 +242593,33 @@ "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53" ] } + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "The property by which to sort the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created" + ], + "default": "created" + } } ], "responses": { @@ -242466,7 +243206,7 @@ }, "delete": { "summary": "Delete a code scanning analysis from a repository", - "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` scope.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `analysis_key`\n* `environment`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.", + "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` scope.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `category`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.", "operationId": "code-scanning/delete-analysis", "tags": [ "code-scanning" @@ -245634,6 +246374,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -246173,6 +246917,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -249043,6 +249797,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -249582,6 +250340,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -252095,6 +252863,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -252634,6 +253406,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -256829,6 +257611,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -265608,6 +266394,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -267252,6 +268042,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -269400,6 +270194,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -273296,6 +274111,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -275973,6 +276792,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -279712,8 +280535,8 @@ } } }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -279738,8 +280561,8 @@ } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -279763,6 +280586,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -294000,6 +294844,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -297312,6 +298160,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -297805,6 +298657,10 @@ "name": { "type": "string", "description": "When forking from an existing repository, a new name for the fork." + }, + "default_branch_only": { + "type": "boolean", + "description": "When forking from an existing repository, fork with only the default branch." } } } @@ -299844,6 +300700,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -301643,6 +302503,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -303098,6 +303962,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -312912,14 +313780,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -313064,6 +313924,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -313678,6 +314546,15 @@ "required": [ "limit" ] + }, + "examples": { + "default": { + "summary": "Example request body", + "value": { + "limit": "collaborators_only", + "expiry": "one_day" + } + } } } } @@ -315830,6 +316707,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -316661,6 +317542,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example request body", + "value": { + "permissions": "write" + } + } } } } @@ -318649,6 +319538,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -322194,6 +323087,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -322855,7 +323752,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -325727,6 +326625,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -326386,7 +327288,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -333091,6 +333994,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -335118,7 +336025,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ] @@ -338068,6 +338976,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -340133,7 +341045,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -342850,6 +343763,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -343509,7 +344426,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -343690,6 +344608,16 @@ "closed" ] }, + "state_reason": { + "type": [ + "string", + "null" + ], + "description": "The reason for the current state", + "examples": [ + "not_planned" + ] + }, "milestone": { "oneOf": [ { @@ -346349,6 +347277,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -347008,7 +347940,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -349875,6 +350808,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -350534,7 +351471,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -353198,6 +354136,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -353857,7 +354799,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -380281,6 +381224,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -391457,6 +392404,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -398881,6 +399832,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -400525,6 +401480,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -412679,8 +413638,8 @@ "304": { "description": "Not modified" }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -412705,8 +413664,8 @@ } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -412730,6 +413689,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -419122,6 +420102,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -419661,6 +420645,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -422174,6 +423168,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -422713,6 +423711,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -426294,357 +427302,22 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "pulls", - "subcategory": null - } - } - }, - "/repos/{owner}/{repo}/pulls/{pull_number}/merge": { - "get": { - "summary": "Check if a pull request has been merged", - "description": "", - "tags": [ - "pulls" - ], - "operationId": "pulls/check-if-merged", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/pulls#check-if-a-pull-request-has-been-merged" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response if pull request has been merged" - }, - "404": { - "description": "Not Found if pull request has not been merged" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "pulls", - "subcategory": null - } - }, - "put": { - "summary": "Merge a pull request", - "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.", - "tags": [ - "pulls" - ], - "operationId": "pulls/merge", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/pulls#merge-a-pull-request" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": [ - "object", - "null" - ], - "properties": { - "commit_title": { - "type": "string", - "description": "Title for the automatic commit message." - }, - "commit_message": { - "type": "string", - "description": "Extra detail to append to automatic commit message." - }, - "sha": { - "type": "string", - "description": "SHA that pull request head must match to allow merge." - }, - "merge_method": { - "type": "string", - "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "if merge was successful", - "content": { - "application/json": { - "schema": { - "title": "Pull Request Merge Result", - "description": "Pull Request Merge Result", - "type": "object", - "properties": { - "sha": { - "type": "string" - }, - "merged": { - "type": "boolean" - }, - "message": { - "type": "string" - } - }, - "required": [ - "merged", - "message", - "sha" - ] - }, - "examples": { - "response-if-merge-was-successful": { - "value": { - "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "merged": true, - "message": "Pull Request successfully merged" - } - } - } - } - } - }, - "405": { - "description": "Method Not Allowed if merge cannot be performed", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-merge-cannot-be-performed": { - "value": { - "message": "Pull Request is not mergeable" - } - } - } - } - } }, - "409": { - "description": "Conflict if sha was provided and pull request head did not match", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-sha-was-provided-and-pull-request-head-did-not-match": { - "value": { - "message": "Head branch was modified. Review and try the merge again." - } - } - } - } - } - }, - "422": { - "description": "Validation failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden", + "503": { + "description": "Service unavailable", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { + "code": { "type": "string" }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" } } } @@ -426653,7 +427326,6 @@ } }, "x-github": { - "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "pulls", @@ -426661,17 +427333,374 @@ } } }, - "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { + "/repos/{owner}/{repo}/pulls/{pull_number}/merge": { "get": { - "summary": "Get all requested reviewers for a pull request", - "description": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", + "summary": "Check if a pull request has been merged", + "description": "", "tags": [ "pulls" ], - "operationId": "pulls/list-requested-reviewers", + "operationId": "pulls/check-if-merged", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/pulls#get-all-requested-reviewers-for-a-pull-request" + "url": "https://docs.github.com/rest/reference/pulls#check-if-a-pull-request-has-been-merged" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response if pull request has been merged" + }, + "404": { + "description": "Not Found if pull request has not been merged" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": null + } + }, + "put": { + "summary": "Merge a pull request", + "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.", + "tags": [ + "pulls" + ], + "operationId": "pulls/merge", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/pulls#merge-a-pull-request" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": [ + "object", + "null" + ], + "properties": { + "commit_title": { + "type": "string", + "description": "Title for the automatic commit message." + }, + "commit_message": { + "type": "string", + "description": "Extra detail to append to automatic commit message." + }, + "sha": { + "type": "string", + "description": "SHA that pull request head must match to allow merge." + }, + "merge_method": { + "type": "string", + "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "if merge was successful", + "content": { + "application/json": { + "schema": { + "title": "Pull Request Merge Result", + "description": "Pull Request Merge Result", + "type": "object", + "properties": { + "sha": { + "type": "string" + }, + "merged": { + "type": "boolean" + }, + "message": { + "type": "string" + } + }, + "required": [ + "merged", + "message", + "sha" + ] + }, + "examples": { + "response-if-merge-was-successful": { + "value": { + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "merged": true, + "message": "Pull Request successfully merged" + } + } + } + } + } + }, + "405": { + "description": "Method Not Allowed if merge cannot be performed", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + }, + "examples": { + "response-if-merge-cannot-be-performed": { + "value": { + "message": "Pull Request is not mergeable" + } + } + } + } + } + }, + "409": { + "description": "Conflict if sha was provided and pull request head did not match", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + }, + "examples": { + "response-if-sha-was-provided-and-pull-request-head-did-not-match": { + "value": { + "message": "Head branch was modified. Review and try the merge again." + } + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": null + } + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { + "get": { + "summary": "Get all requested reviewers for a pull request", + "description": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", + "tags": [ + "pulls" + ], + "operationId": "pulls/list-requested-reviewers", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/pulls#get-all-requested-reviewers-for-a-pull-request" }, "parameters": [ { @@ -430031,6 +431060,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -431675,6 +432708,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -435783,6 +436820,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -437427,6 +438468,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -459361,6 +460406,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -460038,7 +461087,7 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -461495,6 +462544,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -463710,6 +464763,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -472626,6 +473683,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -475582,6 +476643,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -478547,6 +479612,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -479143,7 +480212,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -493302,6 +494372,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -495871,6 +496945,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -502028,6 +503106,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -502567,6 +503649,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -505620,6 +506712,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -506159,6 +507255,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -508672,6 +509778,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -509211,6 +510321,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -512014,6 +513134,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -515439,6 +516563,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -515978,6 +517106,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -518663,6 +519801,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -519202,6 +520344,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -522689,6 +523841,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -523228,6 +524384,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -526001,6 +527167,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -526540,6 +527710,16 @@ "examples": [ "2011-01-26T20:01:12Z" ] + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": [ + "string", + "null" + ], + "examples": [ + "you've used 100% of your spending limit for Codespaces" + ] } }, "required": [ @@ -530621,14 +531801,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -530773,6 +531945,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -532725,6 +533905,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -536219,6 +537403,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -541789,6 +542977,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -543882,6 +545074,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -545951,6 +547147,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -548686,6 +549886,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -551568,6 +552772,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -554156,6 +555364,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -557819,6 +559031,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -559737,6 +560953,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -562205,6 +563425,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -563022,67 +564246,809 @@ } } }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "collaborators", - "subcategory": "invitations" - } - } - }, - "/user/repository_invitations/{invitation_id}": { - "patch": { - "summary": "Accept a repository invitation", - "description": "", - "tags": [ - "repos" - ], - "operationId": "repos/accept-invitation-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation" - }, - "parameters": [ - { - "name": "invitation_id", - "description": "The unique identifier of the invitation.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "collaborators", + "subcategory": "invitations" + } + } + }, + "/user/repository_invitations/{invitation_id}": { + "patch": { + "summary": "Accept a repository invitation", + "description": "", + "tags": [ + "repos" + ], + "operationId": "repos/accept-invitation-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation" + }, + "parameters": [ + { + "name": "invitation_id", + "description": "The unique identifier of the invitation.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "collaborators", + "subcategory": "invitations" + } + }, + "delete": { + "summary": "Decline a repository invitation", + "description": "", + "tags": [ + "repos" + ], + "operationId": "repos/decline-invitation-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation" + }, + "parameters": [ + { + "name": "invitation_id", + "description": "The unique identifier of the invitation.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "collaborators", + "subcategory": "invitations" + } + } + }, + "/user/ssh_signing_keys": { + "get": { + "summary": "List SSH signing keys for the authenticated user", + "description": "Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see \"[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\"", + "tags": [ + "users" + ], + "operationId": "users/list-ssh-signing-keys-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#list-public-ssh-signing-keys-for-the-authenticated-user" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "SSH Signing Key", + "description": "A public SSH key used to sign Git commits", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "key", + "id", + "title", + "created_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "id": 2, + "url": "https://api.github.com/user/keys/2", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z" + }, + { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234", + "id": 3, + "url": "https://api.github.com/user/keys/3", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAB", + "created_at": "2020-07-11T21:31:57Z" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + + ], + "category": "users", + "subcategory": "ssh-signing-keys" + } + }, + "post": { + "summary": "Create a SSH signing key for the authenticated user", + "description": "Creates an SSH signing key for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `write:ssh_signing_key` scope. For more information, see \"[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\"", + "operationId": "users/create-ssh-signing-key-for-authenticated-user", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#create-an-ssh-signing-key-for-the-authenticated-user" + }, + "parameters": [ + + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "A descriptive name for the new key.", + "type": "string", + "examples": [ + "Personal MacBook Air" + ] + }, + "key": { + "description": "The public SSH key to add to your GitHub account. For more information, see \"[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys).\"", + "type": "string", + "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) " + } + }, + "required": [ + "key" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "SSH Signing Key", + "description": "A public SSH key used to sign Git commits", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "key", + "id", + "title", + "created_at" + ] + }, + "examples": { + "default": { + "value": { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "id": 2, + "url": "https://api.github.com/user/keys/2", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z" + } + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "ssh-signing-keys" + } + } + }, + "/user/ssh_signing_keys/{ssh_signing_key_id}": { + "get": { + "summary": "Get an SSH signing key for the authenticated user", + "description": "Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see \"[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\"", + "tags": [ + "users" + ], + "operationId": "users/get-ssh-signing-key-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#get-a-ssh-signing-key-for-the-authenticated-user" + }, + "parameters": [ + { + "name": "ssh_signing_key_id", + "description": "The unique identifier of the SSH signing key.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "SSH Signing Key", + "description": "A public SSH key used to sign Git commits", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "key", + "id", + "title", + "created_at" + ] + }, + "examples": { + "default": { + "value": { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "id": 2, + "url": "https://api.github.com/user/keys/2", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" }, "403": { "description": "Forbidden", @@ -563110,34 +565076,8 @@ } } }, - "409": { - "description": "Conflict", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -563161,33 +565101,30 @@ } } } - }, - "304": { - "description": "Not modified" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "category": "collaborators", - "subcategory": "invitations" + "category": "users", + "subcategory": "ssh-signing-keys" } }, "delete": { - "summary": "Decline a repository invitation", - "description": "", + "summary": "Delete an SSH signing key for the authenticated user", + "description": "Deletes an SSH signing key from the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `admin:ssh_signing_key` scope. For more information, see \"[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\"", "tags": [ - "repos" + "users" ], - "operationId": "repos/decline-invitation-for-authenticated-user", + "operationId": "users/delete-ssh-signing-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation" + "url": "https://docs.github.com/rest/reference/users#delete-a-ssh-signing-key-for-the-authenticated-user" }, "parameters": [ { - "name": "invitation_id", - "description": "The unique identifier of the invitation.", + "name": "ssh_signing_key_id", + "description": "The unique identifier of the SSH signing key.", "in": "path", "required": true, "schema": { @@ -563199,8 +565136,11 @@ "204": { "description": "Response" }, - "409": { - "description": "Conflict", + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -563225,11 +565165,8 @@ } } }, - "304": { - "description": "Not modified" - }, - "404": { - "description": "Resource not found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -563254,8 +565191,8 @@ } } }, - "403": { - "description": "Forbidden", + "401": { + "description": "Requires authentication", "content": { "application/json": { "schema": { @@ -563284,8 +565221,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "category": "collaborators", - "subcategory": "invitations" + "category": "users", + "subcategory": "ssh-signing-keys" } } }, @@ -564733,6 +566670,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -566332,6 +568273,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -569005,6 +570950,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -573934,6 +575883,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -577953,6 +579906,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -581974,6 +583931,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -585360,14 +587321,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -585512,6 +587465,14 @@ "write" ] }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.", + "enum": [ + "read", + "write" + ] + }, "organization_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", @@ -588447,6 +590408,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -591096,6 +593061,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -595825,6 +597794,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -599846,6 +601819,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -603188,6 +605165,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -603836,6 +605817,121 @@ } } }, + "/users/{username}/ssh_signing_keys": { + "get": { + "summary": "List SSH signing keys for a user", + "description": "Lists the SSH signing keys for a user. This operation is accessible by anyone.", + "tags": [ + "users" + ], + "operationId": "users/list-ssh-signing-keys-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#list-ssh-signing-keys-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "SSH Signing Key", + "description": "A public SSH key used to sign Git commits", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "key", + "id", + "title", + "created_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "id": 2, + "url": "https://api.github.com/user/keys/2", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z" + }, + { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234", + "id": 3, + "url": "https://api.github.com/user/keys/3", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAB", + "created_at": "2020-07-11T21:31:57Z" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "ssh-signing-keys" + } + } + }, "/users/{username}/starred": { "get": { "summary": "List repositories starred by a user", @@ -605300,6 +607396,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -606764,6 +608864,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -609010,6 +611114,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ diff --git a/lib/rest/static/dereferenced/ghes-3.2.deref.json b/lib/rest/static/dereferenced/ghes-3.2.deref.json index c9dadf843c6b..57f3f1f542c5 100644 --- a/lib/rest/static/dereferenced/ghes-3.2.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.2.deref.json @@ -4438,14 +4438,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -5691,14 +5683,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -6489,14 +6473,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -9493,14 +9469,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -10438,14 +10406,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -11169,14 +11129,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -11470,14 +11422,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -12996,6 +12940,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -14948,14 +14896,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -15930,14 +15870,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -16784,14 +16716,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -17340,14 +17264,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -18396,14 +18312,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -19290,14 +19198,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -20676,14 +20576,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -21668,14 +21560,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -22733,14 +22617,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -23539,14 +23415,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -24582,14 +24450,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -25388,14 +25248,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -26305,14 +26157,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -27247,14 +27091,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -34823,6 +34659,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -36290,6 +36130,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -39249,6 +39093,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -54186,6 +54034,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -57145,6 +56997,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -61365,6 +61221,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -64674,6 +64534,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -67243,6 +67107,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -71106,6 +70974,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -74171,6 +74043,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -76942,6 +76818,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -78409,6 +78289,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -81180,6 +81064,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -84334,6 +84222,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -88566,14 +88458,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -89525,14 +89409,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -92703,6 +92579,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -93803,17 +93683,6 @@ } } }, - "302": { - "description": "Response if requester is not an organization member", - "headers": { - "Location": { - "example": "https://api.github.com/orgs/github/public_members", - "schema": { - "type": "string" - } - } - } - }, "422": { "description": "Validation failed", "content": { @@ -99380,6 +99249,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -101212,6 +101085,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -113661,6 +113538,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -116106,6 +115987,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -125427,6 +125312,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -127070,6 +126959,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -128433,6 +128326,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -131963,6 +131860,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -133606,6 +133507,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -134969,6 +134874,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -139067,6 +138976,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -140543,6 +140456,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -143225,6 +143142,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -145325,6 +145246,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -148061,6 +147986,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -150161,6 +150090,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -156898,6 +156831,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -158998,6 +158935,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -163212,6 +163153,115 @@ "protected", "protection_url" ] + }, + "examples": { + "default": { + "value": { + "name": "main", + "commit": { + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", + "commit": { + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", + "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] + }, + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" + }, + "protected": false, + "protection": { + "enabled": false, + "required_status_checks": { + "enforcement_level": "off", + "contexts": [ + + ], + "checks": [ + + ] + } + }, + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" + } + } } } } @@ -166250,6 +166300,85 @@ "required": [ "url" ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ + { + "context": "continuous-integration/travis-ci", + "app_id": null + } + ] + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "block_creations": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + } + } } } } @@ -169667,7 +169796,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -169684,12 +169813,23 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding status checks to a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci", + "continuous-integration/jenkins" + ] + } + } } } } @@ -169904,7 +170044,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -169921,12 +170061,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example updating status checks for a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -170113,7 +170263,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -170130,12 +170280,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing status checks from a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -173257,7 +173417,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -173274,12 +173434,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -173651,7 +173821,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -173662,18 +173832,28 @@ ], "example": { "teams": [ - "my-team" + "justice-league" ] } }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -174044,7 +174224,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -174061,12 +174241,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -174713,7 +174903,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -174735,6 +174925,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example adding a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -175073,7 +175273,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -175095,6 +175295,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -175432,7 +175642,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -175454,6 +175664,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example removing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -184916,6 +185136,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -187964,6 +188188,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -190608,6 +190836,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -193535,6 +193767,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -196586,6 +196822,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -196755,7 +196998,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -197260,6 +197504,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -197429,7 +197680,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -201455,6 +201707,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -210182,6 +210438,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -211734,6 +211994,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -213888,6 +214152,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -217686,6 +217971,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -220259,6 +220548,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -223592,8 +223885,8 @@ } } }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -223618,8 +223911,8 @@ } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -223643,6 +223936,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -237004,6 +237318,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -240218,6 +240536,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -242648,6 +242970,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -244291,6 +244617,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -245654,6 +245984,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -253675,14 +254009,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -256213,6 +256539,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -257038,6 +257368,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example request body", + "value": { + "permissions": "write" + } + } } } } @@ -258928,6 +259266,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -262375,6 +262717,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -263036,7 +263382,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -265825,6 +266172,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -266484,7 +266835,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -273128,6 +273480,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -275155,7 +275511,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ] @@ -278019,6 +278376,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -280084,7 +280445,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -282715,6 +283077,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -283374,7 +283740,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -283560,6 +283927,16 @@ "closed" ] }, + "state_reason": { + "type": [ + "string", + "null" + ], + "description": "The reason for the current state", + "examples": [ + "not_planned" + ] + }, "milestone": { "oneOf": [ { @@ -286127,6 +286504,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -286786,7 +287167,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -289561,6 +289943,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -290220,7 +290606,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -292792,6 +293179,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -293451,7 +293842,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -319810,6 +320202,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -330638,6 +331034,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -337646,6 +338046,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -339198,6 +339602,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -351381,8 +351789,8 @@ "304": { "description": "Not modified" }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -351407,8 +351815,8 @@ } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -351432,6 +351840,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -358714,6 +359143,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -362359,6 +362809,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -363911,6 +364365,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -367927,6 +368385,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -369479,6 +369941,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -389086,6 +389552,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -389620,7 +390090,7 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -390985,6 +391455,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -393124,6 +393598,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -396005,6 +396483,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -398857,6 +399339,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -401729,6 +402215,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -402325,7 +402815,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -417614,6 +418105,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -420079,6 +420574,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -426063,14 +426562,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -428083,6 +428574,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -431189,6 +431684,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -436777,6 +437276,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -438594,6 +439097,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -440960,6 +441467,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -443390,6 +443901,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -444896,6 +445411,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -447471,6 +447990,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -452286,6 +452809,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -456213,6 +456740,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -460142,6 +460673,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -463505,14 +464040,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -467475,6 +468002,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -471404,6 +471935,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -474648,6 +475183,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -476457,6 +476996,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -477829,6 +478372,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -479976,6 +480523,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ diff --git a/lib/rest/static/dereferenced/ghes-3.3.deref.json b/lib/rest/static/dereferenced/ghes-3.3.deref.json index 2d1944072e24..f214c7d0c334 100644 --- a/lib/rest/static/dereferenced/ghes-3.3.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.3.deref.json @@ -4292,14 +4292,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -5545,14 +5537,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -6343,14 +6327,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -9347,14 +9323,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -10292,14 +10260,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -11023,14 +10983,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -11324,14 +11276,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -12861,6 +12805,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -14813,14 +14761,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -15795,14 +15735,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -16649,14 +16581,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -17205,14 +17129,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -18261,14 +18177,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -19155,14 +19063,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -20541,14 +20441,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -21533,14 +21425,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -22598,14 +22482,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -23404,14 +23280,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -24447,14 +24315,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -25253,14 +25113,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -26170,14 +26022,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -27112,14 +26956,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -34699,6 +34535,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -36177,6 +36017,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -39543,6 +39387,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -54491,6 +54339,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -57455,6 +57307,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -61677,6 +61533,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -64997,6 +64857,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -67577,6 +67441,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -71441,6 +71309,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -74517,6 +74389,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -77299,6 +77175,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -78777,6 +78657,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -81559,6 +81443,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -85120,6 +85008,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -89352,14 +89244,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -90311,14 +90195,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -93500,6 +93376,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -94591,17 +94471,6 @@ } } }, - "302": { - "description": "Response if requester is not an organization member", - "headers": { - "Location": { - "example": "https://api.github.com/orgs/github/public_members", - "schema": { - "type": "string" - } - } - } - }, "422": { "description": "Validation failed", "content": { @@ -100145,6 +100014,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -101984,6 +101857,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -115475,6 +115352,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -117931,6 +117812,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -127147,6 +127032,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -128807,6 +128696,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -130181,6 +130074,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -133218,6 +133115,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -134878,6 +134779,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -136252,6 +136157,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -140432,6 +140341,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -141919,6 +141832,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -144612,6 +144529,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -146723,6 +146644,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -149470,6 +149395,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -151581,6 +151510,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -158393,6 +158326,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -160504,6 +160441,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -161498,6 +161439,11 @@ "url_template": { "type": "string", "description": "The URL must contain `` for the reference number." + }, + "is_alphanumeric": { + "type": "boolean", + "default": "true", + "description": "Whether this autolink reference matches alphanumeric characters. If true, the `` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters." } }, "required": [ @@ -161509,7 +161455,8 @@ "default": { "value": { "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=" + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true } } } @@ -165228,6 +165175,115 @@ "protected", "protection_url" ] + }, + "examples": { + "default": { + "value": { + "name": "main", + "commit": { + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", + "commit": { + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", + "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] + }, + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" + }, + "protected": false, + "protection": { + "enabled": false, + "required_status_checks": { + "enforcement_level": "off", + "contexts": [ + + ], + "checks": [ + + ] + } + }, + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" + } + } } } } @@ -168260,6 +168316,85 @@ "required": [ "url" ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ + { + "context": "continuous-integration/travis-ci", + "app_id": null + } + ] + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "block_creations": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + } + } } } } @@ -171641,7 +171776,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -171658,12 +171793,23 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding status checks to a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci", + "continuous-integration/jenkins" + ] + } + } } } } @@ -171878,7 +172024,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -171895,12 +172041,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example updating status checks for a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -172087,7 +172243,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -172104,12 +172260,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing status checks from a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -175231,7 +175397,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -175248,12 +175414,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -175625,7 +175801,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -175636,18 +175812,28 @@ ], "example": { "teams": [ - "my-team" + "justice-league" ] } }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -176018,7 +176204,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -176035,12 +176221,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -176687,7 +176883,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -176709,6 +176905,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example adding a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -177047,7 +177253,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -177069,6 +177275,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -177406,7 +177622,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -177428,6 +177644,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example removing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -187049,6 +187275,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -190108,6 +190338,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -192763,6 +192997,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -195701,6 +195939,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -198752,6 +198994,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -198919,7 +199168,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -199424,6 +199674,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -199591,7 +199848,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -203622,6 +203880,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -212299,6 +212561,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -213862,6 +214128,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -216010,6 +216280,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -219819,6 +220110,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -222403,6 +222698,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -225736,8 +226035,8 @@ } } }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -225762,8 +226061,8 @@ } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -225787,6 +226086,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -239107,6 +239427,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -242332,6 +242656,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -244773,6 +245101,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -246433,6 +246765,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -247807,6 +248143,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -255835,14 +256175,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -258384,6 +258716,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -259209,6 +259545,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example request body", + "value": { + "permissions": "write" + } + } } } } @@ -261110,6 +261454,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -264568,6 +264916,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -265229,7 +265581,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -268020,6 +268373,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -268679,7 +269036,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -275303,6 +275661,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -277330,7 +277692,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ] @@ -280199,6 +280562,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -282264,7 +282631,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -284900,6 +285268,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -285559,7 +285931,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -285740,6 +286113,16 @@ "closed" ] }, + "state_reason": { + "type": [ + "string", + "null" + ], + "description": "The reason for the current state", + "examples": [ + "not_planned" + ] + }, "milestone": { "oneOf": [ { @@ -288318,6 +288701,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -288977,7 +289364,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -291763,6 +292151,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -292422,7 +292814,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -295005,6 +295398,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -295664,7 +296061,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -322007,6 +322405,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -333045,6 +333447,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -340018,6 +340424,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -341581,6 +341991,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -353723,8 +354137,8 @@ "304": { "description": "Not modified" }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -353749,8 +354163,8 @@ } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -353774,6 +354188,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -361040,6 +361475,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -364696,6 +365152,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -366259,6 +366719,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -370286,6 +370750,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -371849,6 +372317,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -391770,6 +392242,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -392307,7 +392783,7 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -393683,6 +394159,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -395833,6 +396313,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -398725,6 +399209,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -401588,6 +402076,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -404466,6 +404958,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -405062,7 +405558,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -420247,6 +420744,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -422723,6 +423224,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -428707,14 +429212,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -430738,6 +431235,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -433849,6 +434350,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -439412,6 +439917,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -441249,6 +441758,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -443630,6 +444143,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -446071,6 +446588,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -447589,6 +448110,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -450175,6 +450700,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -455001,6 +455530,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -458939,6 +459472,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -462879,6 +463416,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -466242,14 +466783,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -470218,6 +470751,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -474158,6 +474695,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -477413,6 +477954,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -479228,6 +479773,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -480611,6 +481160,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -482770,6 +483323,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ diff --git a/lib/rest/static/dereferenced/ghes-3.4.deref.json b/lib/rest/static/dereferenced/ghes-3.4.deref.json index 60acdd2b6850..16ca6978d4be 100644 --- a/lib/rest/static/dereferenced/ghes-3.4.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.4.deref.json @@ -4292,14 +4292,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -5537,14 +5529,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -6327,14 +6311,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -9323,14 +9299,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -10260,14 +10228,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -10983,14 +10943,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -11276,14 +11228,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -12805,6 +12749,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -14705,14 +14653,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -15679,14 +15619,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -16525,14 +16457,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -17073,14 +16997,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -18584,14 +18500,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -19568,14 +19476,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -20625,14 +20525,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -21423,14 +21315,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -22458,14 +22342,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -23256,14 +23132,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -24165,14 +24033,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -25099,14 +24959,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -32678,6 +32530,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -34156,6 +34012,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -39769,6 +39629,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -54717,6 +54581,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -57681,6 +57549,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -61903,6 +61775,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -65223,6 +65099,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -67803,6 +67683,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -68989,7 +68873,7 @@ "/organizations/{organization_id}/custom_roles": { "get": { "summary": "List custom repository roles in an organization", - "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/enterprise-server@3.4/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".", + "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.\nGitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/enterprise-server@3.4/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".", "tags": [ "orgs" ], @@ -71783,6 +71667,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -74859,6 +74747,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -77641,6 +77533,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -79119,6 +79015,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -82782,6 +82682,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -86136,6 +86040,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -89301,6 +89209,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -93533,14 +93445,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -94484,14 +94388,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -97665,6 +97561,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -98756,17 +98656,6 @@ } } }, - "302": { - "description": "Response if requester is not an organization member", - "headers": { - "Location": { - "example": "https://api.github.com/orgs/github/public_members", - "schema": { - "type": "string" - } - } - } - }, "422": { "description": "Validation failed", "content": { @@ -101681,6 +101570,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -103629,6 +103522,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -105604,6 +105501,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -110144,6 +110045,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -111983,6 +111888,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -125685,6 +125594,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -128141,6 +128054,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -137357,6 +137274,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -139017,6 +138938,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -140391,6 +140316,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -143428,6 +143357,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -145088,6 +145021,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -146462,6 +146399,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -150642,6 +150583,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -152129,6 +152074,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -155748,6 +155697,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -157859,6 +157812,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -160606,6 +160563,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -162717,6 +162678,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -169529,6 +169494,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -171640,6 +171609,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -172634,6 +172607,11 @@ "url_template": { "type": "string", "description": "The URL must contain `` for the reference number." + }, + "is_alphanumeric": { + "type": "boolean", + "default": "true", + "description": "Whether this autolink reference matches alphanumeric characters. If true, the `` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters." } }, "required": [ @@ -172645,7 +172623,8 @@ "default": { "value": { "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=" + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true } } } @@ -177816,6 +177795,115 @@ "protected", "protection_url" ] + }, + "examples": { + "default": { + "value": { + "name": "main", + "commit": { + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", + "commit": { + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", + "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] + }, + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" + }, + "protected": false, + "protection": { + "enabled": false, + "required_status_checks": { + "enforcement_level": "off", + "contexts": [ + + ], + "checks": [ + + ] + } + }, + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" + } + } } } } @@ -182323,6 +182411,85 @@ "required": [ "url" ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ + { + "context": "continuous-integration/travis-ci", + "app_id": null + } + ] + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "block_creations": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + } + } } } } @@ -187209,7 +187376,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -187226,12 +187393,23 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding status checks to a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci", + "continuous-integration/jenkins" + ] + } + } } } } @@ -187446,7 +187624,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -187463,12 +187641,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example updating status checks for a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -187655,7 +187843,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -187672,12 +187860,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing status checks from a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -190799,7 +190997,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -190816,12 +191014,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -191193,7 +191401,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -191204,18 +191412,28 @@ ], "example": { "teams": [ - "my-team" + "justice-league" ] } }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -191586,7 +191804,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -191603,12 +191821,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -192255,7 +192483,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -192277,6 +192505,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example adding a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -192615,7 +192853,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -192637,6 +192875,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -192974,7 +193222,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -192996,6 +193244,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example removing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -203337,6 +203595,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -206396,6 +206658,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -209051,6 +209317,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -211989,6 +212259,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -215121,6 +215395,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -215288,7 +215569,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -215811,6 +216093,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -215978,7 +216267,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -216263,6 +216553,7 @@ "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "state": "open", "fixed_at": null, "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", @@ -217070,7 +217361,7 @@ }, "delete": { "summary": "Delete a code scanning analysis from a repository", - "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` scope.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `analysis_key`\n* `environment`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.", + "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` scope.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `category`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.", "operationId": "code-scanning/delete-analysis", "tags": [ "code-scanning" @@ -220023,6 +220314,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -228700,6 +228995,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -230263,6 +230562,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -232411,6 +232714,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -236220,6 +236544,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -238804,6 +239132,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -242137,8 +242469,8 @@ } } }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -242163,8 +242495,8 @@ } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -242188,6 +242520,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -255648,6 +256001,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -258873,6 +259230,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -261314,6 +261675,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -262974,6 +263339,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -264348,6 +264717,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -272376,14 +272749,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -274917,6 +275282,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -275742,6 +276111,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example request body", + "value": { + "permissions": "write" + } + } } } } @@ -277643,6 +278020,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -281101,6 +281482,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -281762,7 +282147,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -284553,6 +284939,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -285212,7 +285602,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -291836,6 +292227,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -293863,7 +294258,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ] @@ -296732,6 +297128,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -298797,7 +299197,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -301433,6 +301834,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -302092,7 +302497,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -302273,6 +302679,16 @@ "closed" ] }, + "state_reason": { + "type": [ + "string", + "null" + ], + "description": "The reason for the current state", + "examples": [ + "not_planned" + ] + }, "milestone": { "oneOf": [ { @@ -304851,6 +305267,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -305510,7 +305930,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -308296,6 +308717,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -308955,7 +309380,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -311538,6 +311964,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -312197,7 +312627,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -338540,6 +338971,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -349578,6 +350013,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -356551,6 +356990,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -358114,6 +358557,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -370256,8 +370703,8 @@ "304": { "description": "Not modified" }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -370282,8 +370729,8 @@ } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -370307,6 +370754,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -377573,6 +378041,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -381229,6 +381718,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -382792,6 +383285,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -386819,6 +387316,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -388382,6 +388883,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -408502,6 +409007,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -409039,7 +409548,7 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.4/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.4/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.4/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.4/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -410415,6 +410924,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -412565,6 +413078,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -415457,6 +415974,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -418320,6 +418841,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -421198,6 +421723,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -421794,7 +422323,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -437006,6 +437536,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -439482,6 +440016,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -445466,14 +446004,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -447489,6 +448019,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -450600,6 +451134,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -455377,6 +455915,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -457389,6 +457931,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -459844,6 +460390,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -462570,6 +463120,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -464407,6 +464961,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -466788,6 +467346,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -469229,6 +469791,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -470747,6 +471313,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -473333,6 +473903,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -478168,6 +478742,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -482106,6 +482684,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -486046,6 +486628,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -489409,14 +489995,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -493377,6 +493955,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -497317,6 +497899,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -500572,6 +501158,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -502387,6 +502977,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -503770,6 +504364,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -505929,6 +506527,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ diff --git a/lib/rest/static/dereferenced/ghes-3.5.deref.json b/lib/rest/static/dereferenced/ghes-3.5.deref.json index 33272011e484..43e32da616bc 100644 --- a/lib/rest/static/dereferenced/ghes-3.5.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.5.deref.json @@ -4292,14 +4292,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -5537,14 +5529,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -6327,14 +6311,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -9323,14 +9299,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -10260,14 +10228,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -10983,14 +10943,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -11276,14 +11228,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -12805,6 +12749,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -14705,14 +14653,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -15679,14 +15619,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -16525,14 +16457,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -17073,14 +16997,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -18584,14 +18500,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -19568,14 +19476,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -20625,14 +20525,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -21423,14 +21315,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -22458,14 +22342,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -23256,14 +23132,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -24165,14 +24033,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -25099,14 +24959,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -33044,6 +32896,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -34522,6 +34378,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -40139,6 +39999,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -55087,6 +54951,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -58051,6 +57919,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -62273,6 +62145,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -65599,6 +65475,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -68185,6 +68065,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -69371,7 +69255,7 @@ "/organizations/{organization_id}/custom_roles": { "get": { "summary": "List custom repository roles in an organization", - "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/enterprise-server@3.5/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".", + "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.\nGitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/enterprise-server@3.5/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".", "tags": [ "orgs" ], @@ -72371,6 +72255,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -75739,6 +75627,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -78521,6 +78413,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -79999,6 +79895,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -83668,6 +83568,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -85032,6 +84936,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -88489,6 +88400,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -91654,6 +91569,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -95886,14 +95805,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -96837,14 +96748,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -100018,6 +99921,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -101109,17 +101016,6 @@ } } }, - "302": { - "description": "Response if requester is not an organization member", - "headers": { - "Location": { - "example": "https://api.github.com/orgs/github/public_members", - "schema": { - "type": "string" - } - } - } - }, "422": { "description": "Validation failed", "content": { @@ -104034,6 +103930,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -105982,6 +105882,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -107957,6 +107861,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -112503,6 +112411,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -114342,6 +114254,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -128054,6 +127970,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -130516,6 +130436,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -139614,6 +139538,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -141274,6 +141202,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -142648,6 +142580,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -145685,6 +145621,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -147345,6 +147285,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -148719,6 +148663,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -153405,6 +153353,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -154892,6 +154844,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -158869,6 +158825,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -160986,6 +160946,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -164125,6 +164089,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -166242,6 +166210,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -170030,6 +170002,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -172147,6 +172123,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -179374,6 +179354,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -181491,6 +181475,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -182527,6 +182515,11 @@ "url_template": { "type": "string", "description": "The URL must contain `` for the reference number." + }, + "is_alphanumeric": { + "type": "boolean", + "default": "true", + "description": "Whether this autolink reference matches alphanumeric characters. If true, the `` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters." } }, "required": [ @@ -182538,7 +182531,8 @@ "default": { "value": { "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=" + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true } } } @@ -187709,6 +187703,115 @@ "protected", "protection_url" ] + }, + "examples": { + "default": { + "value": { + "name": "main", + "commit": { + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", + "commit": { + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", + "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] + }, + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" + }, + "protected": false, + "protection": { + "enabled": false, + "required_status_checks": { + "enforcement_level": "off", + "contexts": [ + + ], + "checks": [ + + ] + } + }, + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" + } + } } } } @@ -192216,6 +192319,85 @@ "required": [ "url" ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ + { + "context": "continuous-integration/travis-ci", + "app_id": null + } + ] + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "block_creations": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + } + } } } } @@ -197102,7 +197284,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -197119,12 +197301,23 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding status checks to a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci", + "continuous-integration/jenkins" + ] + } + } } } } @@ -197339,7 +197532,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -197356,12 +197549,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example updating status checks for a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -197548,7 +197751,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -197565,12 +197768,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing status checks from a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -200692,7 +200905,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -200709,12 +200922,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -201086,7 +201309,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -201097,18 +201320,28 @@ ], "example": { "teams": [ - "my-team" + "justice-league" ] } }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -201479,7 +201712,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -201496,12 +201729,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -202148,7 +202391,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -202170,6 +202413,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example adding a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -202508,7 +202761,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -202530,6 +202783,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -202867,7 +203130,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -202889,6 +203152,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example removing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -213236,6 +213509,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -216301,6 +216578,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -218962,6 +219243,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -221906,6 +222191,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -225038,6 +225327,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -225205,7 +225501,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -225728,6 +226025,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -225895,7 +226199,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -226180,6 +226485,7 @@ "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "state": "open", "fixed_at": null, "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", @@ -226987,7 +227293,7 @@ }, "delete": { "summary": "Delete a code scanning analysis from a repository", - "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` scope.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `analysis_key`\n* `environment`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.", + "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` scope.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `category`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.", "operationId": "code-scanning/delete-analysis", "tags": [ "code-scanning" @@ -230122,6 +230428,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -238813,6 +239123,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -240376,6 +240690,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -242524,6 +242842,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -246339,6 +246678,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -248929,6 +249272,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -252262,8 +252609,8 @@ } } }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -252288,8 +252635,8 @@ } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -252313,6 +252660,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -265773,6 +266141,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -269004,6 +269376,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -271445,6 +271821,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -273105,6 +273485,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -274479,6 +274863,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -282507,14 +282895,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -285054,6 +285434,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -285879,6 +286263,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example request body", + "value": { + "permissions": "write" + } + } } } } @@ -287786,6 +288178,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -291244,6 +291640,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -291905,7 +292305,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -294696,6 +295097,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -295355,7 +295760,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -301979,6 +302385,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -304006,7 +304416,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ] @@ -306875,6 +307286,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -308940,7 +309355,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -311576,6 +311992,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -312235,7 +312655,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -312416,6 +312837,16 @@ "closed" ] }, + "state_reason": { + "type": [ + "string", + "null" + ], + "description": "The reason for the current state", + "examples": [ + "not_planned" + ] + }, "milestone": { "oneOf": [ { @@ -314994,6 +315425,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -315653,7 +316088,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -318439,6 +318875,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -319098,7 +319538,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -321681,6 +322122,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -322340,7 +322785,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -348683,6 +349129,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -359727,6 +360177,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -366700,6 +367154,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -368263,6 +368721,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -380405,8 +380867,8 @@ "304": { "description": "Not modified" }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -380431,8 +380893,8 @@ } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -380456,6 +380918,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -387722,6 +388205,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -391378,6 +391882,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -392941,6 +393449,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -396968,6 +397480,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -398531,6 +399047,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -419103,6 +419623,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -419640,7 +420164,7 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.5/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.5/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -421016,6 +421540,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -423172,6 +423700,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -426070,6 +426602,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -428939,6 +429475,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -431817,6 +432357,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -432413,7 +432957,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -447631,6 +448176,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -450113,6 +450662,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -456099,14 +456652,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -458122,6 +458667,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -461233,6 +461782,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -466010,6 +466563,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -468022,6 +468579,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -470483,6 +471044,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -473209,6 +473774,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -475046,6 +475615,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -477433,6 +478006,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -479874,6 +480451,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -481392,6 +481973,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -483984,6 +484569,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -488819,6 +489408,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -492757,6 +493350,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -496697,6 +497294,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -500060,14 +500661,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -504028,6 +504621,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -507968,6 +508565,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -511229,6 +511830,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -513044,6 +513649,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -514427,6 +515036,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -516592,6 +517205,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ diff --git a/lib/rest/static/dereferenced/ghes-3.6.deref.json b/lib/rest/static/dereferenced/ghes-3.6.deref.json index d567f62dabf6..d4a82f354ed5 100644 --- a/lib/rest/static/dereferenced/ghes-3.6.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.6.deref.json @@ -4292,14 +4292,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -5537,14 +5529,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -6327,14 +6311,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -9323,14 +9299,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -10260,14 +10228,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -10983,14 +10943,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -11276,14 +11228,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -12886,6 +12830,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -14786,14 +14734,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -15760,14 +15700,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -16606,14 +16538,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -17154,14 +17078,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -18665,14 +18581,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -19649,14 +19557,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -20706,14 +20606,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -21504,14 +21396,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -22539,14 +22423,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -23337,14 +23213,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -24246,14 +24114,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -25180,14 +25040,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -33352,6 +33204,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -34911,6 +34767,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -40845,6 +40705,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -55874,6 +55738,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -58919,6 +58787,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -63222,6 +63094,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -66629,6 +66505,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -69302,6 +69182,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -70494,7 +70378,7 @@ "/organizations/{organization_id}/custom_roles": { "get": { "summary": "List custom repository roles in an organization", - "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/enterprise-server@3.6/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".", + "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.\nGitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/enterprise-server@3.6/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".", "tags": [ "orgs" ], @@ -73593,6 +73477,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -77051,6 +76939,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -79920,6 +79812,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -81479,6 +81375,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -85229,6 +85129,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -86607,6 +86511,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -90147,6 +90058,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -93399,6 +93314,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -97631,14 +97550,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -98582,14 +98493,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -101844,6 +101747,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -102935,17 +102842,6 @@ } } }, - "302": { - "description": "Response if requester is not an organization member", - "headers": { - "Location": { - "example": "https://api.github.com/orgs/github/public_members", - "schema": { - "type": "string" - } - } - } - }, "422": { "description": "Validation failed", "content": { @@ -105941,6 +105837,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -107970,6 +107870,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -110026,6 +109930,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -114653,6 +114561,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -116579,6 +116491,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -130626,6 +130542,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -133175,6 +133095,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -142362,6 +142286,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -144161,6 +144089,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -145616,6 +145548,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -148739,6 +148675,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -150538,6 +150478,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -151993,6 +151937,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -156948,6 +156896,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -158516,6 +158468,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -162607,6 +162563,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -164811,6 +164771,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -168070,6 +168034,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -170274,6 +170242,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -174213,6 +174185,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -176417,6 +176393,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -183795,6 +183775,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -185999,6 +185983,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -187041,6 +187029,11 @@ "url_template": { "type": "string", "description": "The URL must contain `` for the reference number." + }, + "is_alphanumeric": { + "type": "boolean", + "default": "true", + "description": "Whether this autolink reference matches alphanumeric characters. If true, the `` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters." } }, "required": [ @@ -187052,7 +187045,8 @@ "default": { "value": { "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=" + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true } } } @@ -192223,6 +192217,115 @@ "protected", "protection_url" ] + }, + "examples": { + "default": { + "value": { + "name": "main", + "commit": { + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", + "commit": { + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", + "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] + }, + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" + }, + "protected": false, + "protection": { + "enabled": false, + "required_status_checks": { + "enforcement_level": "off", + "contexts": [ + + ], + "checks": [ + + ] + } + }, + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" + } + } } } } @@ -196730,6 +196833,85 @@ "required": [ "url" ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ + { + "context": "continuous-integration/travis-ci", + "app_id": null + } + ] + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "block_creations": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + } + } } } } @@ -201616,7 +201798,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -201633,12 +201815,23 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding status checks to a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci", + "continuous-integration/jenkins" + ] + } + } } } } @@ -201853,7 +202046,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -201870,12 +202063,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example updating status checks for a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -202062,7 +202265,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -202079,12 +202282,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing status checks from a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -205206,7 +205419,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -205223,12 +205436,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -205600,7 +205823,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -205611,18 +205834,28 @@ ], "example": { "teams": [ - "my-team" + "justice-league" ] } }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -205993,7 +206226,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -206010,12 +206243,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -206662,7 +206905,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -206684,6 +206927,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example adding a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -207022,7 +207275,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -207044,6 +207297,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -207381,7 +207644,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -207403,6 +207666,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example removing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -217831,6 +218104,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -220983,6 +221260,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -223731,6 +224012,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -226762,6 +227047,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -229918,6 +230207,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -230087,7 +230383,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -230626,6 +230923,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -230795,7 +231099,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -231080,6 +231385,7 @@ "ref": "refs/heads/main", "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "environment": "", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", "state": "open", "fixed_at": null, "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", @@ -231887,7 +232193,7 @@ }, "delete": { "summary": "Delete a code scanning analysis from a repository", - "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` scope.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `analysis_key`\n* `environment`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.", + "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` scope.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `category`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.", "operationId": "code-scanning/delete-analysis", "tags": [ "code-scanning" @@ -235103,6 +235409,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -243881,6 +244191,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -245525,6 +245839,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -247673,6 +247991,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -251569,6 +251908,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -254246,6 +254589,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -257585,8 +257932,8 @@ } } }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -257611,8 +257958,8 @@ } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -257636,6 +257983,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -271470,6 +271838,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -274782,6 +275154,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -277310,6 +277686,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -279109,6 +279489,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -280564,6 +280948,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -288594,14 +288982,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -291222,6 +291602,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -292053,6 +292437,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example request body", + "value": { + "permissions": "write" + } + } } } } @@ -294041,6 +294433,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -297586,6 +297982,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -298247,7 +298647,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -301119,6 +301520,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -301778,7 +302183,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -308483,6 +308889,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -310510,7 +310920,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ] @@ -313460,6 +313871,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -315525,7 +315940,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -318242,6 +318658,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -318901,7 +319321,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -319082,6 +319503,16 @@ "closed" ] }, + "state_reason": { + "type": [ + "string", + "null" + ], + "description": "The reason for the current state", + "examples": [ + "not_planned" + ] + }, "milestone": { "oneOf": [ { @@ -321741,6 +322172,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -322400,7 +322835,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -325267,6 +325703,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -325926,7 +326366,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -328590,6 +329031,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -329249,7 +329694,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -355673,6 +356119,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -366798,6 +367248,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -373858,6 +374312,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -375502,6 +375960,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -387656,8 +388118,8 @@ "304": { "description": "Not modified" }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -387682,8 +388144,8 @@ } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -387707,6 +388169,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -394979,6 +395462,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -398716,6 +399220,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -400360,6 +400868,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -404468,6 +404980,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -406112,6 +406628,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -427376,6 +427896,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -427919,7 +428443,7 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -429376,6 +429900,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -431613,6 +432141,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -434598,6 +435130,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -437554,6 +438090,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -440519,6 +441059,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -441115,7 +441659,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -456438,6 +456983,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -459007,6 +459556,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -465074,14 +465627,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -467178,6 +467723,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -470370,6 +470919,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -475228,6 +475781,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -477321,6 +477878,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -479863,6 +480424,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -482676,6 +483241,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -484594,6 +485163,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -487062,6 +487635,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -489590,6 +490167,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -491189,6 +491770,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -493862,6 +494447,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -498790,6 +499379,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -502809,6 +503402,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -506830,6 +507427,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -510216,14 +510817,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -514265,6 +514858,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -518286,6 +518883,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -521628,6 +522229,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -523530,6 +524135,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -524994,6 +525603,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -527240,6 +527853,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index c74a79e1b152..1b458fcd814e 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -2762,14 +2762,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -3668,14 +3660,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -4458,14 +4442,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -7453,14 +7429,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -8390,14 +8358,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -9113,14 +9073,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -9406,14 +9358,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -10940,6 +10884,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -11981,14 +11929,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -12955,14 +12895,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -14027,14 +13959,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -21530,6 +21454,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -23013,6 +22941,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -37366,6 +37298,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -40335,6 +40271,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -43977,6 +43917,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -46574,6 +46518,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -48135,6 +48083,48 @@ "updated_at": { "type": "string", "format": "date-time" + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] } }, "required": [ @@ -48389,6 +48379,30 @@ "examples": [ "\"http://github.blog\"" ] + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether Dependabot alerts is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether Dependabot security updates is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether dependency graph is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning push protection is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." } } }, @@ -48760,6 +48774,48 @@ "updated_at": { "type": "string", "format": "date-time" + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "examples": [ + false + ] } }, "required": [ @@ -50502,6 +50558,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -53375,6 +53435,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -54858,6 +54922,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -57651,6 +57719,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -61875,14 +61947,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -62826,14 +62890,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -66012,6 +66068,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -67103,17 +67163,6 @@ } } }, - "302": { - "description": "Response if requester is not an organization member", - "headers": { - "Location": { - "example": "https://api.github.com/orgs/github/public_members", - "schema": { - "type": "string" - } - } - } - }, "422": { "description": "Validation failed", "content": { @@ -70033,6 +70082,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -71986,6 +72039,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -73966,6 +74023,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -77714,6 +77775,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -79564,6 +79629,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -92293,6 +92362,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -94766,6 +94839,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -103877,6 +103954,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -105554,6 +105635,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -106933,6 +107018,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -109980,6 +110069,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -111657,6 +111750,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -113036,6 +113133,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -117234,6 +117335,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -118726,6 +118831,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -121807,6 +121916,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -123935,6 +124048,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -127118,6 +127235,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -129246,6 +129367,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -132758,6 +132883,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -134886,6 +135015,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -140923,6 +141056,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -143051,6 +143188,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -144214,6 +144355,11 @@ "url_template": { "type": "string", "description": "The URL must contain `` for the reference number." + }, + "is_alphanumeric": { + "type": "boolean", + "default": "true", + "description": "Whether this autolink reference matches alphanumeric characters. If true, the `` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters." } }, "required": [ @@ -144225,7 +144371,8 @@ "default": { "value": { "key_prefix": "TICKET-", - "url_template": "https://example.com/TICKET?query=" + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true } } } @@ -149396,6 +149543,115 @@ "protected", "protection_url" ] + }, + "examples": { + "default": { + "value": { + "name": "main", + "commit": { + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", + "commit": { + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null + } + }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", + "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] + }, + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" + }, + "protected": false, + "protection": { + "enabled": false, + "required_status_checks": { + "enforcement_level": "off", + "contexts": [ + + ], + "checks": [ + + ] + } + }, + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" + } + } } } } @@ -153903,6 +154159,85 @@ "required": [ "url" ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ + { + "context": "continuous-integration/travis-ci", + "app_id": null + } + ] + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [ + + ], + "teams": [ + + ], + "apps": [ + + ] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "block_creations": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + } + } + } } } } @@ -158789,7 +159124,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -158806,12 +159141,23 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding status checks to a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci", + "continuous-integration/jenkins" + ] + } + } } } } @@ -159026,7 +159372,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -159043,12 +159389,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example updating status checks for a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -159235,7 +159591,7 @@ "properties": { "contexts": { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } @@ -159252,12 +159608,22 @@ }, { "type": "array", - "description": "contexts parameter", + "description": "The name of the status checks", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing status checks from a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } } } } @@ -162379,7 +162745,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -162396,12 +162762,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example adding a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -162773,7 +163149,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -162784,18 +163160,28 @@ ], "example": { "teams": [ - "my-team" + "justice-league" ] } }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -163166,7 +163552,7 @@ "properties": { "teams": { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } @@ -163183,12 +163569,22 @@ }, { "type": "array", - "description": "teams parameter", + "description": "The slug values for teams", "items": { "type": "string" } } ] + }, + "examples": { + "default": { + "summary": "Example removing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } } } } @@ -163835,7 +164231,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -163857,6 +164253,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example adding a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -164195,7 +164601,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -164217,6 +164623,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example replacing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -164554,7 +164970,7 @@ "properties": { "users": { "type": "array", - "description": "users parameter", + "description": "The username for users", "items": { "type": "string" } @@ -164576,6 +164992,16 @@ } } ] + }, + "examples": { + "default": { + "summary": "Example removing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } } } } @@ -171946,6 +172372,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -175022,6 +175452,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -177694,6 +178128,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -180649,6 +181087,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -183706,6 +184148,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -183874,7 +184323,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -184379,6 +184829,13 @@ "null" ], "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "type": [ + "string", + "null" + ], + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -184547,7 +185004,8 @@ "security", "external/cwe/cwe-022" ], - "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" }, "tool": { "name": "CodeQL", @@ -185051,6 +185509,33 @@ "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53" ] } + }, + { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "The property by which to sort the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created" + ], + "default": "created" + } } ], "responses": { @@ -188777,6 +189262,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -197516,6 +198005,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -199084,6 +199577,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -201232,6 +201729,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -205052,6 +205570,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -207653,6 +208175,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -210992,8 +211518,8 @@ } } }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -211018,8 +211544,8 @@ } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -211043,6 +211569,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -224043,6 +224590,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -227279,6 +227830,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -229731,6 +230286,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -231408,6 +231967,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -232787,6 +233350,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -240816,14 +241383,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -243368,6 +243927,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -244199,6 +244762,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example request body", + "value": { + "permissions": "write" + } + } } } } @@ -246111,6 +246682,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -249580,6 +250155,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -250241,7 +250820,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -253037,6 +253617,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -253696,7 +254280,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -260340,6 +260925,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -262367,7 +262956,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } ] @@ -265241,6 +265831,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -267306,7 +267900,8 @@ "closed_at": null, "created_at": "2011-04-22T13:33:48Z", "updated_at": "2011-04-22T13:33:48Z", - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -269947,6 +270542,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -270606,7 +271205,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -270787,6 +271387,16 @@ "closed" ] }, + "state_reason": { + "type": [ + "string", + "null" + ], + "description": "The reason for the current state", + "examples": [ + "not_planned" + ] + }, "milestone": { "oneOf": [ { @@ -273370,6 +273980,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -274029,7 +274643,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -276820,6 +277435,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -277479,7 +278098,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -280067,6 +280687,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -280726,7 +281350,8 @@ "type": "User", "site_admin": false }, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } } } @@ -307089,6 +307714,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -318138,6 +318767,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -324717,6 +325350,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -326285,6 +326922,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -338454,8 +339095,8 @@ "304": { "description": "Not modified" }, - "500": { - "description": "Internal Error", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -338480,8 +339121,8 @@ } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -338505,6 +339146,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -345777,6 +346439,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -349438,6 +350121,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -351006,6 +351693,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -355038,6 +355729,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -356606,6 +357301,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -376202,6 +376901,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -376745,7 +377448,7 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/github-ae@latest/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/github-ae@latest/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -378126,6 +378829,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -381362,6 +382069,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -384242,6 +384953,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -387131,6 +387846,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -387727,7 +388446,8 @@ "body": "...", "score": 1, "locked": true, - "author_association": "COLLABORATOR" + "author_association": "COLLABORATOR", + "state_reason": "completed" } ] } @@ -400087,6 +400807,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -402580,6 +403304,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -407823,14 +408551,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -409851,6 +410571,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -412967,6 +413691,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -417749,6 +418477,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -419766,6 +420498,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -422232,6 +422968,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -424775,6 +425515,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -426617,6 +427361,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -429009,6 +429757,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -431461,6 +432213,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -432984,6 +433740,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -435581,6 +436341,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -440434,6 +441198,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -444377,6 +445145,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -447751,14 +448523,6 @@ "write" ] }, - "organization_custom_roles": { - "type": "string", - "description": "The level of permission to grant the access token for custom roles management.", - "enum": [ - "read", - "write" - ] - }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", @@ -451045,6 +451809,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -452801,6 +453569,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -454189,6 +454961,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -456359,6 +457135,10 @@ "examples": [ "\"2020-07-09T00:17:42Z\"" ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ diff --git a/lib/search/indexes/github-docs-3.2-cn-records.json.br b/lib/search/indexes/github-docs-3.2-cn-records.json.br index 04bb151174a9..2f4c74e25f89 100644 --- a/lib/search/indexes/github-docs-3.2-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.2-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:5c6554f20dbb30fe63648b4f254c2bb07a1bfd73e54929be3c2b0b22af2b43c4 -size 795308 +oid sha256:5689f148ee882b3491cd63ebb57572f50a28e175900db3e763c8c5648b700dd8 +size 795306 diff --git a/lib/search/indexes/github-docs-3.2-cn.json.br b/lib/search/indexes/github-docs-3.2-cn.json.br index 5a53970dbf66..1eedb427ab42 100644 --- a/lib/search/indexes/github-docs-3.2-cn.json.br +++ b/lib/search/indexes/github-docs-3.2-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:50a908fe6956fc188661463f7e356e016cda90b32cc0a2db2adb3cc7f6adab06 -size 1647745 +oid sha256:07ed481c5036af6918402ecd6e08998e105e30ef00f036598578ec5d9623a52b +size 1646025 diff --git a/lib/search/indexes/github-docs-3.2-en-records.json.br b/lib/search/indexes/github-docs-3.2-en-records.json.br index d98d2bd578fb..d5d5109ee5fd 100644 --- a/lib/search/indexes/github-docs-3.2-en-records.json.br +++ b/lib/search/indexes/github-docs-3.2-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:02a6a94bd531fbb7e373658a9a2a39ae11cd2b6805db6e3567de91be5ec7f435 -size 1094154 +oid sha256:5c1dbbe4232ac4ed3d697ad243b350d75321ab344523c1328ca2e6032f1eee51 +size 1095685 diff --git a/lib/search/indexes/github-docs-3.2-en.json.br b/lib/search/indexes/github-docs-3.2-en.json.br index 11ade8fa4f92..a78b96660615 100644 --- a/lib/search/indexes/github-docs-3.2-en.json.br +++ b/lib/search/indexes/github-docs-3.2-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:276882cdfeb3aa6633b84c306f0a52e2b1a010c24e9763bc82f95831579672bb -size 4437230 +oid sha256:6c46d5672e549555ee0e0ce9e157ef128a02587181cba9ecdb1cde3a25652210 +size 4442701 diff --git a/lib/search/indexes/github-docs-3.2-es-records.json.br b/lib/search/indexes/github-docs-3.2-es-records.json.br index 953263b94815..f9b7816de99e 100644 --- a/lib/search/indexes/github-docs-3.2-es-records.json.br +++ b/lib/search/indexes/github-docs-3.2-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:3884867a2d36348b11be07c84d7f471a6a2aff591954247d6d40ac1f01166ff2 -size 734535 +oid sha256:5235b61893754583cb566fa2982bbdf20848072d3df913a82299fd0e2604c9c2 +size 734804 diff --git a/lib/search/indexes/github-docs-3.2-es.json.br b/lib/search/indexes/github-docs-3.2-es.json.br index b99130a18c87..12231ae49afd 100644 --- a/lib/search/indexes/github-docs-3.2-es.json.br +++ b/lib/search/indexes/github-docs-3.2-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a63ca466af6f7ff52c2332596123b6780c78e41d3180b39e482da823a7d805b0 -size 3130592 +oid sha256:a9ff6bd784db1c9bccc4cfa2b34d1e412300b46953d1ec64b1c42f0aff34fec7 +size 3130290 diff --git a/lib/search/indexes/github-docs-3.2-ja-records.json.br b/lib/search/indexes/github-docs-3.2-ja-records.json.br index 7b1f3a67719c..9bb437fe4070 100644 --- a/lib/search/indexes/github-docs-3.2-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.2-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:7e82177e84cbc07d8de38279747353142ad35a340e980e0d18ac4843a3d8b9af -size 810997 +oid sha256:bf149f28054e3405eb27efee62e8aecc965e980cccece513b300d33e76fedde0 +size 810806 diff --git a/lib/search/indexes/github-docs-3.2-ja.json.br b/lib/search/indexes/github-docs-3.2-ja.json.br index 479196803f9f..690f31da8ab3 100644 --- a/lib/search/indexes/github-docs-3.2-ja.json.br +++ b/lib/search/indexes/github-docs-3.2-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a10e66fb076edc2ca5fbe6d3e788d4fe59f72c1a7f86ab9dc6774a7d6bd05479 -size 4451431 +oid sha256:3be6934fadc768d9c3e09641277416ece47e8bd6d2a335cf16357509099e5f04 +size 4455182 diff --git a/lib/search/indexes/github-docs-3.2-pt-records.json.br b/lib/search/indexes/github-docs-3.2-pt-records.json.br index 721e479b2163..1b9c5c86a96d 100644 --- a/lib/search/indexes/github-docs-3.2-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.2-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:dbbb5ed3b3ef797a44dcd845df0eaeef22a8ec32eb0a2f937867cb95dab4c05e -size 723513 +oid sha256:4126fee0618cf631b3a5b56dbb74465f2d1248fef2de81de5d8fbf3402ff1521 +size 722921 diff --git a/lib/search/indexes/github-docs-3.2-pt.json.br b/lib/search/indexes/github-docs-3.2-pt.json.br index dfd92c2cefa0..7c350ad6c1e2 100644 --- a/lib/search/indexes/github-docs-3.2-pt.json.br +++ b/lib/search/indexes/github-docs-3.2-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:97d1943606e12b577a3201894f3e760e1d184adaed62a57d7997f3a1693748dd -size 3026257 +oid sha256:c064ad406b470957940ac3d90f2e55bde8ad89f855e66e8875972a7b40c8f3d1 +size 3022537 diff --git a/lib/search/indexes/github-docs-3.3-cn-records.json.br b/lib/search/indexes/github-docs-3.3-cn-records.json.br index 4d154049fae6..c2d30c30c4ac 100644 --- a/lib/search/indexes/github-docs-3.3-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.3-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:81acd065f11b430475d798ca88db6362d6a7b5911524cd1889297f25a266761d -size 820836 +oid sha256:1052d9901b54662f7579c32475618a3910df2895aefb68387fb49133e0ce3e16 +size 821072 diff --git a/lib/search/indexes/github-docs-3.3-cn.json.br b/lib/search/indexes/github-docs-3.3-cn.json.br index 3ef609c04c04..2b599b59cf34 100644 --- a/lib/search/indexes/github-docs-3.3-cn.json.br +++ b/lib/search/indexes/github-docs-3.3-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:750d67a3d6ba0f5b9a709f1c4cf6ba90315231900c91bff997d790f60696bac0 -size 1695453 +oid sha256:69ebe183fea7360a3144aaeeb0532cb2598c7456b87520fe120384e9c90405ed +size 1694059 diff --git a/lib/search/indexes/github-docs-3.3-en-records.json.br b/lib/search/indexes/github-docs-3.3-en-records.json.br index 800bf5bb7925..4e1347fc9dac 100644 --- a/lib/search/indexes/github-docs-3.3-en-records.json.br +++ b/lib/search/indexes/github-docs-3.3-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2089a54fbfd6366f7d81a65d0ffd1e59ca050ac771e8bdd97edac0182b26932b -size 1128879 +oid sha256:2338630384393d277fa9f277ca6f8eebd762041d93c39b52d7b48966c1de0b2a +size 1130709 diff --git a/lib/search/indexes/github-docs-3.3-en.json.br b/lib/search/indexes/github-docs-3.3-en.json.br index 97b44cbde7f3..fb606170b872 100644 --- a/lib/search/indexes/github-docs-3.3-en.json.br +++ b/lib/search/indexes/github-docs-3.3-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:0967f88bba28a312918894066e046b2a8e382fd2878007414171171499e664f4 -size 4538916 +oid sha256:4a3e12dda01511b892d95f06d2d3751b38967350830d38d67a7c2b7d46257dd7 +size 4547813 diff --git a/lib/search/indexes/github-docs-3.3-es-records.json.br b/lib/search/indexes/github-docs-3.3-es-records.json.br index 23a36bee102f..95ee16b252bf 100644 --- a/lib/search/indexes/github-docs-3.3-es-records.json.br +++ b/lib/search/indexes/github-docs-3.3-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:d83df52055326f81910b55fb4ff5881a450e4e446127b38c4cd704cdc56b31b8 -size 755794 +oid sha256:16e8fc4ecc7b1e5491a13901a1edacb5f65ce01a66c85c09af0a920d8c2fd694 +size 755914 diff --git a/lib/search/indexes/github-docs-3.3-es.json.br b/lib/search/indexes/github-docs-3.3-es.json.br index dcd8cb2ac1f4..2c58241ccfb3 100644 --- a/lib/search/indexes/github-docs-3.3-es.json.br +++ b/lib/search/indexes/github-docs-3.3-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:aac53539b5c0e4cd9ffa0dd033484c43d7a552b617223637e3d7ee84cc01451b -size 3215009 +oid sha256:a795efb712833d3d61a6422422a1d5bbb99f4fa775a09bf9a6fb33eac04bee48 +size 3214357 diff --git a/lib/search/indexes/github-docs-3.3-ja-records.json.br b/lib/search/indexes/github-docs-3.3-ja-records.json.br index a104e3735657..98e98795d186 100644 --- a/lib/search/indexes/github-docs-3.3-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.3-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:7e60d34fc24fa98f1b1d9ecc7af5c46366593eb025cc1b45e6691b7652dd23a3 -size 836264 +oid sha256:420bc13d24b0eacf5eab698d63a7ebd1338b6ed5c1fe2f51dbeec10fdcd091ed +size 836225 diff --git a/lib/search/indexes/github-docs-3.3-ja.json.br b/lib/search/indexes/github-docs-3.3-ja.json.br index fefb1a50195c..722afbf82b05 100644 --- a/lib/search/indexes/github-docs-3.3-ja.json.br +++ b/lib/search/indexes/github-docs-3.3-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:38eece9205e4712a813766aa0aa69b88faf2a47438b41318a4c2200fd404b7f8 -size 4587783 +oid sha256:e75bf7454475205a2c30ff393f32ad96c22ea0d9eb3d00f2ab3ac7424bcc1c9e +size 4589978 diff --git a/lib/search/indexes/github-docs-3.3-pt-records.json.br b/lib/search/indexes/github-docs-3.3-pt-records.json.br index dccb30d026ec..41743ddc7105 100644 --- a/lib/search/indexes/github-docs-3.3-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.3-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:d6f2453588d1815beb85de2602594d2935761ae1bc57013823343632b42d4fa4 -size 745103 +oid sha256:026cf70ba2f15d17de34a5d0d795222befc95de46afb0e3051b617847ea02d46 +size 744566 diff --git a/lib/search/indexes/github-docs-3.3-pt.json.br b/lib/search/indexes/github-docs-3.3-pt.json.br index 17b9c19448ae..9202820629f0 100644 --- a/lib/search/indexes/github-docs-3.3-pt.json.br +++ b/lib/search/indexes/github-docs-3.3-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:544351a66fc5a7c8a84281d063aac0588e1576f96e29dfb16e6be8114a2fe55e -size 3111749 +oid sha256:b194ccdf1c3453ea85d2261d755a58b2876ab4a70a3e43a6834406fe22166021 +size 3108776 diff --git a/lib/search/indexes/github-docs-3.4-cn-records.json.br b/lib/search/indexes/github-docs-3.4-cn-records.json.br index 40cfedb97aa6..864ac421068b 100644 --- a/lib/search/indexes/github-docs-3.4-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.4-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:8e4e58851fe91ddbbb67b65115e0eceb3bf655a77bf077ef1bf5d08002bc0628 -size 823393 +oid sha256:a9121c299f95308ab726636598caa49cad328710aed3a349a76521ec2ee85596 +size 823634 diff --git a/lib/search/indexes/github-docs-3.4-cn.json.br b/lib/search/indexes/github-docs-3.4-cn.json.br index 99948eaa5450..f6d0e79a1c5e 100644 --- a/lib/search/indexes/github-docs-3.4-cn.json.br +++ b/lib/search/indexes/github-docs-3.4-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:d65d065c5e30affd752118321b31dbfebae80084ca85a562ae1fac6b4bb7dbc9 -size 1711342 +oid sha256:875591e5a1e520d71d13a34c41a0db2c55b0136dc553438e0dbba9f0fbf3e57f +size 1710381 diff --git a/lib/search/indexes/github-docs-3.4-en-records.json.br b/lib/search/indexes/github-docs-3.4-en-records.json.br index 098e4d2da03c..11e00098478e 100644 --- a/lib/search/indexes/github-docs-3.4-en-records.json.br +++ b/lib/search/indexes/github-docs-3.4-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:60cb0c0eb5901a369de471552578f09695a2715f40c54f8345a344c07825183b -size 1140705 +oid sha256:4877c7ec148ea452bce90f5cbee9022c912a6aea1b804e9b74c30d9c19697741 +size 1142713 diff --git a/lib/search/indexes/github-docs-3.4-en.json.br b/lib/search/indexes/github-docs-3.4-en.json.br index 628cbd7f6447..03175ebda592 100644 --- a/lib/search/indexes/github-docs-3.4-en.json.br +++ b/lib/search/indexes/github-docs-3.4-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:b89a0aeaee84e4c2df9385b26f721dd364c3c78b6de1ca13353433e62a5fa686 -size 4597185 +oid sha256:95fe590836c973f2e2f357ff22b4dbb9d98cf199c385d555db261947175fab38 +size 4606419 diff --git a/lib/search/indexes/github-docs-3.4-es-records.json.br b/lib/search/indexes/github-docs-3.4-es-records.json.br index d86ddc857d47..b31aeab23eac 100644 --- a/lib/search/indexes/github-docs-3.4-es-records.json.br +++ b/lib/search/indexes/github-docs-3.4-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:b10c295013bb13d0df66c7cd589d0cde5c292f2396dfdb0cd86e7c19d9b2a35e -size 760448 +oid sha256:5192088d2123aea517dae6400959c186aee79563d58067d637c842a1d7ae8de7 +size 760620 diff --git a/lib/search/indexes/github-docs-3.4-es.json.br b/lib/search/indexes/github-docs-3.4-es.json.br index 2c50fcaa6cb6..281f7f29bd24 100644 --- a/lib/search/indexes/github-docs-3.4-es.json.br +++ b/lib/search/indexes/github-docs-3.4-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:cedde3504ffed353f2beba07ddd325053706e407320647d0333537bfee8775db -size 3238456 +oid sha256:77eb259a7e37f7e556ecddf2adca27d7f779ecb403e085f90485d46a18b42013 +size 3239478 diff --git a/lib/search/indexes/github-docs-3.4-ja-records.json.br b/lib/search/indexes/github-docs-3.4-ja-records.json.br index 4caa62b7b60f..bb41f663b8c6 100644 --- a/lib/search/indexes/github-docs-3.4-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.4-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c07b18d9426eb09ed3b410bcb290dc6a9ad21e08973790b20dafb00c861ec863 -size 839698 +oid sha256:70ff65d81e8c71aea3bae7c785488df08c73ef77614a8f26f406e6261b92088a +size 839784 diff --git a/lib/search/indexes/github-docs-3.4-ja.json.br b/lib/search/indexes/github-docs-3.4-ja.json.br index af162b67527b..19cf5bfc12ff 100644 --- a/lib/search/indexes/github-docs-3.4-ja.json.br +++ b/lib/search/indexes/github-docs-3.4-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c3fbfea2813098d352190b37207c7b3eadb13572d27de04fa90b5c67e0bbb74e -size 4619773 +oid sha256:c532037cbdf2ac20040e29c23c255e7cd58ea2ab8e5fd890dafe4deda8d5698c +size 4624553 diff --git a/lib/search/indexes/github-docs-3.4-pt-records.json.br b/lib/search/indexes/github-docs-3.4-pt-records.json.br index 8984294412ad..768e5fc25be7 100644 --- a/lib/search/indexes/github-docs-3.4-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.4-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:5b99fb3bd06efa3a00682602897f9fc98653a6ffc10ee49785b3cb3c50cc31f6 -size 749363 +oid sha256:1d530b79f582f346ab0d509e073b08843877e56f8db4fdf7e9b59dda84ad1e44 +size 748917 diff --git a/lib/search/indexes/github-docs-3.4-pt.json.br b/lib/search/indexes/github-docs-3.4-pt.json.br index b51b8b3162ec..2d1466a5b6fb 100644 --- a/lib/search/indexes/github-docs-3.4-pt.json.br +++ b/lib/search/indexes/github-docs-3.4-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:6bbc9194d7af57288ddf314ebac699cb99d94f62f5105cf0bb99ccdb955523a3 -size 3136205 +oid sha256:a96bd8c013ad238138796e087ff6b131f21d85a7781dcee75e317e07620192c2 +size 3133722 diff --git a/lib/search/indexes/github-docs-3.5-cn-records.json.br b/lib/search/indexes/github-docs-3.5-cn-records.json.br index ae8fd4d03359..c101523d8a6a 100644 --- a/lib/search/indexes/github-docs-3.5-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.5-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:359a9be23454d6ece98a3092a01f5204cc188dc7d48b4432142caa4eac252384 -size 854748 +oid sha256:b9a97274254341cbf1b2be660db7848a840dc1ed6c4c2041e4a5365547a99ee1 +size 855168 diff --git a/lib/search/indexes/github-docs-3.5-cn.json.br b/lib/search/indexes/github-docs-3.5-cn.json.br index 43b488857737..22b976c79df5 100644 --- a/lib/search/indexes/github-docs-3.5-cn.json.br +++ b/lib/search/indexes/github-docs-3.5-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c58adc6f04a43b4f4cfd7da8f8cde10a722d4919739396bdffa5a6719097e7a4 -size 1779265 +oid sha256:316c6c24a14bdf61ee83c2ee4d0ab23c3ca82f1e01fce6ebb1e6b35a721e2115 +size 1779484 diff --git a/lib/search/indexes/github-docs-3.5-en-records.json.br b/lib/search/indexes/github-docs-3.5-en-records.json.br index 86cec794a922..35f61d7d059b 100644 --- a/lib/search/indexes/github-docs-3.5-en-records.json.br +++ b/lib/search/indexes/github-docs-3.5-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:67ee1bdb635070798c2150f00e47979ef6338e6819f89ad8aa16cbda6e1cf8f7 -size 1180111 +oid sha256:069276dfb7bb31576b63915e7ca2a1baf13eb3b6c3b622249dfbd702eb9bb337 +size 1182302 diff --git a/lib/search/indexes/github-docs-3.5-en.json.br b/lib/search/indexes/github-docs-3.5-en.json.br index 3049bfc030fb..2746b259bc83 100644 --- a/lib/search/indexes/github-docs-3.5-en.json.br +++ b/lib/search/indexes/github-docs-3.5-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:600e4d408dc8eea97be0344de5a02cd15028c31ac426b1cab75283bc23fffa51 -size 4762270 +oid sha256:e3326f1e84c603cb28eb913ae0409fde49b65caec7838e19c1921b0c15b7382b +size 4771660 diff --git a/lib/search/indexes/github-docs-3.5-es-records.json.br b/lib/search/indexes/github-docs-3.5-es-records.json.br index e72938d9d86f..8cb8ae75a1ba 100644 --- a/lib/search/indexes/github-docs-3.5-es-records.json.br +++ b/lib/search/indexes/github-docs-3.5-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:726e0918c1ae7a12f3f12c5028eae542550237a960fc476eb8e7faba903088fb -size 784945 +oid sha256:dc4cfbfe6405dd8acf1cbb89a5a9656dddbe5c3c292130a1eae5f63d845f2431 +size 785432 diff --git a/lib/search/indexes/github-docs-3.5-es.json.br b/lib/search/indexes/github-docs-3.5-es.json.br index 94b5095bb2af..e69ee054b2bb 100644 --- a/lib/search/indexes/github-docs-3.5-es.json.br +++ b/lib/search/indexes/github-docs-3.5-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:7dd387f3ff44744242824fdc854a849dc299826c0e1c18ac241f962450175d5b -size 3357366 +oid sha256:62c4b241341e24af967e71c31470b6420cab3a03c1b21913fe5af106b3de08d7 +size 3359177 diff --git a/lib/search/indexes/github-docs-3.5-ja-records.json.br b/lib/search/indexes/github-docs-3.5-ja-records.json.br index 0b6860aeb821..c8976e4bf21e 100644 --- a/lib/search/indexes/github-docs-3.5-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.5-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:17ab5460a2ee3f2809d31b467029076c85c6502b41e9672b26e7aea0bd2124d4 -size 868750 +oid sha256:acb46959863c35c7c70686084aec07e5d944cb14f8121b8abe103bc65c871fec +size 869133 diff --git a/lib/search/indexes/github-docs-3.5-ja.json.br b/lib/search/indexes/github-docs-3.5-ja.json.br index 2a5c70466ce8..8d00c016a49e 100644 --- a/lib/search/indexes/github-docs-3.5-ja.json.br +++ b/lib/search/indexes/github-docs-3.5-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:5086b3d17191993144480ab72c8bd66843c5d71a384bd77ac2bdf39b7cf8e527 -size 4797129 +oid sha256:a35deb05439bdc8f002e737f31c29ad65420aa5223ad4585bb6c5dd262aa0808 +size 4801343 diff --git a/lib/search/indexes/github-docs-3.5-pt-records.json.br b/lib/search/indexes/github-docs-3.5-pt-records.json.br index 552da0a25b26..110a209ed49d 100644 --- a/lib/search/indexes/github-docs-3.5-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.5-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:0bf406b274df3c3af43057549884466bde8f14ae94731c20bed386a12169adbd -size 773720 +oid sha256:20259d75cc6146a604e33dedf251c23a6a0e35e0b661b9e776a353da16a738df +size 773443 diff --git a/lib/search/indexes/github-docs-3.5-pt.json.br b/lib/search/indexes/github-docs-3.5-pt.json.br index 05b7ee8b993a..b3df31f77f0c 100644 --- a/lib/search/indexes/github-docs-3.5-pt.json.br +++ b/lib/search/indexes/github-docs-3.5-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:9b563900639c8e886e1030cb2249c864843080cc5f91e4312fb3d7bd37ce16f3 -size 3251280 +oid sha256:e2e62614a1df1aaf5c0d4a2b2196fd43944c035fbe3fc996046fffd6ca90651c +size 3249948 diff --git a/lib/search/indexes/github-docs-3.6-cn-records.json.br b/lib/search/indexes/github-docs-3.6-cn-records.json.br index 5e6a10219480..1fce1e63061f 100644 --- a/lib/search/indexes/github-docs-3.6-cn-records.json.br +++ b/lib/search/indexes/github-docs-3.6-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:d1c3b4f0578fdee83e1555cf26a1e378116a79e1df5f4055241448e59a5d0302 -size 876374 +oid sha256:617379bf2d9c2f8f78bc2fe9a7f18ee5142cef4d499fd08ebfff142ac1031242 +size 876617 diff --git a/lib/search/indexes/github-docs-3.6-cn.json.br b/lib/search/indexes/github-docs-3.6-cn.json.br index 8f9b3f882b86..8c4b6d0a1b3b 100644 --- a/lib/search/indexes/github-docs-3.6-cn.json.br +++ b/lib/search/indexes/github-docs-3.6-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:82c3abac1755520c21b228f0fcd5a0bf020e6fa6b0c4a30397c1ab852e03210f -size 1826032 +oid sha256:ed8478a9dc93e31628e7fa6edf86f6d35e0c01a648127141ce1dfceac3ece0de +size 1827036 diff --git a/lib/search/indexes/github-docs-3.6-en-records.json.br b/lib/search/indexes/github-docs-3.6-en-records.json.br index fc08cbfba9e9..27bcda90b516 100644 --- a/lib/search/indexes/github-docs-3.6-en-records.json.br +++ b/lib/search/indexes/github-docs-3.6-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ff097d4b175d0693b6274ae3f755b9fab3763e6456c9f72c228315fb3ae04afb -size 1208887 +oid sha256:7e88517cdf91155ec305f041c0f3e503e7bd430a75bb35e1c2285127ad9c90f3 +size 1211487 diff --git a/lib/search/indexes/github-docs-3.6-en.json.br b/lib/search/indexes/github-docs-3.6-en.json.br index 40049c679954..0b64cac526d5 100644 --- a/lib/search/indexes/github-docs-3.6-en.json.br +++ b/lib/search/indexes/github-docs-3.6-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c17623e46191725c5bdc7ba42a140465e402a928d329c4e2822f1a8d5e336896 -size 4875445 +oid sha256:5ccfe049a8907bae61c2e244ca2a8fd9e1eaac9bb117da94f5ed9006e0eb22f5 +size 4886712 diff --git a/lib/search/indexes/github-docs-3.6-es-records.json.br b/lib/search/indexes/github-docs-3.6-es-records.json.br index 287fa0e9d1c3..241af22cc479 100644 --- a/lib/search/indexes/github-docs-3.6-es-records.json.br +++ b/lib/search/indexes/github-docs-3.6-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:798131490fa0ccb1c60ea751648d34d1ee6959f324b71e076b4d5f5b5b392746 -size 805040 +oid sha256:8a0513cf064c8557c5253613f0b29d419677a5efdf174d7517b00a281c5ddf9b +size 805604 diff --git a/lib/search/indexes/github-docs-3.6-es.json.br b/lib/search/indexes/github-docs-3.6-es.json.br index 02b848c5c785..ba7ca28e0a4c 100644 --- a/lib/search/indexes/github-docs-3.6-es.json.br +++ b/lib/search/indexes/github-docs-3.6-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:289a1da3373d6462d5bd9b1f365821a391e62c6d50a4628746d917fb31e62083 -size 3451121 +oid sha256:27351a1e4bc165cb1b581af14eb0b769eba665142ef410c9180356985adf18aa +size 3450766 diff --git a/lib/search/indexes/github-docs-3.6-ja-records.json.br b/lib/search/indexes/github-docs-3.6-ja-records.json.br index 5b806cd0df97..bf9b83517b19 100644 --- a/lib/search/indexes/github-docs-3.6-ja-records.json.br +++ b/lib/search/indexes/github-docs-3.6-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:700499c7db8918921132ae81fda70b4da05acbd3e4adcfa10993add8d3f37dd4 -size 890761 +oid sha256:a90b44e166ab7d53bc483941af815fa2750f04ef0764b940fcaa8c0107a47b1d +size 890840 diff --git a/lib/search/indexes/github-docs-3.6-ja.json.br b/lib/search/indexes/github-docs-3.6-ja.json.br index 5b212a7020a9..3726aa99c642 100644 --- a/lib/search/indexes/github-docs-3.6-ja.json.br +++ b/lib/search/indexes/github-docs-3.6-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:8e57978bb16b540a864e8bf54b92d469400482fdb310cf649e2f87db2bd0229e -size 4922818 +oid sha256:83ec093b153f1e865cd9376ad690da33088100851ea0ae988f61d2501d8be69b +size 4928446 diff --git a/lib/search/indexes/github-docs-3.6-pt-records.json.br b/lib/search/indexes/github-docs-3.6-pt-records.json.br index fd56fd7ae0a3..0cd3ab4d604f 100644 --- a/lib/search/indexes/github-docs-3.6-pt-records.json.br +++ b/lib/search/indexes/github-docs-3.6-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:56f5d41348f2f5f46137237f087ad0b5ab2b24cfa27117b79c03db39e069bc3d -size 793622 +oid sha256:30eef6250fcfbb840d577a95fb147764a1a2919f8db043f4cf2a0ce4d485a51b +size 793637 diff --git a/lib/search/indexes/github-docs-3.6-pt.json.br b/lib/search/indexes/github-docs-3.6-pt.json.br index ee124419f02e..901e48f8129c 100644 --- a/lib/search/indexes/github-docs-3.6-pt.json.br +++ b/lib/search/indexes/github-docs-3.6-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:d32dc2b94b54c8c1e8575cbfd27cf2540a6009969ab8b79d9ddb9121d813aa0d -size 3343705 +oid sha256:af4339042a21cd3e138ef2358e3850457231e9dee0ccf6e18fc87cfa5244be88 +size 3340747 diff --git a/lib/search/indexes/github-docs-dotcom-cn-records.json.br b/lib/search/indexes/github-docs-dotcom-cn-records.json.br index 0f4bcb62486e..db251f487abb 100644 --- a/lib/search/indexes/github-docs-dotcom-cn-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:553113ca19355d5e41ad061d09404e0f5a3ffe9a5059fb1e6431925fd890369f -size 1039362 +oid sha256:2137b5ac83d224c2a6d361c2da6b0571a46ad98a18ee34e6caaedb736da17e6d +size 1039578 diff --git a/lib/search/indexes/github-docs-dotcom-cn.json.br b/lib/search/indexes/github-docs-dotcom-cn.json.br index fe4061bb592b..50424f79fd4b 100644 --- a/lib/search/indexes/github-docs-dotcom-cn.json.br +++ b/lib/search/indexes/github-docs-dotcom-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:f99d7b083d63eaf3cef1ca0ae0cdf9c860ac5c4e933ffcd383992049a56bb21a -size 1883883 +oid sha256:c610a9974cb932efb1c8d79c9b2521d0620a3c2f6f89417706d18dac2a5851b1 +size 1887569 diff --git a/lib/search/indexes/github-docs-dotcom-en-records.json.br b/lib/search/indexes/github-docs-dotcom-en-records.json.br index 2cb570fb2aab..d42b169552e6 100644 --- a/lib/search/indexes/github-docs-dotcom-en-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:12bd35c4a3fa65ce6f08f3c154e92a3f6277865b2af50c0b99fe3696d265ad99 -size 1456764 +oid sha256:960f917f54d78a206e694fa76c2dcdc1e2a59ed1d477acdfe1ddf231128afcd0 +size 1464610 diff --git a/lib/search/indexes/github-docs-dotcom-en.json.br b/lib/search/indexes/github-docs-dotcom-en.json.br index 0665ca34a625..4a34ec93b343 100644 --- a/lib/search/indexes/github-docs-dotcom-en.json.br +++ b/lib/search/indexes/github-docs-dotcom-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:b2eaf923a24f6c41398cab1bd58755a1036bed61d2134d41183f2b7ea6a706bc -size 5612095 +oid sha256:29c74ec9f68eab3c7523dc075bb00db54398afb6082f6d896cc8acd92d4e0e67 +size 5643987 diff --git a/lib/search/indexes/github-docs-dotcom-es-records.json.br b/lib/search/indexes/github-docs-dotcom-es-records.json.br index fdb3fc49322b..cf6015617dac 100644 --- a/lib/search/indexes/github-docs-dotcom-es-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:0504c40231906388595b00974dcc9bb1979137b4ba920c9096d63c1844d97f09 -size 937362 +oid sha256:1a61b1c593b16c710269953e02d89f89c5ba984bca785d7b8c86921d1c116998 +size 940051 diff --git a/lib/search/indexes/github-docs-dotcom-es.json.br b/lib/search/indexes/github-docs-dotcom-es.json.br index a62936afc250..43bdfde3fdd8 100644 --- a/lib/search/indexes/github-docs-dotcom-es.json.br +++ b/lib/search/indexes/github-docs-dotcom-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:7ded21b32f503c3f63e18e2fc15615f6090a483191a69ccb2553aa17864b5f44 -size 3893677 +oid sha256:6605022c698e573eddf3064cc8db0b44355f657063d85ea170742e71abb61429 +size 3912724 diff --git a/lib/search/indexes/github-docs-dotcom-ja-records.json.br b/lib/search/indexes/github-docs-dotcom-ja-records.json.br index 86e94b9c75fa..ec10e9609a1b 100644 --- a/lib/search/indexes/github-docs-dotcom-ja-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:436799a5400f466f070e12ecbdcf857dd433d5479bbe59029d42402890762a4e -size 1047158 +oid sha256:db6480e67019808a6b23bfd4faba0dedfa3887daa5871b2ddbd5093d213a573b +size 1047682 diff --git a/lib/search/indexes/github-docs-dotcom-ja.json.br b/lib/search/indexes/github-docs-dotcom-ja.json.br index 9b51248945f0..c6982e993725 100644 --- a/lib/search/indexes/github-docs-dotcom-ja.json.br +++ b/lib/search/indexes/github-docs-dotcom-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:7ac5de585ee7143e7111fc9d11ca9cc331f74f3b078d3c6d6621fc77c3e3ee54 -size 5625019 +oid sha256:07300d19fc147523e2f7c6bec5255378330a9f87159d1026e57ee27cf9c2b042 +size 5634046 diff --git a/lib/search/indexes/github-docs-dotcom-pt-records.json.br b/lib/search/indexes/github-docs-dotcom-pt-records.json.br index 665aced4d288..0aeec2b35127 100644 --- a/lib/search/indexes/github-docs-dotcom-pt-records.json.br +++ b/lib/search/indexes/github-docs-dotcom-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:81e0eaeb787ec7bb1e8869ca9faec4e87e34f536204ea18a5985b95ee8df0892 -size 926604 +oid sha256:2e42d17da902f1bc9bf9e038dc31228338ba07cebb2795cef12d5de2b7976737 +size 926387 diff --git a/lib/search/indexes/github-docs-dotcom-pt.json.br b/lib/search/indexes/github-docs-dotcom-pt.json.br index 0e18a80f8975..077a81d755c7 100644 --- a/lib/search/indexes/github-docs-dotcom-pt.json.br +++ b/lib/search/indexes/github-docs-dotcom-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:acf955981e542bb0b8f5a755de95f4317c3a440ca064ab37c6b1585121071ab4 -size 3797128 +oid sha256:11d54ef96be5ea9698babe25d95913f82ced2005f20caacc0dc0da3e0c67ae61 +size 3792051 diff --git a/lib/search/indexes/github-docs-ghae-cn-records.json.br b/lib/search/indexes/github-docs-ghae-cn-records.json.br index 0e32152d9703..e4896616bc9d 100644 --- a/lib/search/indexes/github-docs-ghae-cn-records.json.br +++ b/lib/search/indexes/github-docs-ghae-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:55060b67d84a269b0c026f98aa9d76a8b5ab9033fdca1209399e5e6aa7688e6b -size 660726 +oid sha256:51f567e6818f598c52c52e15fb0de1877a6551058d6db130668da84af3d5c73f +size 660914 diff --git a/lib/search/indexes/github-docs-ghae-cn.json.br b/lib/search/indexes/github-docs-ghae-cn.json.br index d925be2f89ab..aad7cd435112 100644 --- a/lib/search/indexes/github-docs-ghae-cn.json.br +++ b/lib/search/indexes/github-docs-ghae-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:6217a65de00d85b6392041258788e4c37f51515e3199e2b114aef49155aaf56a -size 1323183 +oid sha256:efff7a0664ecceab018e47a8a9cb8a8df10c68d4b3ff196897a4011c699d7ee4 +size 1322702 diff --git a/lib/search/indexes/github-docs-ghae-en-records.json.br b/lib/search/indexes/github-docs-ghae-en-records.json.br index bff197cc9fe9..005a0171e807 100644 --- a/lib/search/indexes/github-docs-ghae-en-records.json.br +++ b/lib/search/indexes/github-docs-ghae-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:28fd4dc2edda52956106c2e592198bf223cd3c4904ef1732d56a247886a913cf -size 938118 +oid sha256:602a14f1a9f78a8c57a7b0c14cc587d5231ea0f7701e4d0b4b58cb717fd704b4 +size 940178 diff --git a/lib/search/indexes/github-docs-ghae-en.json.br b/lib/search/indexes/github-docs-ghae-en.json.br index dcd6a48c13fa..043670720d0e 100644 --- a/lib/search/indexes/github-docs-ghae-en.json.br +++ b/lib/search/indexes/github-docs-ghae-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e7c16e39946cf77bf9c02c2986b827031a3601db98094bc5f97fd99cb6426c9c -size 3719728 +oid sha256:d74c66526c70e17c5d6cc59be3b93ade13513df2204d610473aa28af3a177464 +size 3730247 diff --git a/lib/search/indexes/github-docs-ghae-es-records.json.br b/lib/search/indexes/github-docs-ghae-es-records.json.br index 75be259f67c0..323c2367cd97 100644 --- a/lib/search/indexes/github-docs-ghae-es-records.json.br +++ b/lib/search/indexes/github-docs-ghae-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:8e23fcc882ffb3e646a791fe154e76c89e02b3d0151facba1b728f45a30258ba -size 614526 +oid sha256:d0c48c0898e7b86e19a716b1089145779411ed260415eecd1c9e32a053f045a1 +size 615258 diff --git a/lib/search/indexes/github-docs-ghae-es.json.br b/lib/search/indexes/github-docs-ghae-es.json.br index 9f18b3cc967b..e53aa3903c94 100644 --- a/lib/search/indexes/github-docs-ghae-es.json.br +++ b/lib/search/indexes/github-docs-ghae-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:e416e7a575518d6f85fd37140e17b31dafa2136cb10734378aa8441690e1f9fb -size 2538147 +oid sha256:fca6a7c298e37a8ca450374fe35e3bf5e0b4f52682579b7eb02f89ea2eaae4c9 +size 2539225 diff --git a/lib/search/indexes/github-docs-ghae-ja-records.json.br b/lib/search/indexes/github-docs-ghae-ja-records.json.br index a98ff6eb24fe..5153604ea9e3 100644 --- a/lib/search/indexes/github-docs-ghae-ja-records.json.br +++ b/lib/search/indexes/github-docs-ghae-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a110e687691fd3c7f6e9daf61772b78a2be67cc0e09d55fa77448b1bc77b26bc -size 674075 +oid sha256:c2496cea9d48c35301957dcc09eaf5b3079d32f3c68ebafd18521e3d115fea33 +size 674451 diff --git a/lib/search/indexes/github-docs-ghae-ja.json.br b/lib/search/indexes/github-docs-ghae-ja.json.br index 6fe17ffa18c9..a553a43dab59 100644 --- a/lib/search/indexes/github-docs-ghae-ja.json.br +++ b/lib/search/indexes/github-docs-ghae-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4aa8fdbd2f194b6c6097687b86ddb192940ff4428856adde2afd6923fc06fb04 -size 3606015 +oid sha256:636ca1e59d73ff4400c558b05f2706de9b9a05f9bc32c13c9bc69e8b1a2baada +size 3609701 diff --git a/lib/search/indexes/github-docs-ghae-pt-records.json.br b/lib/search/indexes/github-docs-ghae-pt-records.json.br index deef2363b0c1..de431a7d03ee 100644 --- a/lib/search/indexes/github-docs-ghae-pt-records.json.br +++ b/lib/search/indexes/github-docs-ghae-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:dc2aa6e8dd705b07ae3120e7f5c6056c3129b56f045dbba8de3aeb28e1547458 -size 606079 +oid sha256:434b8b6407c8acf62f9b384f54f431789de2d003da8d7048825def19c0da712a +size 605871 diff --git a/lib/search/indexes/github-docs-ghae-pt.json.br b/lib/search/indexes/github-docs-ghae-pt.json.br index 272a9897d558..720eca2d48b3 100644 --- a/lib/search/indexes/github-docs-ghae-pt.json.br +++ b/lib/search/indexes/github-docs-ghae-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:07547b9155b6a34859ca42be13f3f3062e78725e9ac15fbc36a3bf99c2e8632b -size 2437326 +oid sha256:42dd5c86e51f64212d6795418b6091c72f70e6b285e66a77410352bdeff758d9 +size 2433830 diff --git a/lib/search/indexes/github-docs-ghec-cn-records.json.br b/lib/search/indexes/github-docs-ghec-cn-records.json.br index 8f9eecf20d84..2fe1930822a2 100644 --- a/lib/search/indexes/github-docs-ghec-cn-records.json.br +++ b/lib/search/indexes/github-docs-ghec-cn-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:989d3804ab9a385b9d0a7a654f4206568d6034c8782faf0dbbb68af0163ebbc6 -size 1011732 +oid sha256:e89e1db693fac05eb9a05fc06a3462d4a362a96c0ec60cb9c44794e9bcfbea67 +size 1011684 diff --git a/lib/search/indexes/github-docs-ghec-cn.json.br b/lib/search/indexes/github-docs-ghec-cn.json.br index 9e6f439cb251..09a44501226c 100644 --- a/lib/search/indexes/github-docs-ghec-cn.json.br +++ b/lib/search/indexes/github-docs-ghec-cn.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:3b45a6325a88012e000142816f92aa7aaa938624497eae53024d54c3f23958bd -size 2015854 +oid sha256:5a4097d8f16ef831184be2693abe24fbc1194859936b7e3e0b606292f05f5ea9 +size 2019962 diff --git a/lib/search/indexes/github-docs-ghec-en-records.json.br b/lib/search/indexes/github-docs-ghec-en-records.json.br index 757bbac5e2be..fc2c907f5169 100644 --- a/lib/search/indexes/github-docs-ghec-en-records.json.br +++ b/lib/search/indexes/github-docs-ghec-en-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:938c8af66c753545cf7d97ff65475d2d82dcdba75cd59e849c55c404168b71b9 -size 1387069 +oid sha256:d242c49d0edea0144179a76f0b70c4929c421d3bf6d270b33135f2438f7d3621 +size 1394835 diff --git a/lib/search/indexes/github-docs-ghec-en.json.br b/lib/search/indexes/github-docs-ghec-en.json.br index 6d835014d945..84f99a373117 100644 --- a/lib/search/indexes/github-docs-ghec-en.json.br +++ b/lib/search/indexes/github-docs-ghec-en.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:97a4b684641fc2cb45099aa1e9567e09247ef07002bda63534670e14bf0b910e -size 5629140 +oid sha256:05c333bdc5d02b5c6e383106824de6abdb16495b97af6c54b680cb589386ed14 +size 5668127 diff --git a/lib/search/indexes/github-docs-ghec-es-records.json.br b/lib/search/indexes/github-docs-ghec-es-records.json.br index 9452875249f3..eaf55f1370af 100644 --- a/lib/search/indexes/github-docs-ghec-es-records.json.br +++ b/lib/search/indexes/github-docs-ghec-es-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:51ed5eefa9a4d3805677ec98e493de694a7f51f8524908cdad7d77674924deed -size 935941 +oid sha256:cdba0da97a672f9a35252014beb5b3bc9ed5cd920e68beec6facd0898aa966df +size 939778 diff --git a/lib/search/indexes/github-docs-ghec-es.json.br b/lib/search/indexes/github-docs-ghec-es.json.br index 91d75cca83e4..2802e1d29abf 100644 --- a/lib/search/indexes/github-docs-ghec-es.json.br +++ b/lib/search/indexes/github-docs-ghec-es.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:8a49bd370b7b48253c13503011b2c2741f84696067c5388bc55502a6b6ba1007 -size 4035644 +oid sha256:1415221af288a5523359ac5deb998608e387fcdb18d75fd409b4142e2087f4e1 +size 4058129 diff --git a/lib/search/indexes/github-docs-ghec-ja-records.json.br b/lib/search/indexes/github-docs-ghec-ja-records.json.br index 29cd0ae1121e..78f6497be738 100644 --- a/lib/search/indexes/github-docs-ghec-ja-records.json.br +++ b/lib/search/indexes/github-docs-ghec-ja-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:28e025c8270b872db9384b357298ede023e5069a18080671d51cf815e30445e5 -size 1025590 +oid sha256:70ef4d71b1a5502aa75e741eb04a0740496a9b46b43a799da86005cf691c314d +size 1026318 diff --git a/lib/search/indexes/github-docs-ghec-ja.json.br b/lib/search/indexes/github-docs-ghec-ja.json.br index 5ca67fb14e9d..72e693f08006 100644 --- a/lib/search/indexes/github-docs-ghec-ja.json.br +++ b/lib/search/indexes/github-docs-ghec-ja.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:9fc8588e6326e3378991c719001e779c65db42ceeac148ca016ae81745662d42 -size 5726544 +oid sha256:6e0986e63daeeba1e4b6b5dc5b356925016fd1d5f2cceeb685c23154d3259706 +size 5734408 diff --git a/lib/search/indexes/github-docs-ghec-pt-records.json.br b/lib/search/indexes/github-docs-ghec-pt-records.json.br index baf0f3037e61..b5b1389e395d 100644 --- a/lib/search/indexes/github-docs-ghec-pt-records.json.br +++ b/lib/search/indexes/github-docs-ghec-pt-records.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a18724e947da4304ec7a1539a4208e6e9589833df2558155691a83c66214e85f -size 923930 +oid sha256:671c0352fc06485419d453669080d3d6e3923d9ddff787c663af4a2a8a98062d +size 923656 diff --git a/lib/search/indexes/github-docs-ghec-pt.json.br b/lib/search/indexes/github-docs-ghec-pt.json.br index 25740f141054..00360edf46f2 100644 --- a/lib/search/indexes/github-docs-ghec-pt.json.br +++ b/lib/search/indexes/github-docs-ghec-pt.json.br @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a1c30340184d7f1ebb216c8de53f18cbd3226a4c74ba47142fffba3354abc82c -size 3926915 +oid sha256:a32aa9598bf08548e250857d797b12ffbcb77b25a1f623d90e2c95ede56f66e9 +size 3922182 diff --git a/middleware/contextualizers/breadcrumbs.js b/middleware/contextualizers/breadcrumbs.js index a707cd0a9b1c..ef4195c4c985 100644 --- a/middleware/contextualizers/breadcrumbs.js +++ b/middleware/contextualizers/breadcrumbs.js @@ -17,6 +17,8 @@ export default async function breadcrumbs(req, res, next) { return next() } +const earlyAccessExceptions = ['insights', 'enterprise-importer'] + async function getBreadcrumbs(req, isEarlyAccess = false) { const crumbs = [] const { currentPath, currentVersion } = req.context @@ -30,11 +32,11 @@ async function getBreadcrumbs(req, isEarlyAccess = false) { // top-level like "/github" cutoff++ - // The only exception to this rule is for the - // /{version}/early-access/insights/... URLs because they're a + // There are a few exceptions to this rule for the + // /{version}/early-access//... URLs because they're a // bit different. - // If there are more known exceptions, extend this conditional. - if (!split.includes('insights')) { + // If there are more known exceptions, add them to the array above. + if (!earlyAccessExceptions.some((product) => split.includes(product))) { cutoff++ } diff --git a/middleware/next.js b/middleware/next.js index ab9de7ae09ab..8ad6b3eb223f 100644 --- a/middleware/next.js +++ b/middleware/next.js @@ -1,16 +1,9 @@ import next from 'next' -// This import is necessary, as of Jan 2022 to avoid a segmentation fault. -// Next is suppose to automatically pick up the `next.config.js` file -// but if you don't specify it to the `next()` constructor you currently -// get a seg fault. -// Possibly relevant: https://github.com/vercel/next.js/issues/33008 -import conf from '../next.config.js' - const { NODE_ENV } = process.env const isDevelopment = NODE_ENV === 'development' -export const nextApp = next({ dev: isDevelopment, conf }) +export const nextApp = next({ dev: isDevelopment }) export const nextHandleRequest = nextApp.getRequestHandler() await nextApp.prepare() diff --git a/package-lock.json b/package-lock.json index 3a7fef6278f4..dcf70ceb614c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -136,7 +136,7 @@ "japanese-characters": "^1.1.0", "jest": "29.0.0", "jest-environment-puppeteer": "^5.0.4", - "jest-fail-on-console": "^2.4.2", + "jest-fail-on-console": "^3.0.1", "jest-github-actions-reporter": "^1.0.3", "jest-slow-test-reporter": "^1.0.0", "kill-port": "2.0.0", @@ -12091,9 +12091,9 @@ } }, "node_modules/jest-fail-on-console": { - "version": "2.4.2", - "resolved": "https://registry.npmjs.org/jest-fail-on-console/-/jest-fail-on-console-2.4.2.tgz", - "integrity": "sha512-CdulWZvfI+cz4+dXQr6p0BhhexFjLnIIBR/7YcpzPXFxrNozAruWkEjR1RU89cd7WXYwckX5ygvHuHQa3NjbOQ==", + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/jest-fail-on-console/-/jest-fail-on-console-3.0.1.tgz", + "integrity": "sha512-1811WQIY9lZN9wGkp7S6y69vw9+u6I21dmnRwXo6jSuF6Xv5OlN4msNCeKEVlc/C2H5N8dqLKuQlTAzQZ0mJlw==", "dev": true, "dependencies": { "chalk": "^4.1.0" @@ -29239,9 +29239,9 @@ } }, "jest-fail-on-console": { - "version": "2.4.2", - "resolved": "https://registry.npmjs.org/jest-fail-on-console/-/jest-fail-on-console-2.4.2.tgz", - "integrity": "sha512-CdulWZvfI+cz4+dXQr6p0BhhexFjLnIIBR/7YcpzPXFxrNozAruWkEjR1RU89cd7WXYwckX5ygvHuHQa3NjbOQ==", + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/jest-fail-on-console/-/jest-fail-on-console-3.0.1.tgz", + "integrity": "sha512-1811WQIY9lZN9wGkp7S6y69vw9+u6I21dmnRwXo6jSuF6Xv5OlN4msNCeKEVlc/C2H5N8dqLKuQlTAzQZ0mJlw==", "dev": true, "requires": { "chalk": "^4.1.0" diff --git a/package.json b/package.json index 5bdd205e62f7..5eb76756a9af 100644 --- a/package.json +++ b/package.json @@ -138,7 +138,7 @@ "japanese-characters": "^1.1.0", "jest": "29.0.0", "jest-environment-puppeteer": "^5.0.4", - "jest-fail-on-console": "^2.4.2", + "jest-fail-on-console": "^3.0.1", "jest-github-actions-reporter": "^1.0.3", "jest-slow-test-reporter": "^1.0.0", "kill-port": "2.0.0", diff --git a/script/rendered-content-link-checker.js b/script/rendered-content-link-checker.js index e3ece57f0637..5bf9127978c1 100755 --- a/script/rendered-content-link-checker.js +++ b/script/rendered-content-link-checker.js @@ -12,6 +12,7 @@ import path from 'path' import cheerio from 'cheerio' import { program, Option, InvalidArgumentError } from 'commander' import chalk from 'chalk' +import got, { RequestError } from 'got' import shortVersions from '../middleware/contextualizers/short-versions.js' import contextualize from '../middleware/context.js' @@ -20,6 +21,7 @@ import getRedirect from '../lib/get-redirect.js' import warmServer from '../lib/warm-server.js' import renderContent from '../lib/render-content/index.js' import { deprecated } from '../lib/enterprise-server-releases.js' +import excludedLinks from '../lib/excluded-links.js' const STATIC_PREFIXES = { assets: path.resolve('assets'), @@ -32,6 +34,18 @@ Object.entries(STATIC_PREFIXES).forEach(([key, value]) => { } }) +// Return a function that can as quickly as possible check if a certain +// href input should be skipped. +// Do this so we can use a `Set` and a `iterable.some()` for a speedier +// check. +function linksToSkipFactory() { + const set = new Set(excludedLinks.filter((regexOrURL) => typeof regexOrURL === 'string')) + const regexes = excludedLinks.filter((regexOrURL) => regexOrURL instanceof RegExp) + return (href) => set.has(href) || regexes.some((regex) => regex.test(href)) +} + +const linksToSkip = linksToSkipFactory(excludedLinks) + const CONTENT_ROOT = path.resolve('content') const deprecatedVersionPrefixesRegex = new RegExp( @@ -56,9 +70,13 @@ program .option('-b, --bail', 'Exit on the first flaw') .option('--check-anchors', "Validate links that start with a '#' too") .option('--check-images', 'Validate local images too') + .option('--check-external-links', 'Check external URLs too') .option('-v, --verbose', 'Verbose outputs') .option('--debug', "Loud about everything it's doing") .option('--random', 'Load pages in a random order (useful for debugging)') + .option('--patient', 'Give external link checking longer timeouts and more retries') + .option('-o, --out ', 'Put warnings and errors into a file instead of stdout') + .option('--json-output', 'Print JSON to stdout or file instead') .option('--max ', 'integer argument (default: none)', (value) => { const parsed = parseInt(value, 10) if (isNaN(parsed)) { @@ -92,7 +110,19 @@ program main(program.opts(), program.args) async function main(opts, files) { - const { random, language, filter, exit, debug, max, verbose, list } = opts + const { + random, + language, + filter, + exit, + debug, + max, + verbose, + list, + checkExternalLinks, + jsonOutput, + out, + } = opts // Note! The reason we're using `warmServer()` in this script, // even though there's no server involved, is because @@ -133,12 +163,23 @@ async function main(opts, files) { const pages = getPages(pageList, languages, filters, files, max) debug && console.timeEnd('getPages') + if (checkExternalLinks && pages.length >= 100) { + console.warn( + chalk.yellow( + `Warning! Checking external URLs can be time costly. You're testing ${pages.length} pages.` + ) + ) + } + const processPagesStart = new Date() const flawsGroups = await Promise.all( pages.map((page) => processPage(page, pageMap, redirects, opts)) ) const processPagesEnd = new Date() const flaws = flawsGroups.flat() + if (jsonOutput) { + jsonPrintFlaws(flaws, opts) + } debug && printGlobalCacheHitRatio() @@ -149,6 +190,9 @@ async function main(opts, files) { console.log(`Took ${getDurationString(processPagesStart, processPagesEnd)}`) summarizeFlaws(flaws) + if (out && flaws.length > 0) { + console.log(`All flaws written to ${chalk.bold(out)}`) + } } if (exit) { @@ -221,7 +265,7 @@ function getPages(pageList, languages, filters, files, max) { } async function processPage(page, pageMap, redirects, opts) { - const { bail, verboseUrl } = opts + const { bail, verboseUrl, jsonOutput, out } = opts const allFlawsEach = await Promise.all( page.permalinks.map((permalink) => processPermalink(permalink, page, pageMap, redirects, opts)) @@ -230,48 +274,75 @@ async function processPage(page, pageMap, redirects, opts) { const allFlaws = allFlawsEach.flat() if (bail && allFlaws.length > 0) { - printFlaws(allFlaws, verboseUrl) + if (jsonOutput) { + jsonPrintFlaws(allFlaws, opts) + } else { + printFlaws(allFlaws, { verboseUrl, out }) + } process.exit(1) } - printFlaws(allFlaws, verboseUrl) + if (!jsonOutput) { + printFlaws(allFlaws, { verboseUrl, out }) + } return allFlaws } async function processPermalink(permalink, page, pageMap, redirects, opts) { - const { level, checkAnchors, checkImages } = opts + const { level, checkAnchors, checkImages, checkExternalLinks, verbose, patient } = opts const html = await renderInnerHTML(page, permalink) const $ = cheerio.load(html) const flaws = [] + const links = [] $('a[href]').each((i, link) => { - const { href } = link.attribs - - // The global cache can't be used for anchor links because they - // depend on each page it renders - if (!href.startsWith('#')) { - if (globalHrefCheckCache.has(href)) { - globalCacheHitCount++ - return globalHrefCheckCache.get(href) + links.push(link) + }) + const newFlaws = await Promise.all( + links.map(async (link) => { + const { href } = link.attribs + + // The global cache can't be used for anchor links because they + // depend on each page it renders + if (!href.startsWith('#')) { + if (globalHrefCheckCache.has(href)) { + globalCacheHitCount++ + return globalHrefCheckCache.get(href) + } + globalCacheMissCount++ } - globalCacheMissCount++ - } - - const flaw = checkHrefLink(href, $, redirects, pageMap, checkAnchors) - // Again if it's *not* an anchor link, we can use the cache. - if (!href.startsWith('#')) { - globalHrefCheckCache.set(href, flaw) - } + const flaw = await checkHrefLink( + href, + $, + redirects, + pageMap, + checkAnchors, + checkExternalLinks, + { verbose, patient } + ) - if (flaw) { - if (level === 'critical' && !flaw.CRITICAL) { - return + if (flaw) { + if (level === 'critical' && !flaw.CRITICAL) { + return + } + const text = $(link).text() + if (!href.startsWith('#')) { + globalHrefCheckCache.set(href, { href, flaw, text }) + } + return { href, flaw, text } + } else { + if (!href.startsWith('#')) { + globalHrefCheckCache.set(href, flaw) + } } - const text = $(link).text() - flaws.push({ permalink, page, href, flaw, text }) + }) + ) + for (const flaw of newFlaws) { + if (flaw) { + flaws.push(Object.assign(flaw, { page, permalink })) } - }) + } if (checkImages) { $('img[src]').each((i, img) => { @@ -304,36 +375,92 @@ async function processPermalink(permalink, page, pageMap, redirects, opts) { return flaws } -function printFlaws(flaws, verboseUrl = null) { +function jsonPrintFlaws(flaws, { verboseUrl = null, out = null } = {}) { + const printableFlaws = {} + for (const { page, permalink, href, text, src, flaw } of flaws) { + const fullPath = prettyFullPath(page.fullPath) + + if (!(fullPath in printableFlaws)) { + printableFlaws[fullPath] = [] + } + if (href) { + printableFlaws[fullPath].push({ + href, + url: verboseUrl ? new URL(permalink.href, verboseUrl).toString() : permalink.href, + text, + flaw, + }) + } else if (src) { + printableFlaws[fullPath].push({ + src, + }) + } + } + const message = JSON.stringify(printableFlaws, undefined, 2) + if (out) { + fs.writeFileSync(out, message + '\n', 'utf-8') + } else { + console.log(message) + } +} + +function printFlaws(flaws, { verboseUrl = null, out = null } = {}) { let previousPage = null let previousPermalink = null + + function fout(msg) { + if (out) { + fs.appendFileSync(out, `${msg}\n`, 'utf-8') + } else { + console.log(msg) + } + } + for (const { page, permalink, href, text, src, flaw } of flaws) { + const fullPath = prettyFullPath(page.fullPath) if (page !== previousPage) { - console.log(`PAGE: ${chalk.bold(prettyFullPath(page.fullPath))}`) + if (out) { + fout(`PAGE: ${fullPath}`) + } else { + console.log(`PAGE: ${chalk.bold(fullPath)}`) + } } previousPage = page if (href) { if (previousPermalink !== permalink.href) { if (verboseUrl) { - console.log(` URL: ${new URL(permalink.href, verboseUrl).toString()}`) + fout(` URL: ${new URL(permalink.href, verboseUrl).toString()}`) } else { - console.log(` PERMALINK: ${permalink.href}`) + fout(` PERMALINK: ${permalink.href}`) } } previousPermalink = permalink.href - console.log(` HREF: ${chalk.bold(href)}`) - console.log(` TEXT: ${text}`) + if (out) { + fout(` HREF: ${href}`) + } else { + console.log(` HREF: ${chalk.bold(href)}`) + } + fout(` TEXT: ${text}`) } else if (src) { - console.log(` IMG SRC: ${chalk.bold(src)}`) + if (out) { + fout(` IMG SRC: ${src}`) + } else { + console.log(` IMG SRC: ${chalk.bold(src)}`) + } } else { throw new Error("Flaw has neither 'href' nor 'src'") } - console.log( - ` FLAW: ${flaw.CRITICAL ? chalk.red(flaw.CRITICAL) : chalk.yellow(flaw.WARNING)}` - ) - console.log('') + + if (out) { + fout(` FLAW: ${flaw.CRITICAL ? flaw.CRITICAL : flaw.WARNING}`) + } else { + console.log( + ` FLAW: ${flaw.CRITICAL ? chalk.red(flaw.CRITICAL) : chalk.yellow(flaw.WARNING)}` + ) + } + fout('') } } @@ -353,7 +480,15 @@ const globalImageSrcCheckCache = new Map() let globalCacheHitCount = 0 let globalCacheMissCount = 0 -function checkHrefLink(href, $, redirects, pageMap, checkAnchors = false) { +async function checkHrefLink( + href, + $, + redirects, + pageMap, + checkAnchors = false, + checkExternalLinks = false, + { verbose = false, patient = false } = {} +) { if (href === '#') { if (checkAnchors) { return { WARNING: 'Link is just an empty `#`' } @@ -399,7 +534,141 @@ function checkHrefLink(href, $, redirects, pageMap, checkAnchors = false) { return { CRITICAL: 'Broken link' } } } + } else if (checkExternalLinks) { + if (!href.startsWith('https://')) { + return { WARNING: `Will not check external URLs that are not HTTPS (${href})` } + } + if (linksToSkip(href)) { + return + } + const { ok, ...info } = await checkExternalURL(href, { verbose, patient }) + if (!ok) { + return { CRITICAL: `Broken external link (${JSON.stringify(info)})` } + } + } +} + +const _fetchCache = new Map() +async function checkExternalURL(url, { verbose = false, patient = false } = {}) { + if (!url.startsWith('https://')) throw new Error('Invalid URL') + const cleanURL = url.split('#')[0] + if (!_fetchCache.has(cleanURL)) { + _fetchCache.set(cleanURL, innerFetch(cleanURL, { verbose, patient })) + } + return _fetchCache.get(cleanURL) +} + +const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms)) + +// Global for recording which domains we get rate-limited on. +// For example, if you got rate limited on `something.github.com/foo` +// and now we're asked to fetch for `something.github.com/bar` +// it's good to know to now bother yet. +const _rateLimitedDomains = new Map() + +async function innerFetch(url, config = {}) { + const { verbose, useGET, patient } = config + + const { hostname } = new URL(url) + if (_rateLimitedDomains.has(hostname)) { + await sleep(_rateLimitedDomains.get(hostname)) + } + // The way `got` does retries: + // + // sleep = 1000 * Math.pow(2, retry - 1) + Math.random() * 100 + // + // So, it means: + // + // 1. ~1000ms + // 2. ~2000ms + // 3. ~4000ms + // + // ...if the limit we set is 3. + // Our own timeout, in ./middleware/timeout.js defaults to 10 seconds. + // So there's no point in trying more attempts than 3 because it would + // just timeout on the 10s. (i.e. 1000 + 2000 + 4000 + 8000 > 10,000) + const retry = { + limit: patient ? 5 : 2, + } + const timeout = { request: patient ? 10000 : 2000 } + + const headers = { + 'User-Agent': + 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.117 Safari/537.36', + } + + const retries = config.retries || 0 + const httpFunction = useGET ? got.get : got.head + + if (verbose) console.log(`External URL ${useGET ? 'GET' : 'HEAD'}: ${url} (retries: ${retries})`) + try { + const r = await httpFunction(url, { + headers, + throwHttpErrors: false, + retry, + timeout, + }) + if (verbose) { + console.log( + `External URL ${useGET ? 'GET' : 'HEAD'} ${url}: ${r.statusCode} (retries: ${retries})` + ) + } + + // If we get rate limited, remember that this hostname is now all + // rate limited. And sleep for the number of seconds that the + // `retry-after` header indicated. + if (r.statusCode === 429) { + let sleepTime = Math.min( + 60_000, + Math.max(10_000, getRetryAfterSleep(r.headers['retry-after'])) + ) + // Sprinkle a little jitter so it doesn't all start again all + // at the same time + sleepTime += Math.random() * 10 * 1000 + // Give it a bit extra when we can be really patient + if (patient) sleepTime += 30 * 1000 + + _rateLimitedDomains.set(hostname, sleepTime + Math.random() * 10 * 1000) + if (verbose) + console.log( + chalk.yellow( + `Rate limited on ${hostname} (${url}). Sleeping for ${(sleepTime / 1000).toFixed(1)}s` + ) + ) + await sleep(sleepTime) + return innerFetch(url, Object.assign({}, config, { retries: retries + 1 })) + } else { + _rateLimitedDomains.delete(hostname) + } + + // Perhaps the server doesn't suppport HEAD requests. + // If so, try again with a regular GET. + if ((r.statusCode === 405 || r.statusCode === 404) && !useGET) { + return innerFetch(url, Object.assign({}, config, { useGET: true })) + } + if (verbose) { + console.log((r.ok ? chalk.green : chalk.red)(`${r.statusCode} on ${url}`)) + } + return { ok: r.ok, statusCode: r.statusCode } + } catch (err) { + if (err instanceof RequestError) { + if (verbose) { + console.log(chalk.yellow(`RequestError (${err.message}) on ${url}`)) + } + return { ok: false, requestError: err.message } + } + throw err + } +} + +// Return number of milliseconds from a `Retry-After` header value +function getRetryAfterSleep(headerValue) { + if (!headerValue) return 0 + let ms = Math.round(parseFloat(headerValue) * 1000) + if (isNaN(ms)) { + ms = Math.max(0, new Date(headerValue) - new Date()) } + return ms } function checkImageSrc(src, $) { diff --git a/tests/meta/repository-references.js b/tests/meta/repository-references.js index 261ce2811996..d9526f9841b3 100644 --- a/tests/meta/repository-references.js +++ b/tests/meta/repository-references.js @@ -66,6 +66,7 @@ const PUBLIC_REPOS = new Set([ 'super-linter', 'tweetsodium', 'VisualStudio', + 'codespaces-getting-started-ml', ]) const ALLOW_DOCS_PATHS = [ diff --git a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private.md b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private.md index 6d236d1cd178..d6b35dde09ee 100644 --- a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private.md +++ b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private.md @@ -1,63 +1,63 @@ --- -title: Setting your profile to private -intro: 'A private profile displays only limited information, and hides some activity.' +title: Configurar tu perfil como privado +intro: Un perfil privado muestra información limitada únicamente y oculta algo de actividad. versions: fpt: '*' topics: - Profiles -shortTitle: Set profile to private +shortTitle: Configurar el perfil como privado --- -## About private profiles +## Acerca de los perfiles privados {% note %} -**Note:** Private profiles are currently in beta and are subject to change. +**Nota:** Los perfiles privados se encuentran actualmente en beta y están sujetos a cambios. {% endnote %} -To hide parts of your profile page, you can make your profile private. This also hides your activity in various social features on {% data variables.product.prodname_dotcom_the_website %}. A private profile hides information from all users, and there is currently no option to allow specified users to see your activity. +Para ocultar partes de tu página de perfil, puedes hacer a tu perfil privado. Esto también oculta tu actividad en varias características sociales de {% data variables.product.prodname_dotcom_the_website %}. Un perfil privado oculta información para todos los usuarios y actualmente no hay una opción para permitir que usuarios específicos vea tu actividad. -After making your profile private, you can still view all your information when you visit your own profile. +Después de hacer a tu perfil privado, aún puedes ver toda tu información cuando visitas tu propio perfil. -Private profiles cannot receive sponsorships under [{% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors). To be eligible for {% data variables.product.prodname_sponsors %}, your profile cannot be private. +Los perfiles privados no pueden recibir patrocinios bajo [{% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors). Para que pueda ser elegible para {% data variables.product.prodname_sponsors %}, tu perfil no puede ser privado. -## Differences between private and public profiles +## Diferencias entre los perfiles públicos y privados -When your profile is private, the following content is hidden from your profile page: +Cuando tu perfil es privado, el siguiente contenido se oculta de tu página de perfil: -- Achievements and highlights. -- Activity overview and activity feed. -- Contribution graph. -- Follower and following counts. -- Follow and Sponsor buttons. -- Organization memberships. -- Stars, projects, packages, and sponsoring tabs. +- Los logros y puntos destacados. +- El resumen de la actividad y la fuente de actividad. +- La gráfica de contribuciones. +- Los conteos de seguidores y seguidos. +- Los botones de seguir y de patrocinar. +- Las membrecías de organización. +- Las pestañas de favoritos, proyectos, paquetes y patrocinando. {% note %} -**Note**: When your profile is private, some optional fields are still publicly visible, such as the README, biography, and profile photo. +**Nota**: Cuando tu perfil es privado, algunos de los campos opcionales aún se encuentran visibles para el público tal como el README, la biografía y la foto de perfil. {% endnote %} -## Changes to reporting on your activities +## Cambios a reportar en tus actividades -By making your profile private, you will not remove or hide past activity; this setting only applies to your activity while the private setting is enabled. +Al hacer tu perfil privado, no eliminarás ni ocultarás la actividad anterior; este ajuste solo aplica a tu actividad mientras el ajuste privado esté habilitado. -When your profile is private, your {% data variables.product.prodname_dotcom_the_website %} activity will not appear in the following locations: +Cuando tu perfil es privado, tu actividad de {% data variables.product.prodname_dotcom_the_website %} no se mostrará en las siguientes ubicaciones: -- Activity feeds for other users. -- Discussions leaderboards. -- The [Trending](https://github.com/trending) page. +- Fuentes de actividad para otros usuarios. +- Tablas de clasificación de debates. +- La página de [Tendencias](https://github.com/trending). {% note %} -**Note**: Your activity on public repositories will still be publicly visible to anyone viewing those repositories, and some activity data may still be available through the {% data variables.product.prodname_dotcom %} API. +**Nota**: Cualquiera que vea estos repositorios tendrá visibilidad del público en general para tu actividad en los repositorios públicos y algunos datos de la actividad aún estarán disponibles mediante la API de {% data variables.product.prodname_dotcom %}. {% endnote %} -## Changing your profile's privacy settings +## Cambiar los ajustes de privacidad de tu perfil {% data reusables.user-settings.access_settings %} -1. Under "Contributions & Activity", select the checkbox next to **Make profile private and hide activity**. +1. Dababjo de "Contribuciones & actividad", selecciona la casilla de verificación junto a **Hacer perfil privado y ocultar actividad**. {% data reusables.user-settings.update-preferences %} diff --git a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md index 21dc884ac79f..91c180cbd817 100644 --- a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md +++ b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md @@ -25,6 +25,7 @@ children: - /managing-the-default-branch-name-for-your-repositories - /managing-security-and-analysis-settings-for-your-personal-account - /managing-access-to-your-personal-accounts-project-boards + - /managing-your-cookie-preferences-for-githubs-enterprise-marketing-pages - /integrating-jira-with-your-personal-projects - /what-does-the-available-for-hire-checkbox-do shortTitle: Ajustes de cuenta personal diff --git a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-cookie-preferences-for-githubs-enterprise-marketing-pages.md b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-cookie-preferences-for-githubs-enterprise-marketing-pages.md new file mode 100644 index 000000000000..41ff7da20123 --- /dev/null +++ b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-cookie-preferences-for-githubs-enterprise-marketing-pages.md @@ -0,0 +1,33 @@ +--- +title: Managing your cookie preferences for GitHub's enterprise marketing pages +intro: 'You can control how {% data variables.product.company_short %} uses information from non-essential tracking cookies for enterprise marketing pages.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - Accounts +shortTitle: Manage cookie preferences +--- + +## About cookie preferences on enterprise marketing pages + +{% data variables.product.company_short %} may use non-essential cookies on some enterprise marketing pages. You can customize how these cookies behave. For more information about how {% data variables.product.company_short %} uses cookies, see "[{% data variables.product.company_short %} Privacy Statement](/free-pro-team@latest/site-policy/privacy-policies/github-privacy-statement)." + +## Changing your cookie preferences + +You can customize how non-essential cookies behave on any {% data variables.product.company_short %} enterprise marketing page. + +1. Navigate to the {% data variables.product.company_short %} enterprise marketing page where you'd like to change your cookie preferences. For example, navigate to [{% data variables.product.company_short %} Resources](https://resources.github.com/). +1. Scroll to the bottom of the page, then click **Manage Cookies**. + + ![Screenshot of button to manage cookie settings.](/assets/images/help/settings/cookie-settings-manage.png) + +1. Under "Manage cookie preferences," to accept or reject each non-essential cookie, click **Accept** or **Reject**. + + ![Screenshot of radio buttons to choose "Accept" or "Reject" for non-essential cookies.](/assets/images/help/settings/cookie-settings-accept-or-reject.png) + +1. Haz clic en **Guardar cambios**. + + ![Screenshot of button to save changes.](/assets/images/help/settings/cookie-settings-save.png) diff --git a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md index 1efa11fa2e55..9af9d7d083b2 100644 --- a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md +++ b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md @@ -14,7 +14,7 @@ shortTitle: Manage multiple accounts In some cases, you may need to use multiple accounts on {% data variables.product.product_location %}. For example, you may have a personal account for open source contributions, and your employer may also create and manage a user account for you within an enterprise. -You cannot use your {% data variables.product.prodname_managed_user %} to contribute to public projects on {% data variables.product.product_location %}, so you must contribute to those resources using your personal account. For more information, see "[About {% data variables.product.prodname_emus %}]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#abilities-and-restrictions-of-managed-user-accounts){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% elsif ghec %}."{% endif %} +You cannot use your {% data variables.product.prodname_managed_user %} to contribute to public projects on {% data variables.product.product_location %}, so you must contribute to those resources using your personal account. Para obtener más información, consulta la sección "[Acerca de {% data variables.product.prodname_emus %}]({% ifversion fpt %}/enterprise-cloud@latest{% endif %}/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#abilities-and-restrictions-of-managed-user-accounts){% ifversion fpt %}" en la documentación de {% data variables.product.prodname_ghe_cloud %}.{% elsif ghec %}".{% endif %} If you want to use one workstation to contribute from both accounts, you can simplify contribution with Git by using a mixture of protocols to access repository data, or by using credentials on a per-repository basis. @@ -98,7 +98,7 @@ To use a different SSH key for different repositories that you clone to your wor 2. Choose the correct SSH key for authentication. 3. Modify `GIT_SSH_COMMAND` accordingly. For more information about `GIT_SSH_COMMAND`, see [Environment Variables](https://git-scm.com/docs/git#Documentation/git.txt-codeGITSSHCOMMANDcode) in the Git documentation. -For example, the following command sets the `GIT_SSH_COMMAND` environment variable to specify an SSH command that uses the private key file at **_PATH/TO/KEY/FILE_** for authentication to clone the repository named **_OWNER_**/**_REPOSITORY_** on {% data variables.product.product_location %}. +Por ejemplo, el siguiente comando configura la variable de ambiente `GIT_SSH_COMMAND` para que especifique un comando SSH que utiliza el archivo de llave privada en **_PATH/TO/KEY/FILE_** para autenticación para clonar el repositorio que se llama **_OWNER_**/**_REPOSITORY_** en {% data variables.product.product_location %}.
 GIT_SSH_COMMAND='ssh -i PATH/TO/KEY/FILE -o IdentitiesOnly=yes' git clone git@github.com:OWNER/REPOSITORY
diff --git a/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md b/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md
index 8103a977e8cf..f3eecc885847 100644
--- a/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md
+++ b/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md
@@ -145,11 +145,11 @@ With OIDC, a {% data variables.product.prodname_actions %} workflow requires a t
 
 Audience and Subject claims are typically used in combination while setting conditions on the cloud role/resources to scope its access to the GitHub workflows.
 - **Audience**: By default, this value uses the URL of the organization or repository owner. This can be used to set a condition that only the workflows in the specific organization can access the cloud role.
-- **Subject**: Has a predefined format and is a concatenation of some of the key metadata about the workflow, such as the {% data variables.product.prodname_dotcom %} organization, repository, branch, or associated [`job`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idenvironment) environment. See "[Example subject claims](#example-subject-claims)" to see how the subject claim is assembled from concatenated metadata.
+- **Subject**: By default, has a predefined format and is a concatenation of some of the key metadata about the workflow, such as the {% data variables.product.prodname_dotcom %} organization, repository, branch, or associated [`job`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idenvironment) environment. See "[Example subject claims](#example-subject-claims)" to see how the subject claim is assembled from concatenated metadata.
 
-There are also many additional claims supported in the OIDC token that can also be used for setting these conditions.
+If you need more granular trust conditions, you can customize the issuer (`iss`) and subject (`sub`) claims that are included with the JWT. For more information, see "[Customizing the token claims](#customizing-the-token-claims)".
 
-In addition, your cloud provider could allow you to assign a role to the access tokens, letting you specify even more granular permissions.
+There are also many additional claims supported in the OIDC token that can be used for setting these conditions. In addition, your cloud provider could allow you to assign a role to the access tokens, letting you specify even more granular permissions.
 
 {% note %}
 
@@ -243,9 +243,13 @@ curl -H "Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" "$ACTIONS_ID_TOK
 {% ifversion actions-oidc-hardening-config %}
 ## Customizing the token claims
 
-You can security harden your OIDC configuration by customizing the claims that are included with the JWT. This allows your cloud provider to apply more granular trust conditions when determining whether to grant access to its resources. For example, {% ifversion ghec %}you can customize the issuer (`iss`) claim to only allow access from a specific enterprise URL, and {% endif %}you can customize the subject (`sub`) value to require that requests originate from a specific repository, reusable workflow, or other source.
+You can security harden your OIDC configuration by customizing the claims that are included with the JWT. These customisations allow you to define more granular trust conditions on your cloud roles when allowing your workflows to access resources hosted in the cloud:
 
-To configure the claim conditions on {% data variables.product.prodname_dotcom %}, you can use the REST API endpoints described in the following sections.
+{% ifversion ghec %} - For an additional layer of security, you can append the `issuer` url with your enterprise slug. This lets you set conditions on the issuer (`iss`) claim, configuring it to only accept JWT tokens from a unique `issuer` URL that must include your enterprise slug.{% endif %}
+- You can standardize your OIDC configuration by setting conditions on the subject (`sub`) claim that require JWT tokens to originate from a specific repository, reusable workflow, or other source.
+- You can define granular OIDC policies by using additional OIDC token claims, such as `repository_id` and `repo_visibility`. For more information, see "[Understanding the OIDC token](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#understanding-the-oidc-token)".
+
+To customize these claim formats, organization and repository admins can use the REST API endpoints described in the following sections.
 
 {% ifversion ghec %}
 
@@ -280,19 +284,21 @@ After this setting is applied, the JWT will contain the updated `iss` value. In
 
 To configure organization-wide security, compliance, and standardization, you can customize the standard claims to suit your required access conditions. If your cloud provider supports conditions on subject claims, you can create a condition that checks whether the `sub` value matches the path of the reusable workflow, such as `"job_workflow_ref: "octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main""`. The exact format will vary depending on your cloud provider's OIDC configuration. To configure the matching condition on {% data variables.product.prodname_dotcom %}, you can can use the REST API to require that the `sub` claim must always include a specific custom claim, such as `job_workflow_ref`. For more information, see "[Set the customization template for an OIDC subject claim for an organization](/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization)."
 
+Customizing the claims results in a new format for the entire `sub` claim, which replaces the default predefined `sub` format in the token described in "[Example subject claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims)."
+
 The following example templates demonstrate various ways to customize the subject claim. To configure these settings on {% data variables.product.prodname_dotcom %}, organization admins use the REST API to specify a list of claims that must be included in the subject (`sub`) claim. {% data reusables.actions.use-request-body-api %}
 
-To customize your subject claims, you should first create a matching condition in your cloud provider's OIDC configuration, before adding the configuration using the REST API. Once the configuration is completed, each time a new job runs, the OIDC token generated during that job will follow the new customization template. If the matching condition doesn't exist in the cloud provider's OIDC configuration before the job runs, the generated token might not be accepted by the cloud provider, since the cloud conditions may not be synchronized.
+To customize your subject claims, you should first create a matching condition in your cloud provider's OIDC configuration, before customizing the configuration using the REST API. Once the configuration is completed, each time a new job runs, the OIDC token generated during that job will follow the new customization template. If the matching condition doesn't exist in the cloud provider's OIDC configuration before the job runs, the generated token might not be accepted by the cloud provider, since the cloud conditions may not be synchronized.
 
 {% note %}
 
-**Note**: When the organization template is applied, it will not affect any existing repositories that already use OIDC. For new repositories that are created after the template has been applied, the repository owner will need to opt-in to receive this configuration. For more information, see "[Set the opt-in flag of an OIDC subject claim customization for a repository](/rest/actions/oidc#set-the-opt-in-flag-of-an-oidc-subject-claim-customization-for-a-repository)."
+**Note**: When the organization template is applied, it will not affect any existing repositories that already use OIDC. For existing repositories, as well as any new repositories that are created after the template has been applied, the repository owner will need to opt-in to receive this configuration. For more information, see "[Set the opt-in flag of an OIDC subject claim customization for a repository](/rest/actions/oidc#set-the-opt-in-flag-of-an-oidc-subject-claim-customization-for-a-repository)."
 
 {% endnote %}
 
 #### Example: Allowing repository based on visibility and owner
 
-This example template enables cloud access based on repository visibility and owner, letting you restrict cloud role access to only private repositories within an organization or enterprise. {% data reusables.actions.use-request-body-api %}
+This example template allows the `sub` claim to have a new format, using `repository_owner` and `repository_visibility`:
 
 ```json
 {
@@ -303,11 +309,11 @@ This example template enables cloud access based on repository visibility and ow
 }
 ```
 
-In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include specific values for `repository_owner` and `repository_visibility`. For example: `"repository_owner: "monalisa":repository_visibility:private"`.
+In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include specific values for `repository_owner` and `repository_visibility`. For example: `"repository_owner: "monalisa":repository_visibility:private"`. The approach lets you restrict cloud role access to only private repositories within an organization or enterprise.
 
 #### Example: Allowing access to all repositories with a specific owner
 
-This example template grants access to all repositories with a specified `repository_owner`. {% data reusables.actions.use-request-body-api %}
+This example template enables the `sub` claim to have a new format with only the value of `repository_owner`. {% data reusables.actions.use-request-body-api %}
 
 ```json
 {
@@ -322,7 +328,9 @@ In your cloud provider's OIDC configuration, configure the `sub` condition to re
 
 #### Example: Requiring a reusable workflow
 
-This example template requires a specific reusable workflow in a claim, letting an enterprise enforce consistent deployments across its enterprise, organizations, and repositories. {% data reusables.actions.use-request-body-api %}
+This example template allows the `sub` claim to have a new format that contains the value of the `job_workflow_ref` claim. This enables an enterprise to use [reusable workflows](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims) to enforce consistent deployments across its organizations and repositories.
+
+{% data reusables.actions.use-request-body-api %}
 
 ```json
   {
@@ -336,7 +344,9 @@ In your cloud provider's OIDC configuration, configure the `sub` condition to re
 
 #### Example: Requiring a reusable workflow and other claims
 
-This example template combines the requirement of a specific reusable workflow with additional claims. {% data reusables.actions.use-request-body-api %}
+The following example template combines the requirement of a specific reusable workflow with additional claims. {% data reusables.actions.use-request-body-api %}
+
+This example also demonstrates how to use `"context"` to define your conditions. This is the part that follows the repository in the [default `sub` format](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims). For example, when the job references an environment, the context contains: `environment:`.
 
 ```json
 {
@@ -350,6 +360,9 @@ This example template combines the requirement of a specific reusable workflow w
 
 In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include specific values for `repo`, `context`, and `job_workflow_ref`.
 
+This customization template requires that the `sub` uses the following format: `repo::environment::job_workflow_ref:`. 
+For example: `"sub": "repo:octo-org/octo-repo:environment:prod:job_workflow_ref:octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main"`
+
 #### Example: Granting access to a specific repository
 
 This example template lets you grant cloud access to all the workflows in a specific repository, across all branches/tags and environments. To help improve security, combine this template with the custom issuer URL described in "[Customizing the token URL for an enterprise](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-url-for-an-enterprise)." 
diff --git a/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md b/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md
index 1fb177d06582..25ba9d8db07b 100644
--- a/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md
+++ b/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md
@@ -23,11 +23,18 @@ topics:
 
 Rather than copying and pasting deployment jobs from one workflow to another, you can create a reusable workflow that performs the deployment steps. A reusable workflow can be used by another workflow if it meets one of the access requirements described in "[Reusing workflows](/actions/learn-github-actions/reusing-workflows#access-to-reusable-workflows)."
 
-When combined with OpenID Connect (OIDC), reusable workflows let you enforce consistent deployments across your repository, organization, or enterprise. You can do this by defining trust conditions on cloud roles based on reusable workflows.
+You should be familiar with the concepts described in "[Reusing workflows](/actions/learn-github-actions/reusing-workflows" and "[About security hardening with OpenID Connect](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)."
 
-In order to create trust conditions based on reusable workflows, your cloud provider must support custom claims for `job_workflow_ref`. This allows your cloud provider to identify which repository the job originally came from. If your cloud provider only supports the standard claims (_audience_ and _subject_), it will not be able to determine that the job originated from the reusable workflow repository. Cloud providers that support `job_workflow_ref` include Google Cloud Platform and HashiCorp Vault.
+## Defining the trust conditions
 
-Before proceeding, you should be familiar with the concepts of [reusable workflows](/actions/learn-github-actions/reusing-workflows) and [OpenID Connect](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect).
+When combined with OpenID Connect (OIDC), reusable workflows let you enforce consistent deployments across your repository, organization, or enterprise. You can do this by defining trust conditions on cloud roles based on reusable workflows. The available options will vary depending on your cloud provider:
+
+- **Using `job_workflow_ref`**: 
+  - To create trust conditions based on reusable workflows, your cloud provider must support custom claims for `job_workflow_ref`. This allows your cloud provider to identify which repository the job originally came from. 
+  - For clouds that only support the standard claims (audience (`aud`) and subject (`sub`)), you can use the API to customize the `sub` claim to include `job_workflow_ref`. For more information, see "[Customizing the token claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-claims)". Support for custom claims is currently available for Google Cloud Platform and HashiCorp Vault.
+
+- **Customizing the token claims**: 
+  - You can configure more granular trust conditions by customizing the issuer (`iss`) and subject (`sub`) claims included with the JWT. For more information, see "[Customizing the token claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-claims)".
 
 ## How the token works with reusable workflows
 
diff --git a/translations/es-ES/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md b/translations/es-ES/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md
index 33df75d7fe38..6e7678877030 100644
--- a/translations/es-ES/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md
+++ b/translations/es-ES/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md
@@ -71,7 +71,7 @@ You can add self-hosted runners at the organization level, where they can be use
 {% data reusables.organizations.navigate-to-org %}
 {% data reusables.organizations.org_settings %}
 {% data reusables.organizations.settings-sidebar-actions-runners %}
-1. Click **New runner**.
+{% ifversion actions-hosted-runners %}1. Click **New runner**, then click **New self-hosted runner**.{% else %}1. Click **New runner**.{% endif %}
 {% data reusables.actions.self-hosted-runner-configure %}
 {% elsif ghae or ghes < 3.4 %}
 {% data reusables.organizations.navigate-to-org %}
diff --git a/translations/es-ES/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md b/translations/es-ES/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md
index d1601bbd6d03..b536f5aca830 100644
--- a/translations/es-ES/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md
+++ b/translations/es-ES/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md
@@ -18,15 +18,23 @@ shortTitle: Ejecutar la app del ejecutor al inicio
 
 {% capture service_first_step %}1. Detén la aplicación del ejecutor autoalojado si se está ejecutando actualmente.{% endcapture %}
 {% capture service_non_windows_intro_shell %}En la máquina del ejecutor, abre un shell en el directorio en el que instalaste la aplicación del ejecutor autoalojado. Usa los comandos que se indican a continuación para instalar y administrar el servicio de ejecutor autoalojado.{% endcapture %}
-{% capture service_nonwindows_intro %} Debes agregar un ejecutor a {% data variables.product.product_name %} antes de que puedas configurar la aplicación del ejecutor auto-hospedado como servicio. Para obtener más información, consulta "[Agregar ejecutores autoalojados](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)."{% endcapture %}
-{% capture service_win_name %}actions.runner.*{% endcapture %}
 
+{% capture service_nonwindows_intro %}
+
+{% note %}
+
+**Nota:** Debes agregar un ejecutor a {% data variables.product.product_name %} antes de que puedas configurar la aplicación de ejecutor auto-hospedado como servicio. Para obtener más información, consulta "[Agregar ejecutores autoalojados](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)".
+
+{% endnote %}
+{% endcapture %}
+
+{% capture service_win_name %}actions.runner.*{% endcapture %}
 
 {% linux %}
 
 {{ service_nonwindows_intro }}
 
-Para los sistemas Linux que usan `systemd`, puedes usar el script `svc.sh` distribuido con la aplicación del ejecutor autoalojado para instalar y administrar el uso de la aplicación como un servicio.
+Para los sistemas Linux que utilizan `systemd`, puedes utilizar el script de `svc.sh` que se creó después de agregar el ejecutor con éxito para instala y administrar utilizando la aplicación como servicio.
 
 {{ service_non_windows_intro_shell }}
 
diff --git a/translations/es-ES/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md b/translations/es-ES/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md
index f9996a90b08e..0b19b5e58c98 100644
--- a/translations/es-ES/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md
+++ b/translations/es-ES/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md
@@ -9,215 +9,65 @@ versions:
   ghae: '*'
   ghec: '*'
 type: tutorial
-shortTitle: Administrar el acceso a los ejecutores
+shortTitle: Using runner groups
 ---
 
 {% data reusables.actions.enterprise-beta %}
 {% data reusables.actions.enterprise-github-hosted-runners %}
 
-## Acerca de los grupos de ejecutores auto-hospedados
+## About runner groups
 
-{% ifversion fpt %}
-{% note %}
-
-**Nota:** Todas las organizaciones tienen un solo grupo de ejecutores auto-hospedados predeterminado. Solo las cuentas empresariales y las organizaciones que pretenezcan a estas pueden crear y administrar grupos de ejecutores auto-hospedados adicionales.
-
-{% endnote %}
-
-Los grupos de ejecutores auto-hospedados se utilizan para controlar el acceso a los ejecutores auto-hospedados. Los administradores de las organizaciones pueden configurar políticas de acceso que controlen qué repositorios en una organización tienen acceso al grupo de ejecutores.
-Si utilizas
-
-{% data variables.product.prodname_ghe_cloud %}, puedes crear grupos de ejecutores adicionales; los administradores empresariales pueden configurar políticas de acceso que controlen qué organizaciones dentro de una empresa pueden acceder al grupo de ejecutores y los administradores organizacionales pueden asignar políticas de acceso granulares de repositorio para el grupo de ejecutores empresarial. Para obtener más información, consulta la [documentación de {% data variables.product.prodname_ghe_cloud %}](/enterprise-cloud@latest/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups).
-{% endif %}
+{% data reusables.actions.about-runner-groups %} {% ifversion fpt %}For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups).{% endif %}
 
 {% ifversion ghec or ghes or ghae %}
-Los grupos de ejecutores auto-hospedados se utilizan para controlar el acceso a los ejecutores auto-hospedados a nivel de empresas y organizaciones. Los propietarios de empresas pueden configurar políticas de acceso que controlan qué organizaciones
-{% ifversion restrict-groups-to-workflows %}y flujos de trabajo {% endif %}en una empresa tienen acceso al grupo de ejecutores. Los propietarios de las organizaciones pueden configurar las políticas de acceso que controlan qué repositorios{% ifversion restrict-groups-to-workflows %} y flujos de trabajo{% endif %} en una organización tienen aceso al grupo de ejecutores.
-
-Cuando un propietario de empresa otorga un acceso organizacional a un grupo de ejecutores, los propietarios de organizaciones pueden verlo listado en los ajustes del ejecutor auto-hospedado de la organización. Los propietarios organizacionales pueden entonces asignar políticas de acceso adicionales y granulares para los repositorios{% ifversion restrict-groups-to-workflows %} y flujos de trabajo{% endif %} al grupo ejecutor de la empresa.
-
-Cuando se crean nuevos ejecutores, se asignan automáticamente al grupo predeterminado. Los ejecutores solo pueden estar en un grupo a la vez. Puedes mover los ejecutores del grupo predeterminado a otro grupo. Para obtener más información, consulta la sección "[Mover un ejecutor auto-hospedado a un grupo](#moving-a-self-hosted-runner-to-a-group)".
 
 ## Crear un grupo de ejecutores auto-hospedados para una organización
 
-Todas las organizaciones tienen un solo grupo predeterminado de ejecutores auto-hospedados. Las organizaciones dentro de una cuenta empresarial pueden crear grupos auto-hospedados adicionales. Los administradores de la organización pueden permitir el acceso de los repositorios individuales a un grupo de ejecutores. Para obtener más información sobre cómo crear un grupo de ejecutores auto-hospedados con la API de REST, consulta la sección "[Grupos de ejecutores auto-hospedados](/rest/reference/actions#self-hosted-runner-groups)".
-
-Los ejecutores auto-hospedados se asignan automáticamente al grupo predeterminado cuando se crean y solo pueden ser mimebros de un grupo a la vez. Puedes mover un ejecutor del grupo predeterminado a cualquier grupo que crees.
-
-Cuando creas un grupo, debes elegir la política que define qué reositorios{% ifversion restrict-groups-to-workflows %} y flujos de trabajo{% endif %} tienen acceso al grupo ejecutor.
-
-{% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %}
-{% data reusables.organizations.navigate-to-org %}
-{% data reusables.organizations.org_settings %}
-{% data reusables.organizations.settings-sidebar-actions-runner-groups %}
-1. En la sección de "Grupos de ejecutores", haz clic en **Grupo de ejecutores nuevo**.
-1. Ingresa un nombre para tu grupo ejecutor.
- {% data reusables.actions.runner-group-assign-policy-repo %}
-
-   {% warning %}
-
-   **Advertencia**: {% indented_data_reference reusables.actions.self-hosted-runner-security spaces=3 %}
+{%- ifversion ghec or ghes %}
 
-   Para obtener más información, consulta "[Acerca de los ejecutores autoalojados](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)."
+{% data reusables.actions.self-hosted-runner-security-admonition %}
 
-   {% endwarning %}
-{% data reusables.actions.runner-group-assign-policy-workflow %}{%- ifversion restrict-groups-to-workflows %}Los grupos ejecutores que pertenecen a las organizaciones no pueden acceder a los flujos de trabajo de una organización diferente en la empresa. En vez de esto, debes crear un grupo de ejecutores que pertenezca a la empresa.{% endif %}
-{% data reusables.actions.self-hosted-runner-create-group %}
-{% elsif ghae or ghes < 3.4 %}
-{% data reusables.organizations.navigate-to-org %}
-{% data reusables.organizations.org_settings %}
-{% data reusables.organizations.settings-sidebar-actions-runner-groups %}
-1. Debajo de {% ifversion ghes or ghae %}"Ejecutores"{% endif %}, haz clic en **Agregar nuevo** y luego en **Grupo nuevo**.
+{%- endif %}
 
-    ![Agregar un grupo de ejecutores](/assets/images/help/settings/actions-org-add-runner-group.png)
-1. Ingresa un nombre para tu grupo de ejecutores y asigna una política para el acceso al repositorio.
-
-   Puedes configurar un grupo de ejecutores para que sea accesible a una lista específica de repositorios o a todos ellos en la organización.{% ifversion ghec or ghes %} Predeterminadamente, solo los repositorios privados pueden acceder a los ejecutores en un grupo ejecutor. Pero esto se puede anular. Esta configuración no puede anularse si se configura un grupo ejecutor de la organización que haya compartido una empresa.{% endif %}
-
-   {%- ifversion ghes %}
-   {% warning %}
-
-   **Advertencia**:
-
-   {% indented_data_reference reusables.actions.self-hosted-runner-security spaces=3 %}
-
-   Para obtener más información, consulta "[Acerca de los ejecutores autoalojados](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)."
-
-   {% endwarning %}
-   {%- endif %}
-
-   ![Agregar opciones de un grupo de ejecutores](/assets/images/help/settings/actions-org-add-runner-group-options.png)
-1. Da clic en **Guardar grupo** para crear el grupo y aplicar la política.
-{% endif %}
+{% data reusables.actions.creating-a-runner-group-for-an-organization %}
 
 ## Crear un grupo de ejecutores auto-hospedados para una empresa
 
-Las empresas pueden agregar sus ejecutores auto-hospedados a grupos para su administración de accesos. Las empresas pueden crear grupos de ejecutores auto-hospedados que son accesibles para organizaciones específicas en la cuenta empresarial{% ifversion restrict-groups-to-workflows %} o para flujos de trabajo específicos{% endif %}. Los propietarios de organizaciones pueden entonces asignar políticas de acceso adicionales y granulares para los repositorios{% ifversion restrict-groups-to-workflows %} o flujos de trabajo{% endif %} a los grupos de ejecutores empresariales. Para obtener más información sobre cómo crear un grupo de ejecutores auto-hospedados con la API de REST, consulta las terminales empresariales en la [API de REST de {% data variables.product.prodname_actions %}](/rest/reference/actions#self-hosted-runner-groups).
-
-Los ejecutores auto-hospedados se asignan automáticamente al grupo predeterminado cuando se crean y solo pueden ser mimebros de un grupo a la vez. Puedes asignar el ejecutor a un grupo específico durante el proceso de registro o puedes moverlo después desde el grupo predeterminado a un grupo personalizado.
-
-Cuando creas un grupo, debes elegir la política que defina qué organizaciones tienen acceso al grupo de ejecutores.
-
-{% data reusables.actions.self-hosted-runner-groups-add-to-enterprise-first-steps %}
-1. Para elegir una política para el acceso organizacional, selecciona el menú desplegable **Acceso organizacional** y haz clic en una política. Puedes configurar un grupo de ejecutores para que sea accesible a una lista de organizaciones específica o a todas las organizaciones en la empresa.{% ifversion ghes %} Predeterminadamente, solo los repositorios privados pueden acceder a los ejecutores en un grupo, pero esto se puede anular.{% endif %}
+ {%- ifversion ghec or ghes %}
 
-   {%- ifversion ghec or ghes %}
-   {% warning %}
+{% data reusables.actions.self-hosted-runner-security-admonition %}
 
-   **Advertencia**:
+{%- endif %}
 
-   {% indented_data_reference reusables.actions.self-hosted-runner-security spaces=3 %}
-
-   Para obtener más información, consulta "[Acerca de los ejecutores autoalojados](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)."
-
-   {% endwarning %}
-   {%- endif %}
-   {%- ifversion ghec or ghes %}
-
-   ![Agregar opciones de un grupo de ejecutores](/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png)
-   {%- elsif ghae %}
-
-   ![Agregar opciones de un grupo de ejecutores](/assets/images/help/settings/actions-enterprise-account-add-runner-group-options-ae.png)
-   {%- endif %}
-{% data reusables.actions.runner-group-assign-policy-workflow %}
-1. Da clic en **Guardar grupo** para crear el grupo y aplicar la política.
+{% data reusables.actions.creating-a-runner-group-for-an-enterprise %}
 
 {% endif %}
 
 ## Cambiar la política de acceso de un grupo de ejecutores auto-hospedados
 
-En el caso de los grupos de ejecutores en una empresa, puedes cambiar qué organizaciones dentro de ella pueden acceder a un grupo de ejecutores{% ifversion restrict-groups-to-workflows %} o restringir qué flujos de trabajo puede ejecutar un grupo de ejecutores{% endif %}. En el caso de los grupos de ejecutores en una organización, puedes cambiar qué repositorios en ella pueden acceder a un grupo de ejecutores{% ifversion restrict-groups-to-workflows %} o restringir qué flujos de trabajo puede ejecutar un grupo de ejecutores{% endif %}.
-
-### Cambiar qué organizaciones o repositorios pueden acceder a un grupo de ejecutores
-
-{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %}
-{% data reusables.actions.self-hosted-runner-groups-navigate-to-repo-org-enterprise %}
-{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %}
-1. En el caso de los grupos de ejecutores en una empresa, debajo de **Acceso organizacional**, modifica qué organizaciones pueden acceder al grupo de ejecutores. En el caso de los grupos de ejecutores en una organización, debajo de **Acceso al repositorio**, modifica aquellos a los que puede acceder este grupo.
-
-   {%- ifversion fpt or ghec or ghes %}
-   {% warning %}
-
-   **Advertencia**:
-
-   {% indented_data_reference reusables.actions.self-hosted-runner-security spaces=3 %}
-
-   Para obtener más información, consulta "[Acerca de los ejecutores autoalojados](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)."
-
-   {% endwarning %}
-   {%- endif %}
-{% elsif ghae or ghes < 3.4 %}
-{% data reusables.actions.self-hosted-runner-configure-runner-group-access %}
-{% endif %}
+{%- ifversion fpt or ghec or ghes %}
 
-{% ifversion restrict-groups-to-workflows %}
-### Cambiar los flujos de trabajo a los cuales puede acceder un grupo de ejecutores
-Puedes configurar un grupo de ejecutores auto-hospedado para que ejecute ya sea flujos selectos o todos ellos. Por ejemplo, podrías utilizar este ajuste para proteger secretos almacenados en los ejecutores auto-hospedados o estandarizar los flujos de trabajo de despliegue restringiendo un grupo de ellos para que ejecute solo un flujo de trabajo reutilizable específico. Este ajuste no se puede anular si estás configurando un grupo de ejecutores de una organización que haya compartido una empresa.
-{% data reusables.actions.self-hosted-runner-groups-navigate-to-repo-org-enterprise %}
-{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %}
-1. Debajo de **Acceso al flujo de trabajo**, selecciona el menú desplegable y haz clic en **Flujos de trabajo selectos**.
-1. Da clic en {% octicon "gear" aria-label="the gear icon" %}.
-1. Ingresa una lista separada por comas de los flujos de trabajo que pueden acceder al grupo de ejecutores. Utiliza la ruta completa, incluyendo el nombre y propietario del repositorio. Fija el flujo de trabajo a una rama, etiqueta o SHA completo. Por ejemplo: `octo-org/octo-repo/.github/workflows/build.yml@v2, octo-org/octo-repo/.github/workflows/deploy.yml@d6dc6c96df4f32fa27b039f2084f576ed2c5c2a5, monalisa/octo-test/.github/workflows/test.yml@main`.
+{% data reusables.actions.self-hosted-runner-security-admonition %}
 
-   Solo los jobs que se definan directamente dentro de los flujos de trabajo seleccionados tendrán acceso al grupo de ejecutores.
+{%- endif %}
 
-   Los grupos de ejecutores que pertenecen a la organización no pueden acceder a los flujos de trabajo de otra organización de la empresa; en vez de esto, debes crear un grupo de ejecutores que pertenezca a la empresa.
-
-1. Haz clic en **Save ** (guardar).
-
-{% endif %}
+{% data reusables.actions.changing-the-access-policy-of-a-runner-group %}
 
 ## Cambiar el nombre de un grupo de ejectuores
 
-{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %}
-{% data reusables.actions.self-hosted-runner-groups-navigate-to-repo-org-enterprise %}
-{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %}
-1. Cambia el nombre del grupo de ejecutores.
-
-{% elsif ghae or ghes < 3.4 %}
-{% data reusables.actions.self-hosted-runner-configure-runner-group %}
-1. Cambia el nombre del grupo de ejecutores.
-{% endif %}
+{% data reusables.actions.changing-the-name-of-a-runner-group %}
 
 {% ifversion ghec or ghes or ghae %}
 ## Agregar ejecutores auto-hospedados a un grupo automáticamente
 
-Puedes utilizar el script de configuración para agregar automáticamente un ejecutor auto-hospedado nuevo a un grupo. Por ejemplo, este comando registra un ejecutor auto-hospedado nuevo y utiliza el parámetro `--runnergroup` para agregarlo a un grupo llamado `rg-runnergroup`.
-
-```sh
-./config.sh --url $org_or_enterprise_url --token $token --runnergroup rg-runnergroup
-```
-
-El comando fallará si el grupo de ejecutores no existe:
-
-```
-Could not find any self-hosted runner group named "rg-runnergroup".
-```
+{% data reusables.actions.automatically-adding-a-runner-to-a-group %}
 
 ## Mover un ejecutor auto-hospedado a un grupo
 
-Si no especificas un grupo de ejecutores durante el proceso de registro, tus ejecutores auto-hospedados nuevos se asignarán automáticamente al grupo predeterminado y después se moverán a otro grupo.
-
-{% data reusables.actions.self-hosted-runner-navigate-to-org-enterprise %}
-{% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %}
-1. En la lista de "Ejecutores", haz clic en aquél que quieras configurar.
-2. Selecciona el menú desplegable de **Grupo de ejecutores**.
-3. En "Mover el ejecutor al grupo", elige un grupo destino para el ejecutor.
-{% elsif ghae or ghes < 3.4 %}
-1. En la sección {% ifversion ghes or ghae %}"Grupos de ejecutores"{% endif %} de la página de ajustes, ubica el grupo actual del ejecutor que quieras mover y expande la lista de miembros del grupo. ![Ver los miembros de un grupo de ejecutores](/assets/images/help/settings/actions-org-runner-group-members.png)
-2. Selecciona la casilla junto al ejecutor auto-hospedado y da clic en **Mover a grupo** para ver los destinos disponibles. ![Mover a un miembro de un grupo de ejecutores](/assets/images/help/settings/actions-org-runner-group-member-move.png)
-3. Para mover el ejecutor, da clic en el grupo de destino. ![Mover a un miembro de un grupo de ejecutores](/assets/images/help/settings/actions-org-runner-group-member-move-destination.png)
-{% endif %}
+{% data reusables.actions.moving-a-runner-to-a-group %}
 
 ## Eliminar un grupo de ejecutores auto-hospedados
 
-Los ejecutores auto-hospedados se devuelven automáticamente al grupo predeterminado cuando su grupo se elimina.
+{% data reusables.actions.removing-a-runner-group %}
 
-{% ifversion ghes or ghae or ghec %}
-{% data reusables.actions.self-hosted-runner-groups-navigate-to-repo-org-enterprise %}
-1. En la lista de grupos, a la derecha del grupo que quieras borrar, haz clic en {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}.
-2. Para eliminar el grupo, da clic en **Eliminar grupo**.
-3. Revisa el mensaje de confirmación y da clic en **Eliminar este grupo de ejecutores**.
-
-{% endif %}
 {% endif %}
diff --git a/translations/es-ES/content/actions/learn-github-actions/understanding-github-actions.md b/translations/es-ES/content/actions/learn-github-actions/understanding-github-actions.md
index 8fb0045e0d1f..cbadb6cb6065 100644
--- a/translations/es-ES/content/actions/learn-github-actions/understanding-github-actions.md
+++ b/translations/es-ES/content/actions/learn-github-actions/understanding-github-actions.md
@@ -2,6 +2,7 @@
 title: Entender las GitHub Actions
 shortTitle: Entendiendo las GitHub Actions
 intro: 'Aprende lo básico de las {% data variables.product.prodname_actions %}, incluyendo los conceptos nucleares y la terminología esencial.'
+miniTocMaxHeadingLevel: 3
 redirect_from:
   - /github/automating-your-workflow-with-github-actions/core-concepts-for-github-actions
   - /actions/automating-your-workflow-with-github-actions/core-concepts-for-github-actions
@@ -82,7 +83,7 @@ Para obtener más información, consulta la sección "[Crear acciones](/actions/
 
 ### Ejecutores
 
-{% data reusables.actions.about-runners %} Cada ejecutor puede ejecutar un job individual a la vez. {% ifversion ghes or ghae %} Debes hospedar tus propios ejecutores para {% data variables.product.product_name %}. {% elsif fpt or ghec %}{% data variables.product.company_short %} proporciona ejecutores de Ubuntu Linux, Microsoft Windows y macOS para ejecutar tus flujos de trabajo; cada flujo de trabajo se ejecuta en una máquina virtual nueva y recién aprovisionada. Si necesitas un sistema operativo diferente o si requieres una configuración de hardware específica, puedes hospedar tus propios ejecutores.{% endif %} Para obtener más información{% ifversion fpt or ghec %} sobre los ejecutores auto-hospedados{% endif %}, consulta la sección "[Hospedar tus propios ejecutores](/actions/hosting-your-own-runners)".
+{% data reusables.actions.about-runners %} Cada ejecutor puede ejecutar un job individual a la vez. {% ifversion ghes or ghae %} Debes hospedar tus propios ejecutores para {% data variables.product.product_name %}. {% elsif fpt or ghec %}{% data variables.product.company_short %} proporciona ejecutores de Ubuntu Linux, Microsoft Windows y macOS para ejecutar tus flujos de trabajo; cada flujo de trabajo se ejecuta en una máquina virtual nueva y recién aprovisionada. {% ifversion actions-hosted-runners %} {% data variables.product.prodname_dotcom %} also offers {% data variables.actions.hosted_runner %}s, which are available in larger configurations. For more information, see "[Using {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/using-larger-runners)." {% endif %}If you need a different operating system or require a specific hardware configuration, you can host your own runners.{% endif %} For more information{% ifversion fpt or ghec %} about self-hosted runners{% endif %}, see "[Hosting your own runners](/actions/hosting-your-own-runners)."
 
 {% data reusables.actions.workflow-basic-example-and-explanation %}
 
diff --git a/translations/es-ES/content/actions/publishing-packages/publishing-nodejs-packages.md b/translations/es-ES/content/actions/publishing-packages/publishing-nodejs-packages.md
index bb16664970f1..2c2330de279f 100644
--- a/translations/es-ES/content/actions/publishing-packages/publishing-nodejs-packages.md
+++ b/translations/es-ES/content/actions/publishing-packages/publishing-nodejs-packages.md
@@ -98,9 +98,9 @@ Cada vez que creas un lanzamiento nuevo, puedes desencadenar un flujo de trabajo
 
 ### Configurar el repositorio de destino
 
-Si no proporcionas la clave del `repository` en tu archivo *package.json*, entonces el {% data variables.product.prodname_registry %} publicará un paquete en el repositorio de {% data variables.product.prodname_dotcom %} que especifiques en el campo `name` del archivo *package.json*. Por ejemplo, un paquete denominado `@my-org/test` se publicará en el repositorio `my-org/test` de {% data variables.product.prodname_dotcom %}.
+Linking your package to {% data variables.product.prodname_registry %} using the `repository` key is optional. If you choose not to provide the `repository` key in your *package.json* file, then {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the `name` field of the *package.json* file. Por ejemplo, un paquete denominado `@my-org/test` se publicará en el repositorio `my-org/test` de {% data variables.product.prodname_dotcom %}. If the `url` specified in the `repository` key is invalid, your package may still be published however it won't be linked to the repository source as intended.
 
-Sin embargo, si no proporcionas la clave del `repository`, entonces el repositorio en esa clave se utilizará como el registro de npm de destino para el {% data variables.product.prodname_registry %}. Por ejemplo, el publicar el siguiente *package.json* dará como resultado un paquete denominado `my-amazing-package` que se publicará en el repositorio `octocat/my-other-repo` de {% data variables.product.prodname_dotcom %}.
+If you do provide the `repository` key in your *package.json* file, then the repository in that key is used as the destination npm registry for {% data variables.product.prodname_registry %}. Por ejemplo, el publicar el siguiente *package.json* dará como resultado un paquete denominado `my-amazing-package` que se publicará en el repositorio `octocat/my-other-repo` de {% data variables.product.prodname_dotcom %}. Once published, only the repository source is updated, and the package doesn't inherit any permissions from the destination repository.
 
 ```json
 {
diff --git a/translations/es-ES/content/actions/using-github-hosted-runners/about-github-hosted-runners.md b/translations/es-ES/content/actions/using-github-hosted-runners/about-github-hosted-runners.md
index dcfa57bf9be7..62fe7d964cd0 100644
--- a/translations/es-ES/content/actions/using-github-hosted-runners/about-github-hosted-runners.md
+++ b/translations/es-ES/content/actions/using-github-hosted-runners/about-github-hosted-runners.md
@@ -86,6 +86,15 @@ While the job runs, the logs and output can be viewed in the {% data variables.p
 
 ## Supported runners and hardware resources
 
+{% ifversion actions-hosted-runners %}
+
+{% note %}
+
+**Note**: {% data variables.product.prodname_dotcom %} also offers {% data variables.actions.hosted_runner %}s, which are available in larger configurations. For more information, see "[Using {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/using-larger-runners)." 
+
+{% endnote %}
+{% endif %}
+
 Hardware specification for Windows and Linux virtual machines:
 - 2-core CPU (x86_64)
 - 7 GB of RAM
diff --git a/translations/es-ES/content/actions/using-github-hosted-runners/controlling-access-to-larger-runners.md b/translations/es-ES/content/actions/using-github-hosted-runners/controlling-access-to-larger-runners.md
new file mode 100644
index 000000000000..187cf4b81a9a
--- /dev/null
+++ b/translations/es-ES/content/actions/using-github-hosted-runners/controlling-access-to-larger-runners.md
@@ -0,0 +1,50 @@
+---
+title: Controlling access to larger runners
+intro: 'Puedes utilizar políticas para limitar el acceso a los {% data variables.actions.hosted_runner %} que se hayan agregado a una organización o empresa.'
+product: '{% data reusables.gated-features.hosted-runners %}'
+versions:
+  feature: actions-hosted-runners
+type: tutorial
+shortTitle: 'Controlling access to {% data variables.actions.hosted_runner %}s'
+---
+
+{% data reusables.actions.enterprise-beta %}
+{% data reusables.actions.enterprise-github-hosted-runners %}
+
+## About runner groups
+
+{% data reusables.actions.about-runner-groups %} {% ifversion fpt %}For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/actions/using-github-hosted-runners/controlling-access-to-larger-runners).{% endif %}
+
+{% ifversion ghec or ghes or ghae %}
+
+## Creating a runner group for an organization
+
+{% data reusables.actions.hosted-runner-security-admonition %}
+{% data reusables.actions.creating-a-runner-group-for-an-organization %}
+
+## Creating a runner group for an enterprise
+
+{% data reusables.actions.hosted-runner-security-admonition %}
+{% data reusables.actions.creating-a-runner-group-for-an-enterprise %}
+
+{% endif %}
+
+## Changing the access policy of a runner group
+
+{% data reusables.actions.hosted-runner-security-admonition %}
+{% data reusables.actions.changing-the-access-policy-of-a-runner-group %}
+
+## Cambiar el nombre de un grupo de ejectuores
+
+{% data reusables.actions.changing-the-name-of-a-runner-group %}
+
+{% ifversion ghec or ghes or ghae %}
+## Moving a runner to a group
+
+{% data reusables.actions.moving-a-runner-to-a-group %}
+
+## Removing a runner group
+
+{% data reusables.actions.removing-a-runner-group %}
+
+{% endif %}
diff --git a/translations/es-ES/content/actions/using-github-hosted-runners/index.md b/translations/es-ES/content/actions/using-github-hosted-runners/index.md
index 07f6d827cf4e..d8b2fd9f0224 100644
--- a/translations/es-ES/content/actions/using-github-hosted-runners/index.md
+++ b/translations/es-ES/content/actions/using-github-hosted-runners/index.md
@@ -7,6 +7,8 @@ versions:
   ghes: '*'
 children:
   - /about-github-hosted-runners
+  - /using-larger-runners
+  - /controlling-access-to-larger-runners
   - /monitoring-your-current-jobs
   - /customizing-github-hosted-runners
   - /connecting-to-a-private-network
diff --git a/translations/es-ES/content/actions/using-github-hosted-runners/using-larger-runners.md b/translations/es-ES/content/actions/using-github-hosted-runners/using-larger-runners.md
new file mode 100644
index 000000000000..22ea0079197c
--- /dev/null
+++ b/translations/es-ES/content/actions/using-github-hosted-runners/using-larger-runners.md
@@ -0,0 +1,135 @@
+---
+title: Using larger runners
+intro: '{% data variables.product.prodname_dotcom %} offers larger runners with more RAM and CPU.'
+miniTocMaxHeadingLevel: 3
+product: '{% data reusables.gated-features.hosted-runners %}'
+versions:
+  feature: 'actions-hosted-runners'
+shortTitle: Using {% data variables.actions.hosted_runner %}s
+---
+
+## Overview of {% data variables.actions.hosted_runner %}s
+
+In addition to the [standard {% data variables.product.prodname_dotcom %}-hosted runners](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources), {% data variables.product.prodname_dotcom %} also offers customers on {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %} plans a range of {% data variables.actions.hosted_runner %}s with more RAM and CPU. These runners are hosted by {% data variables.product.prodname_dotcom %} and have the runner application and other tools preinstalled.
+
+When you add a {% data variables.actions.hosted_runner %} to an organization, you are defining a type of machine from a selection of available hardware specifications and operating system images. {% data variables.product.prodname_dotcom %} will then create multiple instances of this runner that scale up and down to match the job demands of your organization, based on the autoscaling limits you define.
+
+## Architectural overview of {% data variables.actions.hosted_runner %}s
+
+The {% data variables.actions.hosted_runner %}s are managed at the organization level, where they are arranged into groups that can contain multiple instances of the runner. They can also be created at the enterprise level and shared with organizations in the hierarchy. Once you've created a group, you can then add a runner to the group and update your workflows to target the label assigned to the {% data variables.actions.hosted_runner %}. You can also control which repositories are permitted to send jobs to the group for processing. For more information about groups, see "[Controlling access to {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/controlling-access-to-larger-runners)."
+
+In the following diagram, a class of hosted runner named `ubuntu-20.04-16core` has been defined with customized hardware and operating system configuration.
+
+![Diagram explaining {% data variables.actions.hosted_runner %}](/assets/images/hosted-runner.png)
+
+1. Instances of this runner are automatically created and added to a group called `ubuntu-20.04-16core`. 
+2. The runners have been assigned the label `ubuntu-20.04-16core`. 
+3. Workflow jobs use the `ubuntu-20.04-16core` label in their `runs-on` key to indicate the type of runner they need to execute the job.
+4. {% data variables.product.prodname_actions %} checks the runner group to see if your repository is authorized to send jobs to the runner.
+5. The job runs on the next available instance of the `ubuntu-20.04-16core` runner.
+
+## Autoscaling {% data variables.actions.hosted_runner %}s
+
+Your {% data variables.actions.hosted_runner %}s can be configured to automatically scale to suit your needs. When jobs are submitted for processing, more machines can be automatically provisioned to run the jobs, until reaching a pre-defined maximum limit. Each machine only handles one job at a time, so these settings effectively determine the number of jobs that can be run concurrently. 
+
+During the runner deployment process, you can configure the _Max_ option, which allows you to control your costs by setting the maximum parallel number of machines that are created in this set. A higher value here can help avoid workflows being blocked due to parallelism.
+
+## Networking for {% data variables.actions.hosted_runner %}s
+
+By default, {% data variables.actions.hosted_runner %}s receive a dynamic IP address that changes for each job run. Optionally, {% data variables.product.prodname_ghe_cloud %} customers can configure their {% data variables.actions.hosted_runner %}s to receive a static IP address from {% data variables.product.prodname_dotcom %}'s IP address pool. When enabled, instances of the {% data variables.actions.hosted_runner %} will receive an address from a range that is unique to the runner, allowing you to use this range to configure a firewall allowlist. You can use up to 10 static IP address ranges in total across all your {% data variables.actions.hosted_runner %}s.
+
+{% note %}
+
+**Note**: If runners are unused for more than 30 days, their IP address ranges are automatically removed and cannot be recovered.
+
+{% endnote %}
+
+## Planning for {% data variables.actions.hosted_runner %}s
+
+### Create a runner group
+
+Runner groups are used to collect sets of virtual machines and create a security boundary around them. You can then decide which organizations or repositories are permitted to run jobs on those sets of machines. During the {% data variables.actions.hosted_runner %} deployment process, the runner can be added to an existing group, or otherwise it will join a default group. You can create a group by following the steps in "[Controlling access to {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/controlling-access-to-larger-runners)."
+
+### Understanding billing
+
+Compared to standard {% data variables.product.prodname_dotcom %}-hosted runners, {% data variables.actions.hosted_runner %}s are billed differently. For more information, see "[Per-minute rates](/billing/managing-billing-for-github-actions/about-billing-for-github-actions#per-minute-rates)".
+
+## Adding a {% data variables.actions.hosted_runner %} to an enterprise
+
+You can add {% data variables.actions.hosted_runner %}s to an enterprise, where they can be assigned to multiple organizations. The organization admins can then control which repositories can use the runners. To add a {% data variables.actions.hosted_runner %} to an enterprise, you must be an enterprise owner.
+
+{% data reusables.actions.add-hosted-runner-overview %}
+
+{% data reusables.enterprise-accounts.access-enterprise %}
+{% data reusables.enterprise-accounts.policies-tab %}
+{% data reusables.enterprise-accounts.actions-tab %}
+{% data reusables.enterprise-accounts.actions-runners-tab %}
+{% data reusables.actions.add-hosted-runner %}
+1. To allow organizations to access your {% data variables.actions.hosted_runner %}s, you specify the list of organizations that can use it. For more information, see "[Managing access to your runners](#managing-access-to-your-runners)."
+
+## Adding a {% data variables.actions.hosted_runner %} to an organization
+
+You can add a {% data variables.actions.hosted_runner %} to an organization, where the organization admins can control which repositories can use it. 
+
+{% data reusables.actions.add-hosted-runner-overview %}
+
+{% data reusables.organizations.navigate-to-org %}
+{% data reusables.organizations.org_settings %}
+{% data reusables.organizations.settings-sidebar-actions-runners %}
+{% data reusables.actions.add-hosted-runner %}
+1. To allow repositories to access your {% data variables.actions.hosted_runner %}s, add them to the list of repositories that can use it. For more information, see "[Managing access to your runners](#managing-access-to-your-runners)."
+
+## Running jobs on your runner
+
+Once your runner type has been been defined, you can update your workflows to send jobs to the runner instances for processing. In this example, a runner group is populated with Ubuntu 16-core runners, which have been assigned the label `ubuntu-20.04-16core`. If you have a runner matching this label, the `check-bats-version` job then uses the `runs-on` key to target that runner whenever the job is run:
+
+```yaml
+name: learn-github-actions
+on: [push]
+jobs:
+  check-bats-version:
+    runs-on: ubuntu-20.04-16core
+    steps:
+      - uses: {% data reusables.actions.action-checkout %}
+      - uses:{% data reusables.actions.action-setup-node %}
+        with:
+          node-version: '14'
+      - run: npm install -g bats
+      - run: bats -v
+```
+
+## Managing access to your runners
+
+{% note %}
+
+**Note**: Before your workflows can send jobs to {% data variables.actions.hosted_runner %}s, you must first configure permissions for the runner group. See the following sections for more information.
+
+{% endnote %}
+
+Runner groups are used to control which repositories can run jobs on your {% data variables.actions.hosted_runner %}s. You must grant access to the group from each level of the management hierarchy, depending on where you've defined the {% data variables.actions.hosted_runner %}:
+
+- **Runners at the enterprise level**: Configure the runner group to grant access to all the required organizations. In addition, for each organization, you must configure the group to specify which repositories are allowed access.
+- **Runners at the organization level**: Configure the runner group by specifying which repositories are allowed access.
+
+For example, the following diagram has a runner group named `grp-ubuntu-20.04-16core` at the enterprise level. Before the repository named `octo-repo` can use the runners in the group, you must first configure the group at the enterprise level to allow access from the `octo-org` organization; you must then configure the group at the organization level to allow access from `octo-repo`:
+
+![Diagram explaining {% data variables.actions.hosted_runner %} groups](/assets/images/hosted-runner-mgmt.png)
+
+### Allowing repositories to access a runner group
+
+This procedure demonstrates how to configure group permissions at the enterprise and organization levels:
+
+{% data reusables.actions.runner-groups-navigate-to-repo-org-enterprise %}
+{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %}
+  - For runner groups in an enterprise: under **Organization access**, modify which organizations can access the runner group.
+  - For runner groups in an organization: under **Repository access**, modify which repositories can access the runner group.
+
+{% warning %}
+
+**Warning**:
+
+{% data reusables.actions.hosted-runner-security %}
+
+For more information, see "[Controlling access to {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/controlling-access-to-larger-runners)."
+
+{% endwarning %}
diff --git a/translations/es-ES/content/actions/using-workflows/about-workflows.md b/translations/es-ES/content/actions/using-workflows/about-workflows.md
index 4706a7fb4a86..d86a02068fdb 100644
--- a/translations/es-ES/content/actions/using-workflows/about-workflows.md
+++ b/translations/es-ES/content/actions/using-workflows/about-workflows.md
@@ -1,7 +1,7 @@
 ---
 title: Acerca de los flujos de trabajo
 shortTitle: Acerca de los flujos de trabajo
-intro: 'Get a high level overview {% data variables.product.prodname_actions %} workflows, including triggers, syntax, and advanced features.'
+intro: 'Obtén flujos de trabajo de {% data variables.product.prodname_actions %} de resumen de alto nivel, incluyendo activadores, sintaxis y características avanzadas.'
 versions:
   fpt: '*'
   ghes: '*'
@@ -20,15 +20,15 @@ miniTocMaxHeadingLevel: 3
 
 {% data reusables.actions.about-workflows-long %}
 
-## Workflow basics
+## Puntos básicos de los flujos de trabajo
 
-A workflow must contain the following basic components:
+Un flujo de trabajo debe contener los siguientes componentes básicos:
 
-1. One or more _events_ that will trigger the workflow.
-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.
+1. Uno o más _eventos_ que activarán el flujo de trabajo.
+1. Uno o más _jobs_, cada uno de los cuales se ejecutará en una máquina _ejecutora_ y ejecutará una serie de uno o más _pasos_.
+1. Cada paso puede ya sea ejecutar un script que defines o ejecutar una acción, la cual es una extensión reutilizable que puede simplificar tu flujo de trabajo.
 
-For more information on these basic components, see "[Understanding GitHub Actions](/actions/learn-github-actions/understanding-github-actions#the-components-of-github-actions)."
+Para obtener más información sobre estos componentes básicos, consulta la sección "[Entender las GitHub Actions](/actions/learn-github-actions/understanding-github-actions#the-components-of-github-actions)".
 
 ![Resumen del flujo de trabajo](/assets/images/help/images/overview-actions-simple.png)
 
@@ -36,32 +36,32 @@ For more information on these basic components, see "[Understanding GitHub Actio
 
 {% data reusables.actions.about-triggers %}
 
-For more information, see "[Triggering a workflow](/actions/using-workflows/triggering-a-workflow)", and for a full list of events, see "[Events that trigger workflows](/actions/using-workflows/events-that-trigger-workflows)."
+Para obtener más información, consulta la sección "[Activar un flujo de trabajo](/actions/using-workflows/triggering-a-workflow)" y para encontrar una lista completa de eventos, consulta la sección "[Eventos que activan flujos de trabajo](/actions/using-workflows/events-that-trigger-workflows)".
 
 ## Sintaxis de flujos de trabajo
 
-Workflow are defined using YAML. For the full reference of the YAML syntax for authoring workflows, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#about-yaml-syntax-for-workflows)."
+Los flujos de trabajo se definen utilizando YAML. Para encontrar una referencia completa de la sintaxis de YAML para flujos de trabajo de creación, consulta la sección "[Sintaxis de fluljo de trabajo para GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#about-yaml-syntax-for-workflows)".
 
 
 {% data reusables.actions.workflow-basic-example-and-explanation %}
 
-For more on managing workflow runs, such as re-running, cancelling, or deleting a workflow run, see "[Managing workflow runs](/actions/managing-workflow-runs)."
+Para ver más información sobre cómo manejar las ejecuciones de flujo de trabajo tales como re-ejecutar, cancelar o borrar una ejecución de flujo de trabajo, consulta la sección "[Administrar las ejecuciones de flujo de trabajo](/actions/managing-workflow-runs)".
 
 ## Utilizar flujos de trabajo iniciales
 
 {% data reusables.actions.workflow-template-overview %}
 
-For more information on using and creating starter workflows, see "[Using starter workflows](/actions/using-workflows/using-starter-workflows)" and "[Creating starter workflows for your organization](/actions/using-workflows/creating-starter-workflows-for-your-organization)."
+Para obtener más información sobre cómo utilizar y crear flujos de trabajo iniciales, consulta las secciones "[Utilizar flujos de trabajo iniciales](/actions/using-workflows/using-starter-workflows)" y "[Crear flujos de trabajo iniciales para tu organización](/actions/using-workflows/creating-starter-workflows-for-your-organization)".
 
 ## Características avanzadas de los flujos de trabajo
 
-This section briefly describes some of the advanced features of {% data variables.product.prodname_actions %} that help you create more complex workflows.
+Esta sección describe brevemente algunas de las características avanzadas de {% data variables.product.prodname_actions %} que te ayudan a crear flujos de trabajo más complejos.
 
 ### Almacenar secretos
 
-Si tus flujos de trabajo utilizan datos sensibles tales como contraseñas o certificados, puedes guardarlos en {% data variables.product.prodname_dotcom %} como _secretos_ y luego usarlos en tus flujos de trabajo como variables de ambiente. This means that you will be able to create and share workflows without having to embed sensitive values directly in the workflow's YAML source.
+Si tus flujos de trabajo utilizan datos sensibles tales como contraseñas o certificados, puedes guardarlos en {% data variables.product.prodname_dotcom %} como _secretos_ y luego usarlos en tus flujos de trabajo como variables de ambiente. Esto significa que podrás crear y compartir flujos de trabajo sin tener que embeber valores sensibles directamente en la fuente de YAML del flujo de trabajo.
 
-This example job demonstrates how to reference an existing secret as an environment variable, and send it as a parameter to an example command.
+Este job de ejemplo demuestra como referenciar un secreto existente como una variable de ambiente y enviarlo como un parámetro a un comando de ejemplo.
 
 {% raw %}
 ```yaml
@@ -81,7 +81,7 @@ Para obtener más información, consulta la sección "[Secretos cifrados](/actio
 
 ### Crear jobs dependientes
 
-Predeterminadamente, los jobs en tu flujo de trabajo se ejecutan todos en paralelo y al mismo tiempo. If you have a job that must only run after another job has completed, you can use the `needs` keyword to create this dependency. If one of the jobs fails, all dependent jobs are skipped; however, if you need the jobs to continue, you can define this using the `if` conditional statement.
+Predeterminadamente, los jobs en tu flujo de trabajo se ejecutan todos en paralelo y al mismo tiempo. Si tienes un job que solo se debe ejecutar después de que se complete otro, puedes utilizar la palabra clave `needs` para crear esta dependencia. Si uno de los jobs falla, todos los jobs dependientes se omiten; sin embargo, si necesites que estos continúen, puedes definir esto utilizando la declaración condicional `if`.
 
 En este ejemplo, los jobs de `setup`, `build`, y `test` se ejecutan en serie, y `build` y `test` son dependientes de que el job que las precede se complete con éxito:
 
@@ -107,7 +107,7 @@ Para obtener más información, consulta la sección "[Definir los jobs de prerr
 
 ### Utilizar una matriz
 
-{% 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:
+{% data reusables.actions.jobs.about-matrix-strategy %} La matriz se crea utilizando la palabra clave `strategy`, la cual recibe las opciones de compilación como un arreglo. Por ejemplo, esta matriz ejecutará el job varias veces, utilizando versiones diferentes de Node.js:
 
 ```yaml
 jobs:
@@ -127,7 +127,7 @@ Para obtener más información, consulta la sección "[Utilizar una matriz para
 {% ifversion actions-caching %}
 ### Almacenar dependencias en caché
 
-If your jobs regularly reuse dependencies, you can consider caching these files to help improve performance. Una vez que se crea el caché, estará disponible para todos los flujos de trabajo en el mismo repositorio.
+Si tus jobs utilizan dependencias con frecuencia, puedes considerar almacenar estos archivos en caché para ayudar a mejorar el desempeño. Una vez que se crea el caché, estará disponible para todos los flujos de trabajo en el mismo repositorio.
 
 Este ejemplo ilustra cómo almacenar el directorio `~/.npm` en el caché:
 
@@ -173,7 +173,7 @@ jobs:
           POSTGRES_PORT: 5432
 ```
 
-For more information, see "[Using containerized services](/actions/using-containerized-services)."
+Para obtener más información, consulta la sección "[Utilizar servicios en contenedores](/actions/using-containerized-services)".
 
 ### Utilizar etiquetas para enrutar los flujos de trabajo
 
@@ -187,12 +187,12 @@ jobs:
     runs-on: [self-hosted, linux, x64, gpu]
 ```
 
-Un flujo de trabajo solo se ejecutará en un ejecutor que tenga todas las etiquetas en el arreglo `runs-on`. El job irá preferencialmente a un ejecutor auto-hospedado inactivo con las etiquetas especificadas. {% ifversion fpt or ghec %}If none are available and a {% data variables.product.prodname_dotcom %}-hosted runner with the specified labels exists, the job will go to a {% data variables.product.prodname_dotcom %}-hosted runner.{% endif %}
+Un flujo de trabajo solo se ejecutará en un ejecutor que tenga todas las etiquetas en el arreglo `runs-on`. El job irá preferencialmente a un ejecutor auto-hospedado inactivo con las etiquetas especificadas. {% ifversion fpt or ghec %}Si ninguno está disponible y existe un ejecutor hospedado en {% data variables.product.prodname_dotcom %} con las etiquetes especificadas, el job irá al ejecutor hospedado en {% data variables.product.prodname_dotcom %}.{% endif %}
 
-To learn more about self-hosted runner labels, see "[Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners)."
+Para aprender más sobre las etiquetas de ejecución auto-hospedadas, consulta la sección "[Utilizar etiquetas con los ejecutores auto-hospedados](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners)".
 
 {% ifversion fpt or ghec %}
-To learn more about {% data variables.product.prodname_dotcom %}-hosted runner labels, see "[Supported runners and hardware resources](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources)."
+Para aprender más sobre las etiquetas de ejecutores hospedados en {% data variables.product.prodname_dotcom %}, consulta la sección "[Recursos de hardware y ejecutores compatibles](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources)".
 {% endif %}
 
 {% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %}
@@ -202,4 +202,4 @@ To learn more about {% data variables.product.prodname_dotcom %}-hosted runner l
 
 ### Utilizar ambientes
 
-You can configure environments with protection rules and secrets to control the execution of jobs in a workflow. Cad job en un flujo de trabajo puede referenciar un solo ambiente. Cualquier regla de protección que se configure para el ambiente debe pasar antes de que un job que referencia al ambiente se envíe a un ejecutor. Para obtener más información, consulta la sección "[Utilizar ambientes para despliegue](/actions/deployment/using-environments-for-deployment)".
+Puedes configurar ambientes con reglas de protección y secretos para controlar la ejecución de jobs en un flujo de trabajo. Cad job en un flujo de trabajo puede referenciar un solo ambiente. Cualquier regla de protección que se configure para el ambiente debe pasar antes de que un job que referencia al ambiente se envíe a un ejecutor. Para obtener más información, consulta la sección "[Utilizar ambientes para despliegue](/actions/deployment/using-environments-for-deployment)".
diff --git a/translations/es-ES/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md b/translations/es-ES/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md
index c70e2ec695b3..d353ce0f3367 100644
--- a/translations/es-ES/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md
+++ b/translations/es-ES/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md
@@ -51,7 +51,7 @@ Para obtener más información sobre los artefactos de ejecución de flujos de t
 
 Un flujo de trabajo puede acceder y restaurar una caché creada en la rama actual, la rama base (incluidas las ramas base de los repositorios bifurcados) o la rama predeterminada (por lo general `main`). Por ejemplo, un caché creado en la rama predeterminada sería accesible desde cualquier solicitud de cambios. También, si la rama `feature-b` tiene la rama base `feature-a`, un flujo de trabajo activado en `feature-b` tendría acceso a las cachés creadas en la rama predeterminada (`main`), `feature-a` y `feature-b`.
 
-Las restricciones de acceso proporcionan aislamiento y seguridad de caché al crear una frontera lógica entre las ramas diferentes. Por ejemplo, una solicitud de cambios para la rama `feature-c` (con la base `main`) no podría acceder a un caché que se creó para la rama `feature-a` (con la base `main`).
+Access restrictions provide cache isolation and security by creating a logical boundary between different branches or tags. Por ejemplo, una solicitud de cambios para la rama `feature-c` (con la base `main`) no podría acceder a un caché que se creó para la rama `feature-a` (con la base `main`). On similar lines, a cache created for the tag `release-a` (from the base `main`) would not be accessible to a workflow triggered for the tag `release-b` (with the base `main`).
 
 Los flujos de trabajo múltiples dentro de un repositorio comparten entradas de caché. Puede accederse a un caché que se crea para una rama dentro de un flujo de trabajo y se puede establecer desde otro flujo de trabajo para el mismo repositorio y rama.
 
diff --git a/translations/es-ES/content/actions/using-workflows/reusing-workflows.md b/translations/es-ES/content/actions/using-workflows/reusing-workflows.md
index 7fbf626fd9b7..0678815493a8 100644
--- a/translations/es-ES/content/actions/using-workflows/reusing-workflows.md
+++ b/translations/es-ES/content/actions/using-workflows/reusing-workflows.md
@@ -23,7 +23,7 @@ topics:
 
 En vez de copiar y pegar desde un flujo de trabajo hacia otro, puedes hacer flujos de trabajo reutilizables. Tú y cualquiera que tenga acceso a un flujo de trabajo reutilizable pueden entonces llamarlo desde otro flujo.
 
-El reutilizar flujos de trabajo evita la duplicación. Esto hace que los flujos de trabajo se puedan mantener más fácilmente y te permite crear flujos de trabajo nuevos más fácilmente compilando sobre el trabajo de los demás, tal como lo haces con las acciones. La reutilización de flujos de trabajo también promueve las mejores prácticas al ayudarte a utilizar los flujos de trabajo que están bien diseñados, que ya se han probado y cuya efectividad ya se comprobó. Tu organización puede crear una librería de flujos de trabajo reutilizables que puede mantenerse centralmente.
+El reutilizar flujos de trabajo evita la duplicación. Esto hace que los flujos de trabajo se puedan mantener más fácilmente y te permite crear flujos de trabajo nuevos más fácilmente compilando sobre el trabajo de los demás, tal como lo haces con las acciones. Workflow reuse also promotes best practice by helping you to use workflows that are well designed, have already been tested, and have been proven to be effective. Tu organización puede crear una librería de flujos de trabajo reutilizables que puede mantenerse centralmente.
 
 El siguiente diagrama muestra tres jobs de compilación en la parte izquierda del mismo. Después de que cada uno de estos jobs se complete con éxito, se ejecutará un job dependiente llamado "Deploy". Este job crea un flujo de trabajo reutilizable que contiene tres jobs: "Staging", "Review" y "Production". El job de despliegue "Production" solo se ejecuta después de que el job "Staging" se haya completado con éxito. El utilizar un flujo de trabajo reutilizable para ejecutar jobs de despliegue te permite ejecutarlos para cada compilación sin duplicar el código en los flujos de trabajo.
 
@@ -127,7 +127,7 @@ Puedes definir entradas y secretos, las cuales pueden pasarse desde el flujo de
        runs-on: ubuntu-latest
        environment: production
        steps:
-         - uses: ./.github/workflows/my-action
+         - uses: octo-org/my-action@v1
            with:
              username: ${{ inputs.username }}
              token: ${{ secrets.envPAT }}
@@ -168,12 +168,13 @@ jobs:
     name: Pass input and secrets to my-action
     runs-on: ubuntu-latest
     steps:
-      - uses: ./.github/workflows/my-action
+      - uses: octo-org/my-action@v1
         with:
           username: ${{ inputs.username }}
           token: ${{ secrets.token }}
 ```
 {% endraw %}
+
 {% ifversion actions-reusable-workflow-matrix %}
 ## Utilizar una estrategia de matriz con un flujo de trabajo reutilizable
 
diff --git a/translations/es-ES/content/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise.md b/translations/es-ES/content/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise.md
index a9c9b79a9a05..13d6b1583afc 100644
--- a/translations/es-ES/content/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise.md
+++ b/translations/es-ES/content/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise.md
@@ -12,9 +12,9 @@ shortTitle: Estadísticas del servidor
 
 ## Acerca de las {% data variables.product.prodname_server_statistics %}
 
-{% data variables.product.prodname_server_statistics %} collects aggregate usage data from {% data variables.product.product_location %}, which you can use to better anticipate the needs of your organization, understand how your team works, and show the value you get from {% data variables.product.prodname_ghe_server %}.
+{% data variables.product.prodname_server_statistics %} recopila los datos de uso agregado de {% data variables.product.product_location %}, lo que te permite anticipar las necesidades de tu organización de una forma mejor, entender cómo trabaja tu equipo y mostrar el valor que obtienes de {% data variables.product.prodname_ghe_server %}.
 
-{% data variables.product.prodname_server_statistics %} only collects certain aggregate metrics on repositories, issues, pull requests, and other features.{% data variables.product.prodname_dotcom %} content, such as code, issues, comments, or pull request content, is not collected. Para obtener más información, consulta la sección "[Acerca de {% data variables.product.prodname_server_statistics %}](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics)".
+{% data variables.product.prodname_server_statistics %} solo recopila ciertas métricas agregadas en los repositorios, propuestas, solicitudes de cambio y otras características. No se recopila el contenido de {% data variables.product.prodname_dotcom %} tal como el código, las propuestas, los comentarios o el contenido de las solicitudes de cambio. Para obtener más información, consulta la sección "[Acerca de {% data variables.product.prodname_server_statistics %}](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics)".
 
 By enabling {% data variables.product.prodname_server_statistics %}, you are also helping to improve {% data variables.product.company_short %}. The aggregated data you will provide helps us understand how our customers are using {% data variables.product.prodname_dotcom %}, and make better and more informed product decisions, ultimately benefiting you.
 
diff --git a/translations/es-ES/content/admin/configuration/configuring-network-settings/configuring-a-hostname.md b/translations/es-ES/content/admin/configuration/configuring-network-settings/configuring-a-hostname.md
index ebc92a59356f..aef1dcf2fd47 100644
--- a/translations/es-ES/content/admin/configuration/configuring-network-settings/configuring-a-hostname.md
+++ b/translations/es-ES/content/admin/configuration/configuring-network-settings/configuring-a-hostname.md
@@ -19,6 +19,8 @@ Si configuras un nombre del host en lugar de una dirección IP codificada de for
 
 La configuración del nombre de host en la {% data variables.enterprise.management_console %} debe ajustarse a un nombre de dominio adecuado y que cumpla con todos los requisitos (FQDN) el cual se pueda resolver en la internet o dentro de tu red interna. Por ejemplo, tu ajuste de nombre de host podría ser `github.companyname.com.` Las solicitudes web y de la API se redireccionarán automáticamente al nombre de host que se configuró en la {% data variables.enterprise.management_console %}. Toma en cuenta que `localhost` no es un ajuste válido de nombre de host.
 
+Hostnames must be less than 63 characters in length per [Section 2.3.4 of the Domain Names Specification RFC](https://datatracker.ietf.org/doc/html/rfc1035#section-2.3.4).
+
 Después de que configuras un nombre de host, puedes habilitar el aislamiento de subdominios para incrementar la seguridad de {% data variables.product.product_location %} aún más. Para obtener más información, consulta "[Habilitar el aislamiento de subdominio](/enterprise/admin/guides/installation/enabling-subdomain-isolation/)."
 
 Para obtener más información sobre los tipos de nombres de host compatibles, consulta la [Sección 2.1 del RFC de HTTP](https://tools.ietf.org/html/rfc1123#section-2).
diff --git a/translations/es-ES/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md b/translations/es-ES/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md
index d910032fec30..002671e9ef1a 100644
--- a/translations/es-ES/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md
+++ b/translations/es-ES/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md
@@ -78,6 +78,14 @@ Los propietarios de las empresas pueden configurar los correos electrónicos par
 
 Puedes requerir el cifrado de TLS para todas las conexiones entrantes de SMTP, lo cual puede ayudar a satisfacer un requisito de certificación ISO-27017.
 
+{%- ifversion ghes = 3.6 %}
+{% note %}
+
+**Note**: Enforcement of TLS for SMTP connections is unavailable in {% data variables.product.product_name %} 3.6.0. The feature will be available in an upcoming release.
+
+{% endnote %}
+{%- endif %}
+
 {% data reusables.enterprise_site_admin_settings.email-settings %}
 1. Debajo de "Autenticación", selecciona **requerir la autenticación con TLS (recomendado)**.
 
diff --git a/translations/es-ES/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md b/translations/es-ES/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md
index e074b64fd8d5..5bd322dcae97 100644
--- a/translations/es-ES/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md
+++ b/translations/es-ES/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md
@@ -131,46 +131,49 @@ Key             | Description
 {% ifversion ghes %}
 ## Indexing
 
-GitHub's [code search][] features are powered by [ElasticSearch][]. This section of the site admin dashboard shows you the current status of your ElasticSearch cluster and provides you with several tools to control the behavior of searching and indexing. These tools are split into the following three categories.
+GitHub's search features are powered by Elasticsearch. This section of the site admin dashboard shows you the current status of your Elasticsearch cluster and provides you with several tools to control search and index behavior.
 
-  [Code Search]: https://github.com/blog/1381-a-whole-new-code-search
-  [ElasticSearch]: http://www.elasticsearch.org/
+For more information about code search, see "[Searching for information on {% data variables.product.prodname_dotcom %}](/search-github)." For more information about Elasticsearch, see the [Elasticsearch website](https://elastic.co).
 
-### Code search
+{% note %}
 
-This allows you to enable or disable both search and index operations on source code.
+**Note**: In normal use, site administrators do not need to create new indices or schedule repair jobs. For troubleshooting or other support purposes, {% data variables.contact.github_support %} may instruct you to run a repair job.
 
-### Code search index repair
+{% endnote %}
 
-This controls how the code search index is repaired. You can
+### Index management
 
-- enable or disable index repair jobs
-- start a new index repair job
-- reset all index repair state
+{% data variables.product.product_name %} reconciles the state of the search index with data on the instance automatically and regularly.
 
-{% data variables.product.prodname_enterprise %} uses repair jobs to reconcile the state of the search index with data stored in a database (issues, pull requests, repositories, and users) and data stored in Git repositories (source code). This happens when
+- Issues, pull requests, repositories, and users in the database
+- Git repositories (source code) on disk
 
-- a new search index is created;
-- missing data needs to be backfilled; or
-- old search data needs to be updated.
+Your instance uses repair jobs to reconcile the data, and schedules a repair job in the background when the following events occur.
 
-In other words, repair jobs are started as needed and run in the background—they are not scheduled by site admins in any way.
+- A new search index is created.
+- Missing data needs to be backfilled.
+- Old search data needs to be updated.
 
-Furthermore, repair jobs use a "repair offset" for parallelization. This is an offset into the database table for the record being reconciled. Multiple background jobs can synchronize work based on this offset.
+You can create a new index, or you can click on an existing index in the list to manage the index. You can perform the following operations on an index.
 
-A progress bar shows the current status of a repair job across all of its background workers. It is the percentage difference of the repair offset with the highest record ID in the database. Don't worry about the value shown in the progress bar after a repair job has completed: because it shows the difference between the repair offset and the highest record ID in the database, it will decrease as more repositories are added to {% data variables.product.product_location %} even though those repositories are actually indexed.
+- Make the index searchable.
+- Make the index writable.
+- Update the index.
+- Delete the index
+- Reset the index repair state.
+- Start a new index repair job.
+- Enable or disable index repair jobs.
 
-You can start a new code-search index repair job at any time. It will use a single CPU as it reconciles the search index with database and Git repository data. To minimize the effects this will have on I/O performance and reduce the chances of operations timing out, try to run a repair job during off-peak hours first. Monitor your system's load averages and CPU usage with a utility like `top`; if you don't notice any significant changes, it should be safe to run an index repair job during peak hours, as well.
+A progress bar shows the current status of a repair job across background workers. The bar is the percentage difference of the repair offset with the highest record ID in the database. You can ignore the value shown in the progress bar after a repair job has completed. The progress bar shows the difference between the repair offset and the highest record ID in the database, and will decrease as more repositories are added to {% data variables.product.product_location %} even though those repositories are actually indexed.
 
-### Issues index repair
+To minimize the effects on I/O performance and reduce the chances of operations timing out, run the repair job during off-peak hours. As the job reconciles the search index with database and Git repository data, one CPU will be used. Monitor your system's load averages and CPU usage with a utility like `top`. If you don't notice any significant increase in resource consumption, it should also be safe to run an index repair job during peak hours.
 
-This controls how the [Issues][] index is repaired. You can
+Repair jobs use a "repair offset" for parallelization. This is an offset into the database table for the record being reconciled. Multiple background jobs can synchronize work based on this offset.
 
-  [Issues]: https://github.com/blog/831-issues-2-0-the-next-generation
+### Code search
+
+This allows you to enable or disable both search and index operations on source code.
 
-- enable or disable index repair jobs
-- start a new index repair job
-- reset all index repair state
 {% endif %}
 ## Reserved logins
 
diff --git a/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md b/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md
index 7d0fbc474cf2..65b19263129a 100644
--- a/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md
+++ b/translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md
@@ -83,7 +83,7 @@ Puedes crear un grupo de ejecutores para administrar el acceso al ejecutor que a
 
 {% data variables.product.product_name %} agrega a todos los ejecutores nuevos a un grupo. Los ejecutores pueden estar en solo un grupo a la vez. Predeterminadamente, {% data variables.product.product_name %} agrega ejecutores nuevos al grupo "Predeterminado".
 
-{% data reusables.actions.self-hosted-runner-groups-add-to-enterprise-first-steps %}
+{% data reusables.actions.runner-groups-add-to-enterprise-first-steps %}
 1. Para elegir una política para el acceso de la organización, debajo de "Acceso de la organización", selecciona el menú desplegable **Acceso de la organización** y haz clic en **Organizaciones selectas**.
 1. A la derecha del menú desplegable con la política de acceso de la organización, haz clic en {% octicon "gear" aria-label="The Gear icon" %}.
 1. Selecciona las organizaciones a las cuales te gustaría otorgar acceso al grupo de ejecutores.
@@ -100,7 +100,7 @@ Puedes crear un grupo de ejecutores para administrar el acceso al ejecutor que a
 
    {% endwarning %}
 {%- endif %}
-{% data reusables.actions.self-hosted-runner-create-group %}
+{% data reusables.actions.create-runner-group %}
 {%- ifversion ghec or ghes > 3.3 or ghae-issue-5091 %}
 1. Haz clic en la pestaña de "Ejecutores".
 1. En la lista de ejecutores, haz clic en aquél que hayas desplegado en la sección previa.
diff --git a/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise.md b/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise.md
index 08e78eea12df..0582e6ab1ceb 100644
--- a/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise.md
+++ b/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise.md
@@ -82,11 +82,11 @@ Estas restricciones no son aceptables para algunas empresas. Para determinar si
 
 ### ¿Tus desarrolladores confían en la colaboración fuera de tu empresa?
 
-{% data variables.product.prodname_managed_users_caps %} solo puede contribuir con los repositorios dentro de tu empresa. If your developers must contribute to both repositories within and outside of your enterprise, including private repositories, {% data variables.product.prodname_emus %} may not be right for your enterprise. SAML SSO may be a better solution.
+{% data variables.product.prodname_managed_users_caps %} solo puede contribuir con los repositorios dentro de tu empresa. Si tus desarrolladores deben contribuir con ambos repositorios dentro y fuera de tu empresa, incluyendo a los repositorios privados, {% data variables.product.prodname_emus %} podría no ser lo correcto para tu empresa. El SSO de SAML podría ser una mejor solución.
 
-Some companies maintain repositories within an existing enterprise using SAML SSO on {% data variables.product.product_location %}, and also create an {% data variables.product.prodname_emu_enterprise %}. Developers who contribute to repositories owned by both enterprises from a single workstation must switch between the accounts on {% data variables.product.product_location %} within a single browser, or use a different browser for each account. The developer may also need to customize the workstation's Git configuration to accommodate the two accounts. The complexity of this workflow can increase the risk of mistakenly leaking internal code to the public.
+Algunas empresas mantienen repositorios dentro de una empresa existente utilizando el SSO de SAML en {% data variables.product.product_location %} y también crean una {% data variables.product.prodname_emu_enterprise %}. Los desarrolladores que contribuyen con los repositorios que le pertenecen a ambas empresas desde una estación de trabajo única deben cambiar entre las cuentas de {% data variables.product.product_location %} dentro de un solo buscador o utilizar un buscador diferente para cada cuenta. El desarrollador también podría necesitar personalizar la configuración de Git de la estación de trabajo para acomodar las dos cuentas. La complejidad de este flujo de trabajo puede incrementar el riesgo de filtrar el código interno al público por accidente.
 
-If you decide to create an {% data variables.product.prodname_emu_enterprise %} but require that developers contribute to resources outside of the enterprise from a single workstation, you can provide support for switching between the accounts in a developer's local Git configuration. Para obtener más información, consulta la sección "[Acerca de {% data variables.product.prodname_emus %}](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#supporting-developers-with-multiple-user-accounts-on-githubcom)".
+Si decides crear una {% data variables.product.prodname_emu_enterprise %} pero necesitas que los desarrolladores contribuyan con los recursos fuera de la empresa desde una sola estación de trabajo, puedes proporcionar compatibilidad para cambiar entre las cuentas de una configuración local de Git del desarrollador. Para obtener más información, consulta la sección "[Acerca de {% data variables.product.prodname_emus %}](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#supporting-developers-with-multiple-user-accounts-on-githubcom)".
 
 ### ¿Tu empresa depende de colaboradores externos?
 
@@ -125,7 +125,7 @@ Si utilizas un directorio o proveedor de identidad (IdP) externos para centraliz
 - "[Utilizar LDAP para el IAM empresarial](/admin/identity-and-access-management/using-ldap-for-enterprise-iam)"
 - "[Utilizar SAML para el IAM empresarial](/admin/identity-and-access-management/using-saml-for-enterprise-iam)"
 
-Si eliges utilizar la autenticación externa, también puedes configurar la autenticación reversible para las personas que no tiene una cuenta en tu proveedor de autenticación externo. Por ejemplo, podrías querer otorgar acceso a un usuario máquina o a un contratista. For more information, see "[Allowing built-in authentication for users outside your provider](/admin/identity-and-access-management/managing-iam-for-your-enterprise/allowing-built-in-authentication-for-users-outside-your-provider)."
+Si eliges utilizar la autenticación externa, también puedes configurar la autenticación reversible para las personas que no tiene una cuenta en tu proveedor de autenticación externo. Por ejemplo, podrías querer otorgar acceso a un usuario máquina o a un contratista. Para obtener más información, consulta la sección "[Permitir la autenticación integrada para los usuarios fuera de tu proveedor](/admin/identity-and-access-management/managing-iam-for-your-enterprise/allowing-built-in-authentication-for-users-outside-your-provider)".
 
 {% elsif ghae %}
 
diff --git a/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/changing-authentication-methods.md b/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/changing-authentication-methods.md
index cf63cbeb215c..c43aea77bd17 100644
--- a/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/changing-authentication-methods.md
+++ b/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/changing-authentication-methods.md
@@ -40,4 +40,4 @@ Otras cuestiones que deberías tener en cuenta son las siguientes:
 
 * **Autenticación de dos factores:** {% data reusables.enterprise_user_management.external_auth_disables_2fa %}
 
-* **Fallback authentication for users with no account on your external authentication provider:** You can invite users to authenticate to {% data variables.product.product_location %} without adding them to your identity provider. For more information, see "[Allowing built-in authentication for users outside your provider](/admin/identity-and-access-management/managing-iam-for-your-enterprise/allowing-built-in-authentication-for-users-outside-your-provider)."
+* **Autenticación de segunda opción para los usuarios que no tienen una cuenta en tu proveedor de autenticación externa:** Puedes invitar a los usuarios para que se autentiquen en {% data variables.product.product_location %} sin agregarlos a tu proveedor de identidad. Para obtener más información, consulta la sección "[Permitir la autenticación integrada para los usuarios fuera de tu proveedor](/admin/identity-and-access-management/managing-iam-for-your-enterprise/allowing-built-in-authentication-for-users-outside-your-provider)".
diff --git a/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/troubleshooting-identity-and-access-management-for-your-enterprise.md b/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/troubleshooting-identity-and-access-management-for-your-enterprise.md
index 8a0bc59ed18e..1ffcbea270d1 100644
--- a/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/troubleshooting-identity-and-access-management-for-your-enterprise.md
+++ b/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/troubleshooting-identity-and-access-management-for-your-enterprise.md
@@ -23,7 +23,7 @@ topics:
 {% ifversion ghec %}
 ## Errors when switching authentication configurations
 
-If you're experiencing problems while switching between different authentication configurations, such as changing your SAML SSO configuration from an organization to an enterprise account or migrating from SAML to OIDC for {% data variables.product.prodname_emus %}, ensure you're following our best practices for the change.
+Si estás teniendo problemas al cambiar entre las diferentes configuraciones de autenticación, tales como cambiar tu configuración del SSO de SAML de una organización a una cuenta empresarial o migrándote de SAML a OIDC para las {% data variables.product.prodname_emus %}, asegúrate de estar siguiendo nuestras mejores prácticas para dicho cambio.
 
 - "[Switching your SAML configuration from an organization to an enterprise account](/admin/identity-and-access-management/using-saml-for-enterprise-iam/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account)"
 - "[Migrating from SAML to OIDC](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc)"
diff --git a/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication.md b/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication.md
index 467df68ece74..0e5cba2071d6 100644
--- a/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication.md
+++ b/translations/es-ES/content/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication.md
@@ -1,6 +1,6 @@
 ---
-title: Username considerations for external authentication
-shortTitle: Username considerations
+title: Consideraciones de nombre de usuario para la autenticación externa
+shortTitle: Consideraciones de nombre de usuario
 intro: '{% ifversion ghes or ghec %}Cuando utilizas {% ifversion ghes %}CAS, LDAP o SAML para la autenticación{% elsif ghec %}{% data variables.product.prodname_emus %}{% endif %}, {% endif %}{% data variables.product.product_name %} sigue reglas específicas para determinar el nombre de usuario de cada cuenta de usuario {% ifversion ghec or ghae %}en tu empresa{% elsif ghes %}en tu instancia{% endif %}.'
 miniTocMaxHeadingLevel: 3
 versions:
@@ -19,62 +19,62 @@ topics:
 {% ifversion ghec %}
 {% note %}
 
-**Note:** This article only applies to {% data variables.product.prodname_emus %}. If you use {% data variables.product.prodname_ghe_cloud %} without {% data variables.product.prodname_emus %}, usernames are created by users, not {% data variables.product.prodname_dotcom %}.
+**Nota:** Este artículo solo aplica a {% data variables.product.prodname_emus %}. Si tuilizas {% data variables.product.prodname_ghe_cloud %} sin {% data variables.product.prodname_emus %}, los usuarios crearán sus nombres de usuario y no {% data variables.product.prodname_dotcom %}.
 
 {% endnote %}
 {% endif %}
 
-## About usernames with external authentication
+## Acerca de los nombres de usuario con autenticación externa
 
 {% ifversion ghes %}
 
-You can configure external authentication for {% data variables.product.product_name %} using CAS, LDAP, or SAML. Para obtener más información, consulta la sección "[Acerca de la autenticación para tu empresa](/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise#authentication-methods-for-github-enterprise-server)".
+Puedes configurar la autenticación externa para {% data variables.product.product_name %} utilizando CAS, LDAP o SAML. Para obtener más información, consulta la sección "[Acerca de la autenticación para tu empresa](/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise#authentication-methods-for-github-enterprise-server)".
 
-When you use external authentication, {% data variables.product.product_location %} automatically creates a username for each person when the person signs into {% data variables.product.product_location %} through your external authentication system for the first time.
+Cuando utilizas autenticación externa, {% data variables.product.product_location %} crea automáticamente un nombre de usuario para cada persona cuando inician sesión en {% data variables.product.product_location %} mediante tu sistema de autenticación externa para la primera ocasión.
 
 {% elsif ghec %}
 
-If you use an enterprise with {% data variables.product.prodname_emus %}, members of your enterprise authenticate to access {% data variables.product.prodname_dotcom %} through your SAML identity provider (IdP). Para obtener más información, consulta las secciones"[Acerca de las {% data variables.product.prodname_emus %}](/admin/identity-and-access-management/using-enterprise-managed-users-and-saml-for-iam/about-enterprise-managed-users)" y "[Acerca de la autenticación para tu empresa](/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise#authentication-methods-for-github-enterprise-server)".
+Si utilizas una empresa con {% data variables.product.prodname_emus %}, los miembros de tu empresa se autentican para acceder a {% data variables.product.prodname_dotcom %} mediante tu proveedor de identidad (IdP) de SAML. Para obtener más información, consulta las secciones"[Acerca de las {% data variables.product.prodname_emus %}](/admin/identity-and-access-management/using-enterprise-managed-users-and-saml-for-iam/about-enterprise-managed-users)" y "[Acerca de la autenticación para tu empresa](/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise#authentication-methods-for-github-enterprise-server)".
 
-{% data variables.product.product_name %} automatically creates a username for each person when their user account is provisioned via SCIM, by normalizing an identifier provided by your IdP. If multiple identifiers are normalized into the same username, a username conflict occurs, and only the first user account is created. You can resolve username conflicts by making a change in your IdP so that the normalized usernames will be unique.
+{% data variables.product.product_name %} crea automáticamente un nombre de usuario para cada persona cuando su cuenta de usuario se aprovisiona a través de SCIM mediante la normalización de un identificador que proporciona tu IdP. Si se normalizan identificadores múltiples en el mismo nombre de usuario, ocurrirá un conflicto de nombre de usuario y solo se creará la primera cuenta de usuario. Puedes resolver conflictos de nombre de usuario haciendo un cambio en tu IdP para que los nombres de usuario normalizados sean únicos.
 
 {% elsif ghae %}
 
-{% data variables.product.product_name %} uses SAML SSO for authentication, and automatically creates a username for each person when the person signs in through your identity provider (IdP) for the first time.
+{% data variables.product.product_name %} utiliza el SSO de SAML para la autenticación y crea automáticamente un nombre de usuario para cada persona cuando esta inicia sesión mediante tu proveedor de identidad (IdP) por primera vez.
 
 {% endif %}
 
 {% ifversion ghec %}
-## About usernames for {% data variables.product.prodname_managed_users %}
+## Acerca de los nombres de usuario para {% data variables.product.prodname_managed_users %}
 
-When your {% data variables.product.prodname_emu_enterprise %} is created, you will choose a short code that will be used as the suffix for your enterprise members' usernames. {% data reusables.enterprise-accounts.emu-shortcode %} El usuario de configuración que configure el SSO de SAML tendrá un nombre de usuario en el formato **@SHORT-CODE_admin**.
+Cuando se crea tu {% data variables.product.prodname_emu_enterprise %}, debes elegir un código corto que se utilizará como el sufijo para los nombres de usuario de los miembros de tu empresa. {% data reusables.enterprise-accounts.emu-shortcode %} El usuario de configuración que configure el SSO de SAML tendrá un nombre de usuario en el formato **@SHORT-CODE_admin**.
 
-Cuando aprovisionas un usuario nuevo desde tu proveedor de identidad, el {% data variables.product.prodname_managed_user %} nuevo tendrá un nombre de usuario de {% data variables.product.prodname_dotcom %} en el formato de **@IDP-USERNAME_SHORT-CODE**. The IDP-USERNAME component is formed by normalizing the SCIM `userName` attribute value sent from the IdP.
+Cuando aprovisionas un usuario nuevo desde tu proveedor de identidad, el {% data variables.product.prodname_managed_user %} nuevo tendrá un nombre de usuario de {% data variables.product.prodname_dotcom %} en el formato de **@IDP-USERNAME_SHORT-CODE**. El componente IDP-USERNAME se forma normalizando el valor de atributo de SCIM `userName` que se envía desde el IdP.
 
 | Proveedor de identidad            | Nombre de usuario de {% data variables.product.prodname_dotcom %}
-| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Azure Active Directory (Azure AD) | _IDP-USERNAME_ is formed by normalizing the characters preceding the `@` character in the UPN (User Principal Name), which does not include the `#EXT#` for guest accounts. |
-| Okta                              | _IDP-USERNAME_ is the normalized username attribute provided by the IdP.                                                                                                    |
+| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Azure Active Directory (Azure AD) | _IDP-USERNAME_ se conforma al normalizar los caracteres que preceden al carácter `@` en el UPN (Nombre Principal de Usuario), el cual no incluye el `#EXT#` para las cuentas de invitado. |
+| Okta                              | _IDP-USERNAME_ es el atributo de nombre de usuario normalizado que proporciona el IdP.                                                                                                    |
 
-These rules may result in your IdP providing the same _IDP-USERNAME_ for multiple users. For example, for Azure AD, the following UPNs will result in the same username:
+Estas reglas podrían dar como resultado que tu IdP proporcione la misma _IDP-USERNAME_ para varios usuarios. Por ejemplo, para Azure AD, las siguientes UPN darán como resultado el mismo nombre de usuario:
 
 - `bob@contoso.com`
 - `bob@fabrikam.com`
 - `bob#EXT#fabrikamcom@contoso.com`
 
-This will cause a username conflict, and only the first user will be provisioned. For more information, see "[Resolving username conflicts](#resolving-username-conflicts)."
+Esto ocasionará un conflicto de nombre de usuario y solo el primero se aprovisionará. Para obtener más información, consulta la sección "[Resolver conflictos de nombre de usuario](#resolving-username-conflicts)".
 {% endif %}
 
-Usernames{% ifversion ghec %}, including underscore and short code,{% endif %} must not exceed 39 characters.
+Los nombres de usuario{% ifversion ghec %}, incluyendo los guiones bajos y el código corto,{% endif %} no deben ser de más de 39 caracteres.
 
-## About username normalization
+## Acerca de la normalización de nombres de usuario
 
 Usernames for user accounts on {% ifversion ghes or ghae %}{% data variables.product.product_name %}{% elsif ghec %}{% data variables.product.prodname_dotcom_the_website %}{% endif %} can only contain alphanumeric characters and dashes (`-`).
 
 {% ifversion ghec %}
 When you configure SAML authentication, {% data variables.product.product_name %} uses the SCIM `userName` attribute value sent from the IdP to determine the username for the corresponding user account on {% data variables.product.prodname_dotcom_the_website %}. If this value includes unsupported characters, {% data variables.product.product_name %} will normalize the username per the following rules.
 {% elsif ghes %}
-When you configure CAS, LDAP, or SAML authentication, {% data variables.product.product_name %} uses an identifier from the user account on your external authentication provider to determine the username for the corresponding user account on {% data variables.product.product_name %}. If the identifier includes unsupported characters, {% data variables.product.product_name %} will normalize the username per the following rules.
+Cuando configuras la autenticación de CAS, LDAP o SAML, {% data variables.product.product_name %} utiliza un identificador de la cuenta de usuario en tu proveedor de autenticación externo para determinar el nombre de usuario de la cuenta de usuario correspondiente en {% data variables.product.product_name %}. If the identifier includes unsupported characters, {% data variables.product.product_name %} will normalize the username per the following rules.
 {% elsif ghae %}
 When you configure SAML authentication, {% data variables.product.product_name %} uses an identifier from the user account on your IdP to determine the username for the corresponding user account on {% data variables.product.product_name %}. Si el identificador incluye caracteres no compatibles, {% data variables.product.product_name %} normalizará el nombre de usuario de acuerdo con las siguientes reglas.
 {% endif %}
@@ -100,7 +100,7 @@ When you configure SAML authentication, {% data variables.product.product_name %
 {% ifversion not ghec %}
 ### About username normalization with SAML
 
-{% ifversion ghes %}If you configure SAML authentication for {% data variables.product.product_location %}, {% endif %}{% data variables.product.product_name %} determines each person's username by one of the following assertions in the SAML response, ordered by descending priority.
+{% ifversion ghes %}Si configuras la autenticación de SAML para {% data variables.product.product_location %}, {% endif %}{% data variables.product.product_name %} determina el nombre de cada persona mediante una de las siguientes aserciones en la respuesta de SAML, ordenado por prioridad de forma descendente.
 
 1. The custom `username` attribute, if defined and present
 1. Una aserción `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name`, si hay una.
@@ -153,5 +153,5 @@ To resolve username conflicts in Okta, update the attribute mapping settings for
 1. In Okta, open the {% data variables.product.prodname_emu_idp_application %} application.
 1. Haz clic en **Iniciar sesión**.
 1. In the "Settings" section, click **Edit**.
-1. Update the "Application username format."
+1. Actualiza el "formato de aplicación de nombre de usuario".
 {% endif %}
diff --git a/translations/es-ES/content/admin/identity-and-access-management/using-cas-for-enterprise-iam/using-cas.md b/translations/es-ES/content/admin/identity-and-access-management/using-cas-for-enterprise-iam/using-cas.md
index 0743a56c7f29..d33d0b7be0b8 100644
--- a/translations/es-ES/content/admin/identity-and-access-management/using-cas-for-enterprise-iam/using-cas.md
+++ b/translations/es-ES/content/admin/identity-and-access-management/using-cas-for-enterprise-iam/using-cas.md
@@ -8,7 +8,7 @@ redirect_from:
   - /admin/authentication/using-cas
   - /enterprise/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance/using-cas
   - /admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-cas
-intro: 'If you use Central Authentication Service (CAS) to centralize access to multiple web applications, you can integrate {% data variables.product.product_name %} by configuring CAS authentication for your instance.'
+intro: 'Si utilizas el Servicio de Autenticación Central (CAS) para centralizar el acceso a diversas aplicaciones web, puedes integrar a {% data variables.product.product_name %} configurando la autenticación de CAS para tu instancia.'
 versions:
   ghes: '*'
 type: how_to
@@ -20,13 +20,13 @@ topics:
   - SSO
 ---
 
-## About CAS authentication for {% data variables.product.product_name %}
+## Acerca de la autenticación de CAS para {% data variables.product.product_name %}
 
-CAS is a single sign-on (SSO) protocol that centralizes authentication to multiple web applications. For more information, see "[Central Authentication Service](https://en.wikipedia.org/wiki/Central_Authentication_Service)" on Wikipedia.
+CAS es un protocolo de inicio de sesión única (SSO) que centraliza la autenticación a varias aplicaciones web. Para obtener más información, consulta "[Central Authentication Service](https://en.wikipedia.org/wiki/Central_Authentication_Service)" en Wikipedia.
 
-After you configure CAS, people who use {% data variables.product.product_location %} must use a personal access token to authenticate API or Git requests over HTTP(S). CAS credentials cannot be used to authenticate these requests. Para obtener más información, consulta la sección "[Crear un token de acceso personal](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)".
+Después de que configuras CAS, las personas que utilizan {% data variables.product.product_location %} debe utilizar un token de acceso personal para autenticar la API o las solicitudes de Git sobre HTTP(S). Las credenciales de CAS no pueden utilizarse para autenticar estas solicitudes. Para obtener más información, consulta la sección "[Crear un token de acceso personal](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)".
 
-If you configure CAS, people with accounts on your identity provider (IdP) do not consume a user license until the person signs into {% data variables.product.product_location %}.
+Si configuras CAS, las personas con cuentas en tu proveedor de identidad (IdP) no consumen una licencia de usuario sino hasta que la persona inicie sesión en {% data variables.product.product_location %}.
 
 {% data reusables.enterprise_user_management.built-in-authentication %}
 
@@ -49,8 +49,8 @@ Están disponibles los siguientes atributos.
 {% data reusables.enterprise_management_console.authentication %}
 3. Selecciona **CAS**.
 
-   ![Screenshot of selection of CAS for authentication](/assets/images/enterprise/management-console/cas-select.png)
+   ![Captura de pantalla de la selección de CAS para la autenticación](/assets/images/enterprise/management-console/cas-select.png)
 4. {% data reusables.enterprise_user_management.built-in-authentication-option %}
 
-   ![Screenshot of of fallback built-in authentication option for CAS](/assets/images/enterprise/management-console/cas-built-in-authentication.png)
+   ![Captura de pantalla de segunda opción de autenticación integrada para CAS](/assets/images/enterprise/management-console/cas-built-in-authentication.png)
 5. En el campo **URL del servidor**, escribe la URL completa de tu servidor CAS. Si tu servidor CAS usa un certificado que no puede ser validado por {% data variables.product.prodname_ghe_server %}, puedes usar el comando `ghe-ssl-ca-certificate-install` para instalarlo como un certificado de confianza. Para obtener más información, consulta la sección "[Utilidades de línea de comandos](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-ssl-ca-certificate-install)".
diff --git a/translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md b/translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md
index 74460a7bf10f..b24cbb3525ba 100644
--- a/translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md
+++ b/translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md
@@ -42,7 +42,7 @@ Para utilizar los {% data variables.product.prodname_emus %}, necesitas un tipo
 
 {% note %}
 
-**Note:** There are multiple options for identity and access management with {% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_emus %} is not the best solution for every customer. For more information about whether {% data variables.product.prodname_emus %} is right for your enterprise, see "[About authentication for your enterprise](/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise#identifying-the-best-authentication-method-for-your-enterprise)."
+**Note:** There are multiple options for identity and access management with {% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_emus %} is not the best solution for every customer. Para obtener más información sobre si las {% data variables.product.prodname_emus %} son correctas para tu empresa, consulta la sección "[Acerca de la autenticación para tu empresa](/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise#identifying-the-best-authentication-method-for-your-enterprise)".
 
 {% endnote %}
 
diff --git a/translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md b/translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md
index ebd76a968f9f..e2c8a03c3ee2 100644
--- a/translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md
+++ b/translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-support-for-your-idps-conditional-access-policy.md
@@ -24,7 +24,7 @@ Para obtener más información sobre cómo utilizar OIDC con {% data variables.p
 
 {% note %}
 
-**Note:** If you use Conditional Access (CA) network location policies in your Azure AD tenant, do not use the IP allow list feature on {% data variables.product.prodname_dotcom_the_website %}, with your enterprise account or with any of the organizations owned by the enterprise. Using both is unsupported and can result in the wrong policy applying. For more information about IP allow lists, see "[Enforcing security settings in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-allowed-ip-addresses-for-organizations-in-your-enterprise)" and "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization)."
+**Note:** If you use Conditional Access (CA) network location policies in your Azure AD tenant, do not use the IP allow list feature on {% data variables.product.prodname_dotcom_the_website %}, with your enterprise account or with any of the organizations owned by the enterprise. Using both is unsupported and can result in the wrong policy applying. Para obtener más información acerca de las listas de direcciones IP permitidas, consulta las secciones "[Requerir ajustes de seguridad en tu empresa](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-allowed-ip-addresses-for-organizations-in-your-enterprise)" y "[Administrar direcciones IP permitidas en tu organización](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization)".
 
 {% endnote %}
 
diff --git a/translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md b/translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md
index 3b52fa9453ed..bc479a0b8b11 100644
--- a/translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md
+++ b/translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/migrating-from-saml-to-oidc.md
@@ -31,7 +31,7 @@ If you're new to {% data variables.product.prodname_emus %} and haven't yet conf
 {% endnote %}
 
 1. Before you begin the migration, sign in to Azure and disable provisioning in the existing {% data variables.product.prodname_emu_idp_application %} application.
-1. If you use [Conditional Access (CA) network location policies](https://docs.microsoft.com/en-us/azure/active-directory/conditional-access/location-condition) in Azure AD, and you're currently using an IP allow list with your enterprise account or any of the organizations owned by the enterprise account on {% data variables.product.prodname_dotcom_the_website %}, disable the IP allow lists. For more information, see "[Enforcing security settings in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-allowed-ip-addresses-for-organizations-in-your-enterprise)" and "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization)."
+1. Si utilizas [Políticas de ubicación de red con Acceso Condicional (CA)](https://docs.microsoft.com/en-us/azure/active-directory/conditional-access/location-condition) en Azure AD y actualmente utilizas una lista de direcciones IP permitidas con tu cuenta empresarial o con cualquier organización que le pertenezca a la cuenta empresarial en {% data variables.product.prodname_dotcom_the_website %}, inhabilita las listas de direcciones IP permitidas. Para obtener más información, consulta las secciones "[Requerir ajustes de seguridad en tu empresa](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise#managing-allowed-ip-addresses-for-organizations-in-your-enterprise)" y "[Administrar direcciones IP permitidas en tu organización](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization)".
 1.  Sign into {% data variables.product.prodname_dotcom_the_website %} as the setup user for your enterprise with the username **@SHORT-CODE_admin**.
 1. When prompted to continue to your identity provider, click **Use a recovery code** and sign in using one of your enterprise's recovery codes.
 {% data reusables.enterprise-accounts.access-enterprise %}
diff --git a/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md b/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md
index c846099ee099..38178d2800e4 100644
--- a/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md
+++ b/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md
@@ -1,6 +1,6 @@
 ---
 title: Configurar la autenticación y el aprovisionamiento para tu empresa utilizando Azure AD
-shortTitle: Configure with Azure AD
+shortTitle: Configurar con Azure AD
 intro: 'Puedes utilizar un inquilino en Azure Active Directory (Azure AD) como proveedor de identidad (IdP) para administrar centralmente la autenticación y el aprovisionamiento de usuarios para {% data variables.product.product_location %}.'
 permissions: 'Enterprise owners can configure authentication and provisioning for an enterprise on {% data variables.product.product_name %}.'
 versions:
diff --git a/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-for-your-enterprise.md b/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-for-your-enterprise.md
index 7800bccfd9b3..1f7a1307b83f 100644
--- a/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-for-your-enterprise.md
+++ b/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-for-your-enterprise.md
@@ -1,6 +1,6 @@
 ---
 title: Configurar el aprovisionamiento de usuarios para tu empresa
-shortTitle: Configure user provisioning
+shortTitle: Configurar el aprovisionamiento de usuarios
 intro: 'Puedes configurar el Sistema para la Administración de Identidad entre Dominios (SCIM) para tu empresa, el cual aprovisiona las cuentas de usuario automáticamente en {% data variables.product.product_location %} cuando asignas la aplicación para {% data variables.product.product_location %} a un usuario en tu proveedor de identidad (IdP).'
 permissions: 'Enterprise owners can configure user provisioning for an enterprise on {% data variables.product.product_name %}.'
 versions:
@@ -21,9 +21,9 @@ redirect_from:
 
 {% data reusables.saml.ae-uses-saml-sso %} Para obtener más información, consulta la sección "[Configurar el incio de sesión único de SAML para tu empresa](/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise)".
 
-You can configure user provisioning with SCIM to automatically create or suspend user accounts and grant access for {% data variables.product.product_name %} when you assign or unassign the application on your IdP. For more information about SCIM, see [System for Cross-domain Identity Management: Protocol (RFC 7644)](https://tools.ietf.org/html/rfc7644) on the IETF website.
+Puedes configurar el aprovisionamiento de usuarios con SCIM para crear o suspender cuentas de usuario automáticamente y obetner acceso para {% data variables.product.product_name %} cuando asignes o desasignes la aplicación en tu IdP. Para obtener más información sobre el SCIM, consulta [System for Cross-domain Identity Management: Protocol (RFC 7644)](https://tools.ietf.org/html/rfc7644) en el sitio web de IETF.
 
-If you do not configure user provisioning with SCIM, your IdP will not communicate with {% data variables.product.product_name %} automatically when you assign or unassign the application to a user. Without SCIM, {% data variables.product.product_name %} creates a user account using SAML Just-in-Time (JIT) provisioning the first time someone navigates to {% data variables.product.product_name %} and signs in by authenticating through your IdP.
+Si no configuras el aprovisionamiento de usuarios con SCIM, tu IdP no se comunicará automáticamente con {% data variables.product.product_name %} cuando asignes o desasignes la aplicación a un usuario. Sin SCIM, {% data variables.product.product_name %} crea una cuenta de usuario utilizando el aprovisionamiento SAML Just-in-Time (JIT) la primera vez que alguien navegue a {% data variables.product.product_name %} e inicie sesión autenticándose a través de tu IdP.
 
 Configurar el aprovisionamiento le permite a tu IdP comunicarse con {% data variables.product.product_location %} cuando asignas o desasignas la aplicación para {% data variables.product.product_name %} a un usuario en tu IdP. Cuando asignas la aplicación, tu IdP pedirá que {% data variables.product.product_location %} cree una cuenta y enviará un correo electrónico de incorporación al usuario. Cuando desasignas la aplicación, tu IdP se comunicará con {% data variables.product.product_name %} para invalidad cualquier sesión de SAML e inhabilitar la cuenta del miembro.
 
diff --git a/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/mapping-okta-groups-to-teams.md b/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/mapping-okta-groups-to-teams.md
index 4d05b3a42a94..572265309c63 100644
--- a/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/mapping-okta-groups-to-teams.md
+++ b/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/mapping-okta-groups-to-teams.md
@@ -1,7 +1,7 @@
 ---
-title: Mapping Okta groups to teams
-shortTitle: Map Okta groups to teams
-intro: 'You can map your Okta groups to teams on {% data variables.product.prodname_ghe_managed %} to automatically add and remove team members.'
+title: Mapear los grupos de Okta a los equipos
+shortTitle: Mapear los grupos de Okta a los equipos
+intro: 'Puedes mapear tus grupos de Okta a los equipos en {% data variables.product.prodname_ghe_managed %} para que agreguen y eliminen a los miembros automáticamente.'
 permissions: 'Enterprise owners can configure authentication and provisioning for {% data variables.product.prodname_ghe_managed %}.'
 versions:
   ghae: '*'
@@ -19,9 +19,9 @@ topics:
 
 {% data reusables.saml.okta-ae-sso-beta %}
 
-## About team mapping
+## Acerca del mapeo de equipos
 
-If you use Okta as your IdP, you can map your Okta group to a team in {% data variables.product.prodname_ghe_managed %}. Members of the Okta group will automatically become members of the mapped {% data variables.product.prodname_ghe_managed %} team. To configure this mapping, you can configure the Okta "GitHub AE" app to push the group and its members to {% data variables.product.prodname_ghe_managed %}. You can then choose which team in {% data variables.product.prodname_ghe_managed %} will be mapped to the Okta group.
+Si utilizas Okta como tu IdP, puedes mapear tu grupo de Okta a un equipo en {% data variables.product.prodname_ghe_managed %}. Members of the Okta group will automatically become members of the mapped {% data variables.product.prodname_ghe_managed %} team. To configure this mapping, you can configure the Okta "GitHub AE" app to push the group and its members to {% data variables.product.prodname_ghe_managed %}. You can then choose which team in {% data variables.product.prodname_ghe_managed %} will be mapped to the Okta group.
 
 ## Prerrequisitos
 
diff --git a/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md b/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md
index 2b8548d98f48..26ada0fd5c1c 100644
--- a/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md
+++ b/translations/es-ES/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md
@@ -75,12 +75,12 @@ The SP metadata for your enterprise on {% data variables.product.product_name %}
 
 The following SAML attributes are available for {% data variables.product.product_name %}.{% ifversion ghes %} You can change the attribute names in the management console, with the exception of the `administrator` attribute. For more information, see "[Accessing the management console](/admin/configuration/configuring-your-enterprise/accessing-the-management-console)."{% endif %}
 
-| Nombre                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | Required? | Descripción                                                                                                                                                                                                                                                                                                                                                                                     |
-|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |:--------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `ID del nombre`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Sí        | Un identificador de usuario persistente. Se puede usar cualquier formato de identificador de nombre persistente.                                                                                                                                                                                                                                                                                |
-| {% ifversion ghec %}If you use an enterprise with {% data variables.product.prodname_emus %}, {% endif %}{% data variables.product.product_name %} will normalize the `NameID` element to use as a username unless one of the alternative assertions is provided. For more information, see "[Username considerations for external authentication](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication)."

{% note %}**Note:** It's important to use a human-readable, persistent identifier. Using a transient identifier format like `urn:oasis:names:tc:SAML:2.0:nameid-format:transient` will result in re-linking of accounts on every sign-in, which can be detrimental to authorization management.{% endnote %} | | | -| | | | -| `SessionNotOnOrAfter` | No | The date that {% data variables.product.product_name %} invalidates the associated session. After invalidation, the person must authenticate once again to access {% ifversion ghec or ghae %}your enterprise's resources{% elsif ghes %}{% data variables.product.product_location %}{% endif %}. For more information, see "[Session duration and timeout](#session-duration-and-timeout)." | +| Nombre | Required? | Descripción | +|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |:--------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `ID del nombre` | Sí | Un identificador de usuario persistente. Se puede usar cualquier formato de identificador de nombre persistente. | +| {% ifversion ghec %}If you use an enterprise with {% data variables.product.prodname_emus %}, {% endif %}{% data variables.product.product_name %} will normalize the `NameID` element to use as a username unless one of the alternative assertions is provided. Para obtener más información, consulta la sección "[Consideraciones de nombre de usuario para la autenticación externa](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication)".

{% note %}**Nota:** Es importante utilizar un identificador persistente y legible para humanos. Using a transient identifier format like `urn:oasis:names:tc:SAML:2.0:nameid-format:transient` will result in re-linking of accounts on every sign-in, which can be detrimental to authorization management.{% endnote %} | | | +| | | | +| `SessionNotOnOrAfter` | No | The date that {% data variables.product.product_name %} invalidates the associated session. After invalidation, the person must authenticate once again to access {% ifversion ghec or ghae %}your enterprise's resources{% elsif ghes %}{% data variables.product.product_location %}{% endif %}. For more information, see "[Session duration and timeout](#session-duration-and-timeout)." | {%- ifversion ghes or ghae %} | `administrator` | No | When the value is `true`, {% data variables.product.product_name %} will automatically promote the user to be a {% ifversion ghes %}site administrator{% elsif ghae %}enterprise owner{% endif %}. Setting this attribute to anything but `true` will result in demotion, as long as the value is not blank. Omitting this attribute or leaving the value blank will not change the role of the user. | | `username` | No | The username for {% data variables.product.product_location %}. | {%- endif %} diff --git a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics.md b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics.md index bf573eb51626..7408d379410c 100644 --- a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics.md +++ b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics.md @@ -1,6 +1,6 @@ --- -title: About Server Statistics -intro: 'You can use {% data variables.product.prodname_server_statistics %} to analyze your own aggregate data from {% data variables.product.prodname_ghe_server %}, and help us improve {% data variables.product.company_short %} products.' +title: Acerca de las estadísitcas del servidor +intro: 'Puedes utilizar {% data variables.product.prodname_server_statistics %} para analizar tus propios datos agregados de {% data variables.product.prodname_ghe_server %} y ayudarnos a mejorar los productos de {% data variables.product.company_short %}.' versions: feature: server-statistics permissions: 'Enterprise owners can enable {% data variables.product.prodname_server_statistics %}.' @@ -10,11 +10,11 @@ topics: - Enterprise --- -## About the benefits of {% data variables.product.prodname_server_statistics %} +## Acerca de los beneficios de las {% data variables.product.prodname_server_statistics %} -{% data variables.product.prodname_server_statistics %} can help you anticipate the needs of your organization, understand how your team works, and show the value you get from {% data variables.product.prodname_ghe_server %}. +Las {% data variables.product.prodname_server_statistics %} pueden ayudarte a anticipar las necesidades de tu organización, entender cómo funciona tu equipo y mostrarte el valor que obtienes de {% data variables.product.prodname_ghe_server %}. -Once enabled, {% data variables.product.prodname_server_statistics %} collects aggregate data on how much certain features are used on your instance over time. Unlike other [Admin Stats API](/rest/reference/enterprise-admin#admin-stats) endpoints, which only return data for the last day, {% data variables.product.prodname_server_statistics %} provides historical data of all {% data variables.product.prodname_server_statistics %} metrics collected since the day you enabled the feature. Para obtener más información, consulta la sección "[Habilitar la {% data variables.product.prodname_server_statistics %} en tu empresa](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)". +Once enabled, {% data variables.product.prodname_server_statistics %} collects aggregate data on how much certain features are used on your instance over time. A diferencia de otras terminales de la [API de estadísticas administrativas](/rest/reference/enterprise-admin#admin-stats), las cuales solo devuelven datos del último día, {% data variables.product.prodname_server_statistics %} proporciona datos históricos de todas las métricas de {% data variables.product.prodname_server_statistics %} desde el día en el que habilitaste la característica. Para obtener más información, consulta la sección "[Habilitar la {% data variables.product.prodname_server_statistics %} en tu empresa](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)". When you enable {% data variables.product.prodname_server_statistics %}, you're helping to build a better {% data variables.product.prodname_dotcom %}. The aggregated data you'll provide gives us insights into how {% data variables.product.prodname_dotcom %} adds value to our customers. This information allows {% data variables.product.company_short %} to make better and more informed product decisions, ultimately benefiting you. @@ -34,7 +34,7 @@ For a better understanding of how we store and secure {% data variables.product. ### About data retention and deletion -{% data variables.product.company_short %} collects {% data variables.product.prodname_server_statistics %} data for as long as your {% data variables.product.prodname_ghe_server %} license is active and the {% data variables.product.prodname_server_statistics %} feature is enabled. +{% data variables.product.company_short %} recopila datos de {% data variables.product.prodname_server_statistics %} durante todo el tiempo en el que tu licencia de {% data variables.product.prodname_ghe_server %} esté activa y la característica de {% data variables.product.prodname_server_statistics %} esté habilitada. If you would like to delete your data, you may do so by contacting GitHub Support, your {% data variables.product.prodname_dotcom %} account representative, or your Customer Success Manager. Generally, we delete data in the timeframe specified in our privacy statement. For more information, see [{% data variables.product.company_short %}'s privacy statement](/free-pro-team@latest/site-policy/privacy-policies/github-privacy-statement#data-retention-and-deletion-of-data) in the {% data variables.product.prodname_dotcom_the_website %} documentation. diff --git a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/requesting-server-statistics-using-the-rest-api.md b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/requesting-server-statistics-using-the-rest-api.md index 12e72822cfe3..8c045d76e00c 100644 --- a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/requesting-server-statistics-using-the-rest-api.md +++ b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/requesting-server-statistics-using-the-rest-api.md @@ -8,8 +8,8 @@ redirect_from: - /early-access/github/analyze-how-your-team-works-with-server-statistics/requesting-server-statistics-using-the-rest-api --- -You can request up to 365 days of metrics in a single {% data variables.product.prodname_server_statistics %} REST API request. Estos datos, los cuales incluyen métricas agregadas en los repositorios, propuestas y solicitudes de cambio pueden ayudarte a anticipar las necesidades de tu organización, entender cómo funciona tu equipo y mostrarte el valor que obtienes de {% data variables.product.prodname_ghe_server %}. For a list of the metrics collected, see "[{% data variables.product.prodname_server_statistics %} data collected](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics#server-statistics-data-collected)." +You can request up to 365 days of metrics in a single {% data variables.product.prodname_server_statistics %} REST API request. Estos datos, los cuales incluyen métricas agregadas en los repositorios, propuestas y solicitudes de cambio pueden ayudarte a anticipar las necesidades de tu organización, entender cómo funciona tu equipo y mostrarte el valor que obtienes de {% data variables.product.prodname_ghe_server %}. Para encontrar una lista de las métricas recopiladas, consulta la sección "[Datos de {% data variables.product.prodname_server_statistics %} recopilados](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics#server-statistics-data-collected)". Before you can use the {% data variables.product.prodname_server_statistics %} REST API, you must enable {% data variables.product.prodname_server_statistics %}. Para obtener más información, consulta la sección "[Habilitar la {% data variables.product.prodname_server_statistics %} en tu empresa](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)". -For more information about using the REST API to request server statistics, see "[Get {% data variables.product.prodname_ghe_server %} statistics](/enterprise-cloud@latest/rest/enterprise-admin/admin-stats#get-github-enterprise-server-statistics)" in the {% data variables.product.prodname_ghe_cloud %} REST API documentation. +Para obtener más información sobre cómo utilizar la API de REST para solicitar estadísticas de servidor, consulta la sección "[Obtener estadísticas de {% data variables.product.prodname_ghe_server %}](/enterprise-cloud@latest/rest/enterprise-admin/admin-stats#get-github-enterprise-server-statistics)" en la documentación de la API de REST de {% data variables.product.prodname_ghe_cloud %}. diff --git a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md index e831dcfc21cc..cbefb7dcff3f 100644 --- a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md +++ b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md @@ -256,57 +256,57 @@ El alcance de los eventos que se muestran en la bitácora de auditoría de tu em | -------------------- | ----------------------------- | | `discussion.destroy` | Se borró un debate de equipo. | -## `discussion_comment` category actions +## Acciones de la categoría `discussion_comment` -| Acción | Descripción | -| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `discussion_comment.destroy` | A [comment on a team discussion post was deleted](/communities/moderating-comments-and-conversations/managing-disruptive-comments#deleting-a-comment). | -| `discussion_comment.update` | A [comment on a team discussion post was edited](/communities/moderating-comments-and-conversations/managing-disruptive-comments#editing-a-comment). | +| Acción | Descripción | +| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `discussion_comment.destroy` | [Se borró un comentario en una publicación de debate de equipo](/communities/moderating-comments-and-conversations/managing-disruptive-comments#deleting-a-comment). | +| `discussion_comment.update` | [Se editó un comentario en una publicación de debate de equipo](/communities/moderating-comments-and-conversations/managing-disruptive-comments#editing-a-comment). | ## acciones de la categoría `discussion_post` -| Acción | Descripción | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------ | -| `discussion_post.destroy` | A [team discussion post was deleted](/organizations/collaborating-with-your-team/editing-or-deleting-a-team-discussion). | -| `discussion_post.update` | A [team discussion post was edited](/organizations/collaborating-with-your-team/editing-or-deleting-a-team-discussion). | +| Acción | Descripción | +| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `discussion_post.destroy` | [Se borró una publicación de debate de equipo](/organizations/collaborating-with-your-team/editing-or-deleting-a-team-discussion). | +| `discussion_post.update` | [Se editó una publicación de debate de equipo](/organizations/collaborating-with-your-team/editing-or-deleting-a-team-discussion). | ## acciones de la categoría `discussion_post_reply` -| Acción | Descripción | -| ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `discussion_post_reply.destroy` | A [reply to a team discussion post was deleted](/communities/moderating-comments-and-conversations/managing-disruptive-comments#deleting-a-comment). | -| `discussion_post_reply.update` | A [reply to a team discussion post was edited](/communities/moderating-comments-and-conversations/managing-disruptive-comments#editing-a-comment). | +| Acción | Descripción | +| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `discussion_post_reply.destroy` | [Se borró una respuesta a una publicación de debate de equipo](/communities/moderating-comments-and-conversations/managing-disruptive-comments#deleting-a-comment). | +| `discussion_post_reply.update` | [Se editó una respuesta a una publicación de debate de equipo](/communities/moderating-comments-and-conversations/managing-disruptive-comments#editing-a-comment). | {%- endif %} {%- ifversion ghec or ghes %} -## `dotcom_connection` category actions +## Acciones de la categoría `dotcom_connection` -| Acción | Descripción | -| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dotcom_connection.create` | A {% data variables.product.prodname_github_connect %} connection to {% data variables.product.prodname_dotcom_the_website %} was created. | -| `dotcom_connection.destroy` | A {% data variables.product.prodname_github_connect %} connection to {% data variables.product.prodname_dotcom_the_website %} was deleted. | -| `dotcom_connection.token_updated` | The {% data variables.product.prodname_github_connect %} connection token for {% data variables.product.prodname_dotcom_the_website %} was updated. | -| `dotcom_connection.upload_license_usage` | El uso de la licencia de {% data variables.product.prodname_ghe_server %} se cargó manualmente a {% data variables.product.prodname_ghe_cloud %}. | -| `dotcom_connection.upload_usage_metrics` | Las métricas de uso de {% data variables.product.prodname_ghe_server %} se cargaron a {% data variables.product.prodname_dotcom_the_website %}. | +| Acción | Descripción | +| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `dotcom_connection.create` | Se creó una conexión de {% data variables.product.prodname_github_connect %} al {% data variables.product.prodname_dotcom_the_website %}. | +| `dotcom_connection.destroy` | Se borró una conexión de {% data variables.product.prodname_github_connect %} al {% data variables.product.prodname_dotcom_the_website %}. | +| `dotcom_connection.token_updated` | Se actualizó el token de conexión de {% data variables.product.prodname_github_connect %} para {% data variables.product.prodname_dotcom_the_website %}. | +| `dotcom_connection.upload_license_usage` | El uso de la licencia de {% data variables.product.prodname_ghe_server %} se cargó manualmente a {% data variables.product.prodname_ghe_cloud %}. | +| `dotcom_connection.upload_usage_metrics` | Las métricas de uso de {% data variables.product.prodname_ghe_server %} se cargaron a {% data variables.product.prodname_dotcom_the_website %}. | {%- endif %} ## acciones de la categoría `enterprise` -| Acción | Descripción | -| ------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `enterprise.config.disable_anonymous_git_access` | An enterprise owner{% ifversion ghes %} or site administrator{% endif %} disabled anonymous Git read access for repositories in the enterprise. Para obtener más información consulta la sección "[Requerir políticas de administración de repositorios en tu empresa](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)". | -| `enterprise.config.enable_anonymous_git_access` | An enterprise owner{% ifversion ghes %} or site administrator{% endif %} enabled anonymous Git read access for repositories in the enterprise. Para obtener más información consulta la sección "[Requerir políticas de administración de repositorios en tu empresa](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)". | -| `enterprise.config.lock_anonymous_git_access` | An enterprise owner{% ifversion ghes %} or site administrator{% endif %} locked anonymous Git read access to prevent repository admins from changing existing anonymous Git read access settings for repositories in the enterprise. Para obtener más información consulta la sección "[Requerir políticas de administración de repositorios en tu empresa](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)". | -| `enterprise.config.unlock_anonymous_git_access` | An enterprise owner{% ifversion ghes %} or site administrator{% endif %} unlocked anonymous Git read access to allow repository admins to change existing anonymous Git read access settings for repositories in the enterprise. Para obtener más información consulta la sección "[Requerir políticas de administración de repositorios en tu empresa](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)". | -| `enterprise.register_self_hosted_runner` | A new {% data variables.product.prodname_actions %} self-hosted runner was registered. Para obtener más información, consulta la sección "[Agregar un ejecutor auto-hospedado a un repositorio](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-a-repository)". | -| `enterprise.remove_self_hosted_runner` | A {% data variables.product.prodname_actions %} self-hosted runner was removed. Para obtener más información, consulta la sección "[Eliminar a un ejecutor de un repositorio](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-a-repository)". | -| `enterprise.runner_group_created` | A {% data variables.product.prodname_actions %} self-hosted runner group was created. Para obtener más información, consulta la sección "[Crear un grupo de ejecutores auto-hospedados para una organización](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-organization)". | -| `enterprise.runner_group_removed` | A {% data variables.product.prodname_actions %} self-hosted runner group was removed. Para obtener más información, consulta la sección "[Eliminar un grupo de ejecutores auto-hospedados](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group)". | -| `enterprise.runner_group_renamed` | A {% data variables.product.prodname_actions %} self-hosted runner group was renamed. Para obtener más información, consulta la sección "[Cambiar la política de acceso para un grupo de ejecutores auto-hospedados](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)". | -| `enterprise.runner_group_updated` | The configuration of a {% data variables.product.prodname_actions %} self-hosted runner group was changed. Para obtener más información, consulta la sección "[Cambiar la política de acceso para un grupo de ejecutores auto-hospedados](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)". | -| `enterprise.runner_group_runner_removed` | The REST API was used to remove a {% data variables.product.prodname_actions %} self-hosted runner from a group. Para obtener más información, consulta la sección "[Eliminar un ejecutor auto-hospedado de un grupo en una organización](/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization)". | -| `enterprise.runner_group_runners_added` | A {% data variables.product.prodname_actions %} self-hosted runner was added to a group. Para obtener más información, consulta la sección [Mover un ejecutor auto-hospedado a un grupo](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group). | -| `enterprise.runner_group_runners_updated` | Se actualizó una lista de miembros de un grupo de ejecutores de {% data variables.product.prodname_actions %}. Para obtener más información, consulta la sección "[Configurar ejecutores auto-hospedados en un grupo para una organización](/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization)". | +| Acción | Descripción | +| ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `enterprise.config.disable_anonymous_git_access` | Un propietario de empresa{% ifversion ghes %} o administrador de sitio{% endif %} inhabilitó el acceso de lectura anónima de Git para los repositorios en la empresa. Para obtener más información consulta la sección "[Requerir políticas de administración de repositorios en tu empresa](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)". | +| `enterprise.config.enable_anonymous_git_access` | Un propietario de empresa{% ifversion ghes %} o administrador de sitio{% endif %} habilitó el acceso de lectura anónima de Git para los repositorios en la empresa. Para obtener más información consulta la sección "[Requerir políticas de administración de repositorios en tu empresa](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)". | +| `enterprise.config.lock_anonymous_git_access` | Un propietario de empresa{% ifversion ghes %} o administrador de sitio{% endif %} bloqueó el acceso de lectura anónima de Git para prevenir que los administradores de repositorios cambien los ajustes existentes del acceso de lectura anónima de Git para los repositorios en la empresa. Para obtener más información consulta la sección "[Requerir políticas de administración de repositorios en tu empresa](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)". | +| `enterprise.config.unlock_anonymous_git_access` | Un propietario de empresa{% ifversion ghes %} o administrador de sitio{% endif %} desbloqueó el acceso de lectura anónima de Git para permitir que los administradores de repositorio cambien los ajustes de acceso de lectura anónima de Git para los repositorios de la empresa. Para obtener más información consulta la sección "[Requerir políticas de administración de repositorios en tu empresa](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)". | +| `enterprise.register_self_hosted_runner` | Se registró un nuevo ejecutor auto-hospedado de {% data variables.product.prodname_actions %}. Para obtener más información, consulta la sección "[Agregar un ejecutor auto-hospedado a un repositorio](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-a-repository)". | +| `enterprise.remove_self_hosted_runner` | Se eliminó un ejecutor auto-hospedado de {% data variables.product.prodname_actions %}. Para obtener más información, consulta la sección "[Eliminar a un ejecutor de un repositorio](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-a-repository)". | +| `enterprise.runner_group_created` | Se creó un grupo de ejecutores auto-hospedados de {% data variables.product.prodname_actions %}. Para obtener más información, consulta la sección "[Crear un grupo de ejecutores auto-hospedados para una organización](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-organization)". | +| `enterprise.runner_group_removed` | Se eliminó un grupo de ejecutores auto-hospedados de {% data variables.product.prodname_actions %}. Para obtener más información, consulta la sección "[Eliminar un grupo de ejecutores auto-hospedados](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group)". | +| `enterprise.runner_group_renamed` | Se renombró a un grupo de ejecutores auto-hospedados de {% data variables.product.prodname_actions %}. Para obtener más información, consulta la sección "[Cambiar la política de acceso para un grupo de ejecutores auto-hospedados](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)". | +| `enterprise.runner_group_updated` | Se cambió la configuración de un grupo de ejecutores auto-hospedados de {% data variables.product.prodname_actions %}. Para obtener más información, consulta la sección "[Cambiar la política de acceso para un grupo de ejecutores auto-hospedados](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)". | +| `enterprise.runner_group_runner_removed` | Se utilizó la API de REST para eliminar a un ejecutor auto-hospedado de {% data variables.product.prodname_actions %} de un grupo. Para obtener más información, consulta la sección "[Eliminar un ejecutor auto-hospedado de un grupo en una organización](/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization)". | +| `enterprise.runner_group_runners_added` | A {% data variables.product.prodname_actions %} self-hosted runner was added to a group. Para obtener más información, consulta la sección [Mover un ejecutor auto-hospedado a un grupo](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group). | +| `enterprise.runner_group_runners_updated` | Se actualizó una lista de miembros de un grupo de ejecutores de {% data variables.product.prodname_actions %}. Para obtener más información, consulta la sección "[Configurar ejecutores auto-hospedados en un grupo para una organización](/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization)". | {%- ifversion ghec %} | `enterprise.runner_group_visiblity_updated` | Se actualizó la visibilidad de un grupo de ejecutores auto hospedados de {% data variables.product.prodname_actions %} a través de la API de REST. Para obtener más información, consulta la sección "[Actualizar un grupo de ejecutores auto-hospedados para una organización](/rest/reference/actions#update-a-self-hosted-runner-group-for-an-organization)". {%- endif %} diff --git a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/displaying-ip-addresses-in-the-audit-log-for-your-enterprise.md b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/displaying-ip-addresses-in-the-audit-log-for-your-enterprise.md index 558a5cb068da..cda38b616c0f 100644 --- a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/displaying-ip-addresses-in-the-audit-log-for-your-enterprise.md +++ b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/displaying-ip-addresses-in-the-audit-log-for-your-enterprise.md @@ -24,7 +24,7 @@ If you choose to display IP addresses, the IP addresses only appear in your ente You can display IP addresses in the audit log regardless of which authentication method you use for your enterprise on {% data variables.product.product_location %}. Para obtener más información, consulta la sección "[Acerca de la autenticación para tu empresa](/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise)". -When anyone creates an account on {% data variables.product.product_location %}, the person agrees to {% data variables.product.company_short %}'s collection of basic information about connections to {% data variables.product.company_short %}'s services, including source IP address. For more information, see "[GitHub Privacy Statement](/free-pro-team@latest/site-policy/privacy-policies/github-privacy-statement#usage-information)." +Cuando alguien crea una cuenta en {% data variables.product.product_location %}, la persona está de acuerdo en que {% data variables.product.company_short %} recopile información básica sobre las conexiones con los servicios de {% data variables.product.company_short %}, incluyendo las direcciones IP de origen. For more information, see "[GitHub Privacy Statement](/free-pro-team@latest/site-policy/privacy-policies/github-privacy-statement#usage-information)." ## Events that display IP addresses in the audit log diff --git a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md index 9c829d511b2b..0ecc3ec98dd0 100644 --- a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md +++ b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md @@ -44,7 +44,8 @@ Puedes configurar la transmisión de bitácoras de auditoría en {% data variabl - [Amazon S3](#setting-up-streaming-to-amazon-s3) - [Almacenamiento de Blobs de Azure](#setting-up-streaming-to-azure-blob-storage) -- [Azure Event Hubs](#setting-up-streaming-to-azure-event-hubs) +- [Azure Event Hubs](#setting-up-streaming-to-azure-event-hubs){% ifversion streaming-datadog %} +- [Datadog](#setting-up-streaming-to-datadog){% endif %} - [Google Cloud Storage](#setting-up-streaming-to-google-cloud-storage) - [Splunk](#setting-up-streaming-to-splunk) @@ -60,7 +61,7 @@ Puedes configurar la transmisión de S3 con claves de acceso o, para evitar el a #### Configurar la transmisión a S3 con llaves de acceso {% endif %} -Para transmitir bitácoras de auditoría a la terminal de Amazon S3, debes tener un bucket y llaves de acceso. Para obtener más información, consulta la sección [Crear, configurar y trabajar con los buckets de Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) en la documentación de AWS. Asegúrate de bloquear el acceso público al bucket para proteger la información de tu bitácora de auditoría. +Para transmitir bitácoras de auditoría a la terminal de Amazon S3, debes tener un bucket y llaves de acceso. Para obtener más información, consulta la sección "[Crear, configurar y trabajar con buckets de Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) en la documentación de AWS. Asegúrate de bloquear el acceso público al bucket para proteger la información de tu bitácora de auditoría. Para configurar la transmisión de bitácora de auditoría desde {% data variables.product.prodname_dotcom %}, necesitarás: * El nombrede tu bucket de Amazon S3 @@ -87,7 +88,7 @@ Para obtener más información sobre cómo crear o acceder a tu ID de llave de a {% note %} -**Note:** Streaming to Amazon S3 with OpenID Connect is currently in beta and subject to change. +**Nota:** La transmisión a Amazon S3 con OpenID Connect se encuentra actualmente en beta y está sujeta a cambios. {% endnote %} @@ -231,6 +232,32 @@ Necesitas dos partes de información sobre tu concentrador de eventos: su nombre {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} +{% ifversion streaming-datadog %} +### Setting up streaming to Datadog + +To set up streaming to Datadog, you must create a client token or an API key in Datadog, then configure audit log streaming in {% data variables.product.product_name %} using the token for authentication. You do not need to create a bucket or other storage container in Datadog. + +After you set up streaming to Datadog, you can see your audit log data by filtering by "github.audit.streaming." For more information, see [Log Management](https://docs.datadoghq.com/logs/). + +1. If you don't already have a Datadog account, create one. +1. In Datadog, generate a client token or an API key, then click **Copy key**. For more information, see [API and Application Keys](https://docs.datadoghq.com/account_management/api-app-keys/) in Datadog Docs. +{% data reusables.enterprise.navigate-to-log-streaming-tab %} +1. Select the **Configure stream** dropdown menu and click **Datadog**. + + ![Screenshot of the "Configure stream" dropdown menu with "Datadog" highlighted](/assets/images/help/enterprises/audit-stream-choice-datadog.png) +1. Under "Token", paste the token you copied earlier. + + ![Screenshot of the "Token" field](/assets/images/help/enterprises/audit-stream-datadog-token.png) +1. Select the "Site" dropdown menu and click your Datadog site. To determine your Datadog site, compare your Datadog URL to the table in [Datadog sites](https://docs.datadoghq.com/getting_started/site/) in Datadog Docs. + + ![Screenshot of the "Site" dropdown menu](/assets/images/help/enterprises/audit-stream-datadog-site.png) +1. To verify that {% data variables.product.prodname_dotcom %} can connect and write to the Datadog endpoint, click **Check endpoint**. + + ![Verificar la terminal](/assets/images/help/enterprises/audit-stream-check.png) +{% data reusables.enterprise.verify-audit-log-streaming-endpoint %} +1. After a few minutes, confirm that audit log data is appearing on the **Logs** tab in Datadog. If audit log data is not appearing, confirm that your token and site are correct in {% data variables.product.prodname_dotcom %}. +{% endif %} + ### Configurar la transmisión para Google Cloud Storage Para configurar la transmisión al Almacenamiento de Google Cloud, debes crear una cuenta de servicio en Google Cloud con las credenciales y permisos adecuados y luego configurar la transmisión de bitácoras de auditoría en {% data variables.product.product_name %} utilizando las credenciales de la cuenta de servicio para la autenticación. @@ -265,7 +292,7 @@ Para transmitir bitácoras de auditoría a la terminal del Recolector de Eventos {% data reusables.enterprise.navigate-to-log-streaming-tab %} 1. Haz clic en **Configurar transmisión** y selecciona **Splunk**. - ![Elige Splunk desde el menú desplegable](/assets/images/help/enterprises/audit-stream-choice-splunk.png) + ![Elegir Splunk del menú desplegable](/assets/images/help/enterprises/audit-stream-choice-splunk.png) 1. En la página de configuración, ingresa: * El dominio en el cual se hospeda la aplicación que quieres transmitir. @@ -291,6 +318,10 @@ Para transmitir bitácoras de auditoría a la terminal del Recolector de Eventos El pausar la transmisión te permite realizar el mantenimiento de la aplicación receptora sin perder datos de auditoría. Las bitácoras de auditoría se almacenan por hasta siete días en {% data variables.product.product_location %} y luego se exportan cuando dejas de pausar la transmisión. +{% ifversion streaming-datadog %} +Datadog only accepts logs from up to 18 hours in the past. If you pause a stream to a Datadog endpoint for more than 18 hours, you risk losing logs that Datadog won't accept after you resume streaming. +{% endif %} + {% data reusables.enterprise.navigate-to-log-streaming-tab %} 1. Haz clic en **Pausar transmisión**. diff --git a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md index bef9fa7faf61..88353b129299 100644 --- a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md +++ b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md @@ -121,7 +121,7 @@ Para obtener más información sobre la API de REST de la bitácora de auditorí La siguiente consulta busca los eventos de la bitácora de auditoría que se crearon el 1 de enero de 2022 en la empresa `avocado-corp` y devolvió la primera página con un máximo de 100 elementos por página utilizando la [Paginación de la API de REST](/rest/overview/resources-in-the-rest-api#pagination): ```shell -curl -H "Authorization: token TOKEN" \ +curl -H "Authorization: Bearer TOKEN" \ --request GET \ "https://api.github.com/enterprises/avocado-corp/audit-log?phrase=created:2022-01-01&page=1&per_page=100" ``` @@ -133,7 +133,7 @@ Puedes especificar frases de búsqueda múltiples, tales como `created` y `actor La siguiente consulta busca los eventos de bitácora de auditoría para las solicitudes de cambios, en donde el evento ocurrió en o después del 1 de enero de 2022 en la empresa `avocado-corp` y el usuario `octocat` realizó la acción: ```shell -curl -H "Authorization: token TOKEN" \ +curl -H "Authorization: Bearer TOKEN" \ --request GET \ "https://api.github.com/enterprises/avocado-corp/audit-log?phrase=action:pull_request+created:>=2022-01-01+actor:octocat" ``` diff --git a/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md b/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md index 69f3a5530326..75b2044c679f 100644 --- a/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md +++ b/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md @@ -81,6 +81,8 @@ You can also configure allowed IP addresses for an individual organization. For {% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %} +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} diff --git a/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md b/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md index f3bb543201c0..ebe7c2bde5a6 100644 --- a/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md +++ b/translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md @@ -111,7 +111,7 @@ En todas las organizaciones que pertenezcan a tu empresa, puedes permitir o proh {% ifversion enterprise-namespace-repo-setting %} {% note %} -**Note:** If {% ifversion ghec %}your enterprise uses {% data variables.product.prodname_emus %} and {% endif %}your "Repository creation" policy prevents enterprise members from creating repositories owned by their user accounts, members will not be allowed to fork a repository in their user accounts, regardless of your "Repository forking" policy. +**Nota:** Si {% ifversion ghec %}tu empresa utiliza {% data variables.product.prodname_emus %} y {% endif %} tu política de "Creación de repositorios" previene que los miembros de las empresas creen repositorios que le pertenezcan a sus cuentas de usuario, no se permitirá que dichos miembros bifurquen un repositorio en sus cuentas de usuario, sin importar tu política de "Bifurcación de repositorios". {% endnote %} {% endif %} diff --git a/translations/es-ES/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md b/translations/es-ES/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md index 77c7fffea004..d3757186dbe4 100644 --- a/translations/es-ES/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md +++ b/translations/es-ES/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md @@ -44,7 +44,7 @@ The Migrations API is currently in a preview period, which means that the endpoi * Your access token for authentication. * A [list of the repositories](/free-pro-team@latest/rest/repos#list-organization-repositories) you want to migrate: ```shell - curl -H "Authorization: token GITHUB_ACCESS_TOKEN" \ + curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" \ -X POST \ -H "Accept: application/vnd.github+json" \ -d'{"lock_repositories":true,"repositories":["orgname/reponame", "orgname/reponame"]}' \ @@ -59,7 +59,7 @@ The Migrations API is currently in a preview period, which means that the endpoi * Your access token for authentication. * The unique `id` of the migration: ```shell - curl -H "Authorization: token GITHUB_ACCESS_TOKEN" \ + curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" \ -H "Accept: application/vnd.github+json" \ https://api.github.com/orgs/orgname/migrations/id ``` @@ -74,7 +74,7 @@ The Migrations API is currently in a preview period, which means that the endpoi * Your access token for authentication. * The unique `id` of the migration: ```shell - curl -H "Authorization: token GITHUB_ACCESS_TOKEN" \ + curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" \ -H "Accept: application/vnd.github+json" \ -L -o migration_archive.tar.gz \ https://api.github.com/orgs/orgname/migrations/id/archive @@ -84,7 +84,7 @@ The Migrations API is currently in a preview period, which means that the endpoi * Your access token for authentication. * The unique `id` of the migration: ```shell - curl -H "Authorization: token GITHUB_ACCESS_TOKEN" \ + curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" \ -X DELETE \ -H "Accept: application/vnd.github+json" \ https://api.github.com/orgs/orgname/migrations/id/archive diff --git a/translations/es-ES/content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md b/translations/es-ES/content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md index cc184c3ab8e3..2e0d4117ffcb 100644 --- a/translations/es-ES/content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md +++ b/translations/es-ES/content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md @@ -134,7 +134,7 @@ Para desbloquear los repositorios en una organización{% data variables.product. * El `id` único de la migración * El nombre del repositorio a desbloquear ```shell -curl -H "Authorization: token GITHUB_ACCESS_TOKEN" -X DELETE \ +curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" -X DELETE \ -H "Accept: application/vnd.github.wyandotte-preview+json" \ https://api.github.com/orgs/orgname/migrations/id/repos/repo_name/lock ``` @@ -143,7 +143,7 @@ curl -H "Authorization: token GITHUB_ACCESS_TOKEN" -X DELETE \ Después de desbloquear los repositorios de organización de {% data variables.product.prodname_dotcom_the_website %} deberás borrar todos los repositorios que migraste previamente utilizando [la terminal de borrado de repositorios](/rest/repos/#delete-a-repository). Necesitarás tu token de acceso para la autenticación: ```shell -curl -H "Authorization: token GITHUB_ACCESS_TOKEN" -X DELETE \ +curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" -X DELETE \ https://api.github.com/repos/orgname/repo_name ``` diff --git a/translations/es-ES/content/authentication/connecting-to-github-with-ssh/about-ssh.md b/translations/es-ES/content/authentication/connecting-to-github-with-ssh/about-ssh.md index e43c7b420f05..1a3f28d82ada 100644 --- a/translations/es-ES/content/authentication/connecting-to-github-with-ssh/about-ssh.md +++ b/translations/es-ES/content/authentication/connecting-to-github-with-ssh/about-ssh.md @@ -16,7 +16,7 @@ topics: {% data reusables.ssh.about-ssh %} Para obtener más información sobre SSH, consulta la página de [Secure Shell](https://en.wikipedia.org/wiki/Secure_Shell) en Wikipedia. -Cuando configuras SSH, necesitarás generar una llave SSH privada nueva y agregarla al agente SSH. You must also add the public SSH key to your account on {% data variables.product.product_name %} before you use the key to authenticate{% ifversion ssh-commit-verification %} or sign commits{% endif %}. For more information, see "[Generating a new SSH key and adding it to the ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)"{% ifversion ssh-commit-verification %}, {% else %} and{% endif %} "[Adding a new SSH key to your {% data variables.product.prodname_dotcom %} account](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account){% ifversion ssh-commit-verification %}" and "[About commit signature verification](/articles/about-commit-signature-verification){% endif %}." +Cuando configuras SSH, necesitarás generar una llave SSH privada nueva y agregarla al agente SSH. You must also add the public SSH key to your account on {% data variables.product.product_name %} before you use the key to authenticate{% ifversion ssh-commit-verification %} or sign commits{% endif %}. Para obtener más información, consulta las secciones "[Generar una llave SSH nueva y agregarla al ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)"{% ifversion ssh-commit-verification %}, {% else %}y{% endif %} "[Agregar una llave SSH nueva a tu cuenta de {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account){% ifversion ssh-commit-verification %}" y "[Acerca de la verificación de firmas de confirmación](/articles/about-commit-signature-verification){% endif %}". Puedes asegurar tu llave SSH aún más si utilizas una llave de seguridad de hardware, la cual requiere que esta última se conecte físicamente a tu computadora cuando se utilice el par de llaves para autenticarte con SSH. También puedes asegurar tu llave SSH si la agregas al ssh-agent y utiliza una contraseña. Para obtener más información, consulta la sección "[Trabajar con frases de acceso con llave SSH](/github/authenticating-to-github/working-with-ssh-key-passphrases)". diff --git a/translations/es-ES/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md b/translations/es-ES/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md index 63ddd127e8de..e86df4c351fb 100644 --- a/translations/es-ES/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md +++ b/translations/es-ES/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md @@ -29,11 +29,11 @@ topics: {% data reusables.command_line.open_the_multi_os_terminal %} 3. Genera un par de la llave GPG. Ya que existen varias versiones de GPG, puede que necesites consultar la [_página man_](https://en.wikipedia.org/wiki/Man_page) relevante para encontrar el comando adecuado para la generación de llaves. Tu llave debe utilizar RSA. - Si estás usando una versión 2.1.17 o superior, copia el siguiente texto para generar un par de la llave GPG. - ```shell + ```shell{:copy} $ gpg --full-generate-key ``` - Si no estás usando la versión 2.1.17 ni una superior, el comando `gpg --full-generate-key` no funciona. Copia el siguiente texto y continúa con el paso 6. - ```shell + ```shell{:copy} $ gpg --default-new-key-algo rsa4096 --gen-key ``` 4. En el prompt, especifica la clase de llave que quieres, o presiona `Enter` para aceptar lo predeterminado. @@ -52,10 +52,10 @@ topics: {% data reusables.gpg.list-keys-with-note %} {% data reusables.gpg.copy-gpg-key-id %} 10. Pega el siguiente texto sustituyendo el ID de la llave GPG que deseas usar. En este ejemplo, el ID de la llave GPG es `3AA5C34371567BD2`: - ```shell - $ gpg --armor --export 3AA5C34371567BD2 - # Prints the GPG key ID, in ASCII armor format - ``` + ```shell{:copy} + $ gpg --armor --export 3AA5C34371567BD2 + # Prints the GPG key ID, in ASCII armor format + ``` 11. Copia tu llave GPG, comenzando con `-----BEGIN PGP PUBLIC KEY BLOCK-----` y terminando con `-----END PGP PUBLIC KEY BLOCK-----`. 12. [Agrega la llave GPG a tu cuenta de GitHub](/articles/adding-a-gpg-key-to-your-github-account). diff --git a/translations/es-ES/content/authentication/managing-commit-signature-verification/index.md b/translations/es-ES/content/authentication/managing-commit-signature-verification/index.md index cdf16d7b2d6b..f081788d3609 100644 --- a/translations/es-ES/content/authentication/managing-commit-signature-verification/index.md +++ b/translations/es-ES/content/authentication/managing-commit-signature-verification/index.md @@ -1,6 +1,6 @@ --- title: Administrar la verificación de firma de confirmación de cambios -intro: '{% data variables.product.product_name %} will verify GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} or S/MIME signatures so other people will know that your commits come from a trusted source.{% ifversion fpt %} {% data variables.product.product_name %} will automatically sign commits you make using the {% data variables.product.product_name %} web interface.{% endif %}' +intro: '{% data variables.product.product_name %} verificará las firmas GPG{% ifversion ssh-commit-verification %}, SSH,{% endif %} o S/MIME para que otras personas sepan que tus confirmaciones vienen de una fuente confiable.{% ifversion fpt %} {% data variables.product.product_name %} firmará automáticamente las confirmaciones que realices utilizando la interfaz web de {% data variables.product.product_name %}.{% endif %}' redirect_from: - /articles/generating-a-gpg-key - /articles/signing-commits-with-gpg diff --git a/translations/es-ES/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md b/translations/es-ES/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md index 4f0b2f52b6b1..6c59e90b4faa 100644 --- a/translations/es-ES/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md +++ b/translations/es-ES/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md @@ -1,6 +1,7 @@ --- title: Acerca de la facturación para GitHub Actions intro: 'Si quieres utilizar {% data variables.product.prodname_actions %} con más almacenamiento o minutos de los que se incluyen en tu cuenta, se te cobrará por estos recursos adicionales.' +miniTocMaxHeadingLevel: 3 redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions/about-billing-for-github-actions @@ -28,6 +29,13 @@ Los minutos se restablecen cada mes, pero no es el caso para el uso de almacenam ### Minutos y almacenamiento incluídos +{% ifversion actions-hosted-runners %} +{% note %} + +**Note**: Entitlement minutes cannot be used for Windows and Ubuntu runners over 2-cores. These runners will always be charged for, including in public repos. For more information, see "[Per-minute rates for runners](/billing/managing-billing-for-github-actions/about-billing-for-github-actions#per-minute-rates)." + +{% endnote %} +{% endif %} | Producto | Almacenamiento | Minutos (por mes) | | --------------------------------------------------------------------- | -------------- | ----------------- | | {% data variables.product.prodname_free_user %} | 500 MB | 2,000 | @@ -58,15 +66,15 @@ El almacenamiento que utilza un repositorio es el total del almacenamiento utili ### Tasas por minuto -| Sistema operativo | Tasa por minuto (USD) | -| ----------------- | --------------------- | -| Linux | $0.008 | -| macOS | $0.08 | -| Windows | $0.016 | - -La cantidad de jobs que puedes ejecutar simultáneamente a través de todos los repositorios que pertenezcan a tu cuenta de usuario u organización dependerá de tu plan de GitHub. Para obtener más información, consulta la sección "[Facturación y límites de uso](/actions/reference/usage-limits-billing-and-administration)" para los ejecutores hospedados en {% data variables.product.prodname_dotcom %} y la sección "[Acerca de los ejecutores auto-hospedados](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)" para los límites de uso de los ejecutores auto-hospedados. +{% data reusables.billing.billing-standard-runners %} +{% ifversion actions-hosted-runners %}{% data reusables.billing.billing-hosted-runners %}{% endif %} -{% data reusables.user-settings.context_switcher %} +- La cantidad de jobs que puedes ejecutar simultáneamente a través de todos los repositorios que pertenezcan a tu cuenta de usuario u organización dependerá de tu plan de GitHub. Para obtener más información, consulta la sección "[Facturación y límites de uso](/actions/reference/usage-limits-billing-and-administration)" para los ejecutores hospedados en {% data variables.product.prodname_dotcom %} y la sección "[Acerca de los ejecutores auto-hospedados](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)" para los límites de uso de los ejecutores auto-hospedados. +- {% data reusables.user-settings.context_switcher %} +{% ifversion actions-hosted-runners %} +- For {% data variables.actions.hosted_runner %}s, there is no additional cost for configurations that assign public static IP addresses to a {% data variables.actions.hosted_runner %}. For more information on {% data variables.actions.hosted_runner %}s, see "[Using {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/using-larger-runners)." +- Entitlement minutes cannot be used for {% data variables.actions.hosted_runner %}s. +{% endif %} ## Calcular los gastos por minuto y por almacenamiento diff --git a/translations/es-ES/content/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot.md b/translations/es-ES/content/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot.md index 9722449988d6..816c27b4179f 100644 --- a/translations/es-ES/content/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot.md +++ b/translations/es-ES/content/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot.md @@ -18,4 +18,4 @@ Before starting a paid subscription, you can set up a one-time 60-day trial to e The {% data variables.product.prodname_copilot %} subscription is available on a monthly or yearly cycle. If you choose a monthly billing cycle, you will be billed $10 per calendar month. If you choose a yearly billing cycle, you will be billed $100 per year. You can modify your billing cycle at any time, and the modification will be reflected from the start of your next billing cycle. -A free subscription for {% data variables.product.prodname_copilot %} is available to verified students, and maintainers of popular open-source repositories on {% data variables.product.company_short %}. If you meet the criteria as an open source maintainer, you will be automatically notified when you visit the {% data variables.product.prodname_copilot %} subscription page. As a student, if you currently receive the {% data variables.product.prodname_student_pack %}, you will also be offered a free subscription when you visit the {% data variables.product.prodname_copilot %} subscription page. For more information about the {% data variables.product.prodname_student_pack %}, see "[Apply to {% data variables.product.prodname_global_campus %} as a student](/free-pro-team@latest/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student)." +A free subscription for {% data variables.product.prodname_copilot %} is available to verified students, and maintainers of popular open-source repositories on {% data variables.product.company_short %}. If you meet the criteria as an open source maintainer, you will be automatically notified when you visit the {% data variables.product.prodname_copilot %} subscription page. As a student, if you currently receive the {% data variables.product.prodname_student_pack %}, you will also be offered a free subscription when you visit the {% data variables.product.prodname_copilot %} subscription page. Para obtener más información sobre el {% data variables.product.prodname_student_pack %}, consulta la sección "[Solicitar ingresar al {% data variables.product.prodname_global_campus %} como alumno](/free-pro-team@latest/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student)". diff --git a/translations/es-ES/content/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise.md b/translations/es-ES/content/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise.md index d378abebb850..3e14720e63df 100644 --- a/translations/es-ES/content/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise.md +++ b/translations/es-ES/content/billing/managing-your-license-for-github-enterprise/troubleshooting-license-usage-for-github-enterprise.md @@ -1,6 +1,6 @@ --- -title: Troubleshooting license usage for GitHub Enterprise -intro: You can troubleshoot license usage for your enterprise by auditing license reports. +title: Solucionar problemas de uso de licencia para GitHub Enterprise +intro: Puedes solucionar los problemas con el uso de licencia para tu empresa si auditas los reportes de licencia. permissions: 'Enterprise owners can review license usage for {% data variables.product.prodname_enterprise %}.' versions: ghec: '*' @@ -9,26 +9,26 @@ type: how_to topics: - Enterprise - Licensing -shortTitle: Troubleshoot license usage +shortTitle: Solucionar el uso de licencia --- -## About unexpected license usage +## Acerca del uso de licencia inesperado -If the number of consumed licenses for your enterprise is unexpected, you can review your consumed license report to audit your license usage across all your enterprise deployments and subscriptions. Para obtener más información, consulta la sección "[Ver el uso de licencia para GitHub Enterprise](/billing/managing-your-license-for-github-enterprise/viewing-license-usage-for-github-enterprise)" y "[Ver la suscripción y el uso de tu cuenta empresarial](/billing/managing-billing-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account)". +Si la cantidad de licencias consumidas para tu empresa es inesperada, puedes revisar tu reporte de licencias consumidas para auditar tu uso de licencia en todos los despliegues y suscripciones de tu empresa. Para obtener más información, consulta la sección "[Ver el uso de licencia para GitHub Enterprise](/billing/managing-your-license-for-github-enterprise/viewing-license-usage-for-github-enterprise)" y "[Ver la suscripción y el uso de tu cuenta empresarial](/billing/managing-billing-for-your-github-account/viewing-the-subscription-and-usage-for-your-enterprise-account)". -If you find errors, you can try troubleshooting steps. +Si encuentras errores, puedes intentar solucionar los problemas de los pasos. -For privacy reasons, enterprise owners cannot directly access the details of user accounts unless you use {% data variables.product.prodname_emus %}. +Por razones de privacidad, los propietarios de las empresas no pueden acceder directamente a los detalles de las cuentas de usuario a menos de que utilices {% data variables.product.prodname_emus %}. -## About the calculation of consumed licenses +## Acerca del cálculo de licencias consumidas -{% data variables.product.company_short %} bills for each person who uses deployments of {% data variables.product.prodname_ghe_server %}, is a member of one of your organizations on {% data variables.product.prodname_ghe_cloud %}, or is a {% data variables.product.prodname_vs_subscriber %}. For more information about the people in your enterprise who consume a license, see "[About per-user pricing](/billing/managing-billing-for-your-github-account/about-per-user-pricing)." +{% data variables.product.company_short %} factura por cada persona que utilice despliegues de {% data variables.product.prodname_ghe_server %}, que sea miembro de una de tus organizaciones en {% data variables.product.prodname_ghe_cloud %} o que sea un {% data variables.product.prodname_vs_subscriber %}. Para obtener más información sobre las personas de tu empresa que consumen licencias, consulta la sección "[Acerca de los precios por usuario](/billing/managing-billing-for-your-github-account/about-per-user-pricing)". -For each user to consume a single seat regardless of how many deployments they use, you must synchronize license usage between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %}. Para obtener más información, consulta la sección "[Sincronizar el uso de licencia entre {% data variables.product.prodname_ghe_server %} y {% data variables.product.prodname_ghe_cloud %}](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)". +Para que cada usuario consuma una sola plaza sin importar cuántos despliegues utilicen, debes sincronizar el uso de licencias entre {% data variables.product.prodname_ghe_server %} y {% data variables.product.prodname_ghe_cloud %}. Para obtener más información, consulta la sección "[Sincronizar el uso de licencia entre {% data variables.product.prodname_ghe_server %} y {% data variables.product.prodname_ghe_cloud %}](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)". -After you synchronize license usage, {% data variables.product.prodname_dotcom %} matches user accounts on {% data variables.product.prodname_ghe_server %} with user accounts on {% data variables.product.prodname_ghe_cloud %} by email address. +Después de que sincronizas el uso de licencia, {% data variables.product.prodname_dotcom %} empata las cuentas de usuario en {% data variables.product.prodname_ghe_server %} con las cuentas de usuario en {% data variables.product.prodname_ghe_cloud %} por dirección de correo electrónico. -First, we first check the primary email address of each user on {% data variables.product.prodname_ghe_server %}. Then, we attempt to match that address with the email address for a user account on {% data variables.product.prodname_ghe_cloud %}. If your enterprise uses SAML SSO, we first check the following SAML attributes for email addresses. +Primero, revisa la dirección de correo electrónico principal de cada usuario en {% data variables.product.prodname_ghe_server %}. Después, intenta empatar dicha dirección con la de correo electrónico para una cuenta de usuario de {% data variables.product.prodname_ghe_cloud %}. Si tu empresa utiliza el SSO de SAML, primero hay que verificar los siguientes atributos de SAML para las direcciones de correo electrónco. - `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name` - `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` @@ -36,64 +36,64 @@ First, we first check the primary email address of each user on {% data variable - `ID del nombre` - `emails` -If no email addresses found in these attributes match the primary email address on {% data variables.product.prodname_ghe_server %}, or if your enterprise doesn't use SAML SSO, we then check each of the user's verified email addresses on {% data variables.product.prodname_ghe_cloud %}. Para obtener más información sobre la verificación de las direcciones de correo electrónico de {% data variables.product.prodname_dotcom_the_website %}, consulta la sección "[Verificar tu dirección de correo electrónico](/enterprise-cloud@latest/get-started/signing-up-for-github/verifying-your-email-address){% ifversion not ghec %}" en la documentación de {% data variables.product.prodname_ghe_cloud %}.{% else %}".{% endif %} +Si no hay ninguna dirección de correo electrónico en estos atributos que empate con la dirección primaria en {% data variables.product.prodname_ghe_server %} o si tu empresa no utiliza el SSO de SAML, entonces podemos verificar cada una de las direcciones de correo electrónico verificadas de los usuarios en {% data variables.product.prodname_ghe_cloud %}. Para obtener más información sobre la verificación de las direcciones de correo electrónico de {% data variables.product.prodname_dotcom_the_website %}, consulta la sección "[Verificar tu dirección de correo electrónico](/enterprise-cloud@latest/get-started/signing-up-for-github/verifying-your-email-address){% ifversion not ghec %}" en la documentación de {% data variables.product.prodname_ghe_cloud %}.{% else %}".{% endif %} -## Fields in the consumed license files +## Campos en los archivos de licencia consumidos -The {% data variables.product.prodname_dotcom_the_website %} license usage report and {% data variables.product.prodname_ghe_server %} exported license usage file include a variety of fields to help you troubleshoot license usage for your enterprise. +El reporte de uso de licencia en {% data variables.product.prodname_dotcom_the_website %} y el archivo de uso de licencia exportado de {% data variables.product.prodname_ghe_server %} incluyen varios campos para ayudarte a solucionar los problemas de uso de licencia para tu empresa. -### {% data variables.product.prodname_dotcom_the_website %} license usage report (CSV file) +### Reporte de uso de licencia de {% data variables.product.prodname_dotcom_the_website %} (archivo CSV) -The license usage report for your enterprise is a CSV file that contains the following information about members of your enterprise. Some fields are specific to your {% data variables.product.prodname_ghe_cloud %} (GHEC) deployment, {% data variables.product.prodname_ghe_server %} (GHES) connected environments, or your {% data variables.product.prodname_vs %} subscriptions (VSS) with GitHub Enterprise. +El reporte de uso de licencia para tu empresa es un archivo CSV que contiene la siguiente información sobre los miembros de tu empresa. Algunos campos son específicos para tu despliegue de {% data variables.product.prodname_ghe_cloud %} (GHEC), ambientes conectados de {% data variables.product.prodname_ghe_server %} (GHES) o para tus suscripciones de {% data variables.product.prodname_vs %} (VSS) con GitHub Enterprise. -| Campo | Descripción | -| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| github_com_login | The username for the user's GHEC account | -| github_com_name | The display name for the user's GHEC account | -| github_com_profile | The URL for the user's profile page on GHEC | -| github_com_user | Whether or not the user has an account on GHEC | -| github_com_member_roles | For each of the organizations the user belongs to on GHEC, the organization name and the user's role in that organization (`Owner` or `Member`) separated by a colon

Organizations delimited by commas | -| github_com_enterprise_role | Can be one of: `Owner`, `Member`, or `Outside collaborator` | -| github_com_verified_domain_emails | All email addresses associated with the user's GHEC account that match your enterprise's verified domains | -| github_com_saml_name_id | The SAML username | -| github_com_orgs_with_pending_invites | All pending invitations for the user's GHEC account to join organizations within your enterprise | -| license_type | Can be one of: `Visual Studio subscription` or `Enterprise` | -| enterprise_server_user | Whether or not the user has at least one account on GHES | -| enterprise_server_primary_emails | The primary email addresses associated with each of the user's GHES accounts | -| enterprise_server_user_ids | For each of the user's GHES accounts, the account's user ID | -| total_user_accounts | The total number of accounts the person has across both GHEC and GHES | -| visual_studio_subscription_user | Whether or not the user is a {% data variables.product.prodname_vs_subscriber %} -| visual_studio_subscription_email | The email address associated with the user's VSS | -| visual_studio_license_status | Whether the Visual Studio license has been matched to a {% data variables.product.company_short %} user | +| Campo | Descripción | +| ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| github_com_login | El nombre de usuario para la cuenta de GHEC del usuario | +| github_com_name | El nombre para mostrar de la cuenta de GHEC del usuario | +| github_com_profile | La URL para la página de perfil del usuario en GHEC | +| github_com_user | Si el usuario tiene una cuenta en GHEC o no | +| github_com_member_roles | Para cada una de las organizaciones a las cuales pertenece el usuario en GHEC, el nombre de organización y el rol del usuario en dicha organización (`Owner` o `Member`) separado por dos puntos

Las organizaciones se delimitan con comas | +| github_com_enterprise_role | Puede ser una de entre: `Owner`, `Member`, o `Outside collaborator` | +| github_com_verified_domain_emails | Todas las direcciones de correo electrónico asociadas con la cuenta de GHEC del usuario que empaten con los dominios verificados de tu empresa | +| github_com_saml_name_id | El nombre de usuario de SAML | +| github_com_orgs_with_pending_invites | Todas las invitaciones pendientes para que la cuenta de GHEC del usuario se una a organizaciones dentro de tu empresa | +| license_type | Puede ser una de entre: `Visual Studio subscription` o `Enterprise` | +| enterprise_server_user | Si el usuario tiene por lo menos una cuenta en GHES o no | +| enterprise_server_primary_emails | Las direcciones de correo electrónico principales asociadas con cada una de las cuentas de GHES del usuario | +| enterprise_server_user_ids | La ID de usuario de cada una de las cuentas de GHES del usuario | +| total_user_accounts | La cantidad total de cuentas que tiene la persona tanto en GHEC como en GHES | +| visual_studio_subscription_user | Si el usuario es un {% data variables.product.prodname_vs_subscriber %} o no | +| visual_studio_subscription_email | La dirección de correo electrónico asociada con el VSS del usuario | +| visual_studio_license_status | Si la licencia de Visual Studio empató con un usuario de {% data variables.product.company_short %} o no | -{% data variables.product.prodname_vs_subscriber %}s who are not yet members of at least one organization in your enterprise will be included in the report with a pending invitation status, and will be missing values for the "Name" or "Profile link" field. +Los {% data variables.product.prodname_vs_subscriber %}es que aún no son miembros de por lo menos una organización en tu empresa se incluirán en el reporte con un estado de invitación pendiente y serán valores faltantes para el campo de "Nombre" o "Enlace de perfil". -### {% data variables.product.prodname_ghe_server %} exported license usage (JSON file) +### Uso de licencia de {% data variables.product.prodname_ghe_server %} exportada (archivo JSON) -Your {% data variables.product.prodname_ghe_server %} license usage is a JSON file that is typically used when performing a manual sync of user licenses between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %} deployments. The file contains the following information specific to your {% data variables.product.prodname_ghe_server %} environment. +Tu uso de licencia de {% data variables.product.prodname_ghe_server %} es un archivo de JSON que se utiliza habitualmente al realizar una sincronización manual de licencias de usuario entre despliegues de {% data variables.product.prodname_ghe_server %} y de {% data variables.product.prodname_ghe_cloud %}. El archivo contiene la siguiente información específica para tu ambiente de {% data variables.product.prodname_ghe_server %}. -| Campo | Descripción | -| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Características | The {% data variables.product.prodname_github_connect %} features that are enabled on your {% data variables.product.prodname_ghe_server %} instance, and the date and time of enablement. | -| Host name | The hostname of your {% data variables.product.prodname_ghe_server %} instance. | -| HTTP only | Whether Transport Layer Security (TLS) is enabled and configured on your {% data variables.product.prodname_ghe_server %} instance. Can be one of: `True` or `False`. | -| Licencia | Un hash de tu licencia {% data variables.product.prodname_ghe_server %}. | -| Public key | La parte pública de la clave de tu licencia {% data variables.product.prodname_ghe_server %}. | -| Server ID | UUID generated for your {% data variables.product.prodname_ghe_server %} instance. | -| Versión | The version of your {% data variables.product.prodname_ghe_server %} instance. | +| Campo | Descripción | +| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Características | Las características de {% data variables.product.prodname_github_connect %} que están habilitadas en tu instancia de {% data variables.product.prodname_ghe_server %} y la fecha y hora de la habilitación. | +| Host name | El nombre de host de tu instancia de {% data variables.product.prodname_ghe_server %}. | +| HTTP only | Si se habilitó y configuró la Seguridad de Capa de Transporte (TLS) en tu instancia de {% data variables.product.prodname_ghe_server %}. Puede ser uno de entre: `True` o `False`. | +| Licencia | Un hash de tu licencia {% data variables.product.prodname_ghe_server %}. | +| Public key | La parte pública de la clave de tu licencia {% data variables.product.prodname_ghe_server %}. | +| Server ID | La UUID generada para tu instancia de {% data variables.product.prodname_ghe_server %}. | +| Versión | La versión de tu instancia de {% data variables.product.prodname_ghe_server %}. | -## Troubleshooting consumed licenses +## Solucionar problemas de las licencias consumidas -To ensure that the each user is only consuming a single seat for different deployments and subscriptions, try the following troubleshooting steps. +Para garantizar que cada usuario solo consume una sola plaza para los diversos despliegues y suscripciones, intenta tomas los siguientes pasos. -1. To help identify users that are consuming multiple seats, if your enterprise uses verified domains for {% data variables.product.prodname_ghe_cloud %}, review the list of enterprise members who do not have an email address from a verified domain associated with their account on {% data variables.product.prodname_dotcom_the_website %}. Often, these are the users who erroneously consume more than one licensed seat. Para obtener más información, consulta la sección "[Ver a los miembros sin un a dirección de correo electrónico desde un dominio verificado](/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise#viewing-members-without-an-email-address-from-a-verified-domain)". +1. Para ayudar a identificar a los usuarios que están consumiendo varias plazas, si tu empresa utiliza los dominios verificados para {% data variables.product.prodname_ghe_cloud %}, revisa la lista de miembros empresariales que no tienen una dirección de correo electrónico de un dominio verificado y asociado con su cuenta en {% data variables.product.prodname_dotcom_the_website %}. A menudo, estos son los usuarios que consumen más de una plaza con licencia por error. Para obtener más información, consulta la sección "[Ver a los miembros sin un a dirección de correo electrónico desde un dominio verificado](/admin/user-management/managing-users-in-your-enterprise/viewing-people-in-your-enterprise#viewing-members-without-an-email-address-from-a-verified-domain)". {% note %} - **Note:** To make troubleshooting easier, we recommend using verified domains with your enterprise account on {% data variables.product.prodname_dotcom_the_website %}. Para obtener más información, consulta la sección "[Verificar o aprobar un dominio para tu empresa](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)". + **Nota:** Para facilitar la solución de problemas, te recomendamos utilizar dominios verificados con tu cuenta empresarial en {% data variables.product.prodname_dotcom_the_website %}. Para obtener más información, consulta la sección "[Verificar o aprobar un dominio para tu empresa](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)". {% endnote %} -1. After you identify users who are consuming multiple seats, make sure that the same email address is associated with all of the user's accounts. For more information about which email addresses must match, see "[About the calculation of consumed licenses](#about-the-calculation-of-consumed-licenses)." -1. If an email address was recently updated or verified to correct a mismatch, view the timestamp of the last license sync job. If a job hasn't run since the correction was made, manually trigger a new job. For more information, see "[Syncing license usage between GitHub Enterprise Server and GitHub Enterprise Cloud](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)." +1. Después de que identifiques a los usuarios que están consumiendo varias plazas, asegúrate de que la misma dirección de correo electrónico esté asociada con todas las cuentas de usuario. Para obtener más información sobre qué direcciones de correo electrónico deben coincidir, consulta la sección "[Acerca del cálculo de las licencias consumidas](#about-the-calculation-of-consumed-licenses)". +1. Si se actualizó o verificó recientemente una dirección de correo electrónico para corregir un desajuste, ve la marca de tiempo del último job de sincronización de licencia. Si un job no se ha ejecutado desde que se realizó la corrección, activa un job nuevo manualmente. Para obtener más información, consulta la sección "[Sincronizar el uso de licencia entre GitHub Enterprise Server y GitHub Enterprise Cloud](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud)". -If you still have questions about your consumed licenses after reviewing the troubleshooting information above, you can contact {% data variables.contact.github_support %} through the {% data variables.contact.contact_enterprise_portal %}. +Si aún tienes preguntas sobre tus licencias consumidas después de revisar la información de solución de problemas anterior, puedes contactar a {% data variables.contact.github_support %} a través del {% data variables.contact.contact_enterprise_portal %}. diff --git a/translations/es-ES/content/code-security/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning.md b/translations/es-ES/content/code-security/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning.md index fa57403bd232..62c798ddf3bd 100644 --- a/translations/es-ES/content/code-security/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning.md +++ b/translations/es-ES/content/code-security/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning.md @@ -19,7 +19,7 @@ Este artículo es parte de una serie de cómo adoptar la {% data variables.produ ### Habilitar el escaneo de código -Using the data you collated in [Phase 2](/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale), you can begin to enable GHAS and then {% data variables.product.prodname_code_scanning %} on your repositories, one language at a time. The step-by-step process for enabling GHAS should look like this: +Utilizando los datos que recolectaste en la [Fase 2](/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale), puedes comenzar a habilitar la GHAS y luego el {% data variables.product.prodname_code_scanning %} en tus repositorios, un lenguaje a la vez. The step-by-step process for enabling GHAS should look like this: 1. Enable GHAS on the repository. Para obtener más información, consulta la sección "[Administrar la configuración de seguridad y análisis para tu repositorio](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)". 1. Create a pull request against the repository's default branch with a `codeql-analysis.yml` file containing an example of how to run CodeQL for that language. Para obtener más información, consulta la sección"[Crear una solicitud de extracción](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)." diff --git a/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md b/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md index 89a7a591d444..693aff8c64ec 100644 --- a/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md +++ b/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md @@ -359,7 +359,7 @@ In the following example, the `+` symbol ensures that the specified additional { ## Using a custom configuration file -A custom configuration file is an alternative way to specify additional {% ifversion codeql-packs %}packs and {% endif %}queries to run. You can also use the file to disable the default queries and to specify which directories to scan during analysis. +A custom configuration file is an alternative way to specify additional {% ifversion codeql-packs %}packs and {% endif %}queries to run. You can also use the file to disable the default queries{% ifversion code-scanning-exclude-queries-from-analysis %}, exclude or include specific queries,{% endif %} and to specify which directories to scan during analysis. In the workflow file, use the `config-file` parameter of the `init` action to specify the path to the configuration file you want to use. This example loads the configuration file _./.github/codeql/codeql-config.yml_. @@ -442,6 +442,41 @@ Optionally, you can give each array element a name, as shown in the example conf If you only want to run custom queries, you can disable the default security queries by using `disable-default-queries: true`. +{% ifversion code-scanning-exclude-queries-from-analysis %} +### Excluding specific queries from analysis + +You can add `exclude` and `include` filters to your custom configuration file, to specify the queries you want to exclude or include in the analysis. + +This is useful if you want to exclude, for example: +- Specific queries from the default suites (`security`, `security-extended` and `security-and-quality`). +- Specific queries whose results do not interest you. +- All the queries that generate warnings and recommendations. + +You can use `exclude` filters similar to those in the configuration file below to exclude queries that you want to remove from the default analysis. In the example of configuration file below, both the `js/redundant-assignment` and the `js/useless-assignment-to-local` queries are excluded from analysis. + +```yaml +query-filters: + - exclude: + id: js/redundant-assignment + - exclude: + id: js/useless-assignment-to-local +``` +To find the id of a query, you can click the alert in the list of alerts in the Security tab. This opens the alert details page. The `Rule ID` field contains the query id. For more information about the alert details page, see "[About {% data variables.product.prodname_code_scanning %} alerts](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts#about-alert-details)." + +{% tip %} + +**Tips:** +- The order of the filters is important. The first filter instruction that appears after the instructions about the queries and query packs determines whether the queries are included or excluded by default. +- Subsequent instructions are executed in order and the instructions that appear later in the file take precedence over the earlier instructions. + +{% endtip %} + +You can find another example illustrating the use of these filters in the "[Example configuration files](#example-configuration-files)" section. + +For more information about using `exclude` and `include` filters in your custom configuration file, see "[Creating {% data variables.product.prodname_codeql %} query suites](https://codeql.github.com/docs/codeql-cli/creating-codeql-query-suites/#filtering-the-queries-in-a-query-suite)." For information on the query metadata you can filter on, see "[Metadata for CodeQL queries](https://codeql.github.com/docs/writing-codeql-queries/metadata-for-codeql-queries/)." + +{% endif %} + ### Specifying directories to scan For the interpreted languages that {% data variables.product.prodname_codeql %} supports (Python{% ifversion fpt or ghes > 3.3 or ghae-issue-5017 %}, Ruby{% endif %} and JavaScript/TypeScript), you can restrict {% data variables.product.prodname_code_scanning %} to files in specific directories by adding a `paths` array to the configuration file. You can exclude the files in specific directories from analysis by adding a `paths-ignore` array. diff --git a/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md b/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md index a5948aba46cb..23e20a25a332 100644 --- a/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md +++ b/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md @@ -43,8 +43,8 @@ By default, the code scanning alerts page is filtered to show alerts for the def ![Summary of alerts](/assets/images/help/repository/code-scanning-click-alert.png) {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %} - {% data reusables.code-scanning.alert-default-branch %} - ![The "Affected branches" section in an alert](/assets/images/help/repository/code-scanning-affected-branches.png){% endif %} + {% data reusables.code-scanning.alert-default-branch %} + ![The "Affected branches" section in an alert](/assets/images/help/repository/code-scanning-affected-branches.png){% endif %} 1. Optionally, if the alert highlights a problem with data flow, click **Show paths** to display the path from the data source to the sink where it's used. {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %} ![The "Show paths" link on an alert](/assets/images/help/repository/code-scanning-show-paths.png) diff --git a/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md b/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md index 52e0b98fd34f..32cea9db26fa 100644 --- a/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md +++ b/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md @@ -151,25 +151,29 @@ The names of the {% data variables.product.prodname_code_scanning %} analysis ch ![{% data variables.product.prodname_code_scanning %} pull request checks](/assets/images/help/repository/code-scanning-pr-checks.png) -When the {% data variables.product.prodname_code_scanning %} jobs complete, {% data variables.product.prodname_dotcom %} works out whether any alerts were added by the pull request and adds the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" entry to the list of checks. After {% data variables.product.prodname_code_scanning %} has been performed at least once, you can click **Details** to view the results of the analysis. If you used a pull request to add {% data variables.product.prodname_code_scanning %} to the repository, you will initially see {% ifversion fpt or ghes > 3.2 or ghae or ghec %}an "Analysis not found"{% else %}a "Missing analysis"{% endif %} message when you click **Details** on the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" check. +When the {% data variables.product.prodname_code_scanning %} jobs complete, {% data variables.product.prodname_dotcom %} works out whether any alerts were added by the pull request and adds the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" entry to the list of checks. After {% data variables.product.prodname_code_scanning %} has been performed at least once, you can click **Details** to view the results of the analysis. -{% ifversion fpt or ghes > 3.2 or ghae or ghec %} - ![Analysis not found for commit message](/assets/images/help/repository/code-scanning-analysis-not-found.png) +{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-7095 %} + +{% elsif ghes < 3.5 or ghae %} +If you used a pull request to add {% data variables.product.prodname_code_scanning %} to the repository, you will initially see {% ifversion ghes > 3.2 or ghae %}an "Analysis not found"{% elsif ghes = 3.2 %}a "Missing analysis"{% endif %} message when you click **Details** on the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" check. + +{% ifversion ghes > 3.2 or ghae %} + ![Analysis not found for commit message](/assets/images/enterprise/3.4/repository/code-scanning-analysis-not-found.png) The table lists one or more categories. Each category relates to specific analyses, for the same tool and commit, performed on a different language or a different part of the code. For each category, the table shows the two analyses that {% data variables.product.prodname_code_scanning %} attempted to compare to determine which alerts were introduced or fixed in the pull request. For example, in the screenshot above, {% data variables.product.prodname_code_scanning %} found an analysis for the merge commit of the pull request, but no analysis for the head of the main branch. -{% else %} - ![Missing analysis for commit message](/assets/images/enterprise/3.2/repository/code-scanning-missing-analysis.png) -{% endif %} -{% ifversion fpt or ghes > 3.2 or ghae or ghec %} ### Reasons for the "Analysis not found" message -{% else %} + +{% elsif ghes = 3.2 %} + ![Missing analysis for commit message](/assets/images/enterprise/3.2/repository/code-scanning-missing-analysis.png) + ### Reasons for the "Missing analysis" message {% endif %} -After {% data variables.product.prodname_code_scanning %} has analyzed the code in a pull request, it needs to compare the analysis of the topic branch (the branch you used to create the pull request) with the analysis of the base branch (the branch into which you want to merge the pull request). This allows {% data variables.product.prodname_code_scanning %} to compute which alerts are newly introduced by the pull request, which alerts were already present in the base branch, and whether any existing alerts are fixed by the changes in the pull request. Initially, if you use a pull request to add {% data variables.product.prodname_code_scanning %} to a repository, the base branch has not yet been analyzed, so it's not possible to compute these details. In this case, when you click through from the results check on the pull request you will see the {% ifversion fpt or ghes > 3.2 or ghae or ghec %}"Analysis not found"{% else %}"Missing analysis for base commit SHA-HASH"{% endif %} message. +After {% data variables.product.prodname_code_scanning %} has analyzed the code in a pull request, it needs to compare the analysis of the topic branch (the branch you used to create the pull request) with the analysis of the base branch (the branch into which you want to merge the pull request). This allows {% data variables.product.prodname_code_scanning %} to compute which alerts are newly introduced by the pull request, which alerts were already present in the base branch, and whether any existing alerts are fixed by the changes in the pull request. Initially, if you use a pull request to add {% data variables.product.prodname_code_scanning %} to a repository, the base branch has not yet been analyzed, so it's not possible to compute these details. In this case, when you click through from the results check on the pull request you will see the {% ifversion ghes > 3.2 or ghae %}"Analysis not found"{% elsif ghes = 3.2 %}"Missing analysis for base commit SHA-HASH"{% endif %} message. There are other situations where there may be no analysis for the latest commit to the base branch for a pull request. These include: @@ -177,7 +181,7 @@ There are other situations where there may be no analysis for the latest commit To check whether a branch has been scanned, go to the {% data variables.product.prodname_code_scanning_capc %} page, click the **Branch** drop-down and select the relevant branch. -![Choose a branch from the Branch drop-down menu](/assets/images/help/repository/code-scanning-branch-dropdown.png) + ![Choose a branch from the Branch drop-down menu](/assets/images/help/repository/code-scanning-branch-dropdown.png) The solution in this situation is to add the name of the base branch to the `on:push` and `on:pull_request` specification in the {% data variables.product.prodname_code_scanning %} workflow on that branch and then make a change that updates the open pull request that you want to scan. @@ -189,6 +193,8 @@ There are other situations where there may be no analysis for the latest commit Merge a trivial change into the base branch to trigger {% data variables.product.prodname_code_scanning %} on this latest commit, then push a change to the pull request to retrigger {% data variables.product.prodname_code_scanning %}. +{% endif %} + ## Next steps After setting up {% data variables.product.prodname_code_scanning %}, and allowing its actions to complete, you can: diff --git a/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md b/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md index c983e246ac18..5cad113a821a 100644 --- a/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md +++ b/translations/es-ES/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md @@ -33,8 +33,6 @@ In repositories where {% data variables.product.prodname_code_scanning %} is con - The **Conversation** tab of the pull request, as part of a pull request review {% endif %} - The **Files changed** tab of the pull request -{% ifversion code-scanning-pr-conversations-tab %} {% endif %} - If you have write permission for the repository, you can see any existing {% data variables.product.prodname_code_scanning %} alerts on the **Security** tab. For information about repository alerts, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)." {% ifversion fpt or ghes > 3.2 or ghae or ghec %} diff --git a/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md b/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md index daeb17e4833c..74df7049d25c 100644 --- a/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md +++ b/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md @@ -45,9 +45,15 @@ If you upload a second SARIF file for a commit with the same category and from t If you're new to SARIF and want to learn more, see Microsoft's [`SARIF tutorials`](https://github.com/microsoft/sarif-tutorials) repository. -## Preventing duplicate alerts using fingerprints +## Providing data to track {% data variables.product.prodname_code_scanning %} alerts across runs -Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the right line of code when files are edited. +Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the correct line of code when files are edited. The `ruleID` for a result has to be the same across analysis. + +### Reporting consistent filepaths + +The filepath has to be consistent across the runs to enable a computation of a stable fingerprint. If the filepaths differ for the same result, each time there is a new analysis a new alert will be created, and the old one will be closed. This will cause having multiple alerts for the same result. + +### Including data for fingerprint generation {% data variables.product.prodname_dotcom %} uses the `partialFingerprints` property in the OASIS standard to detect when two results are logically identical. For more information, see the "[partialFingerprints property](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012611)" entry in the OASIS documentation. @@ -77,6 +83,12 @@ You can check a SARIF file is compatible with {% data variables.product.prodname If you use a code analysis engine other than {% data variables.product.prodname_codeql %}, you can review the supported SARIF properties to optimize how your analysis results will appear on {% data variables.product.prodname_dotcom %}. +{% note %} + +**Note:** You must supply an explicit value for any property marked as "required". The empty string is not supported for required properties. + +{% endnote %} + Any valid SARIF 2.1.0 output file can be uploaded, however, {% data variables.product.prodname_code_scanning %} will only use the following supported properties. ### `sarifLog` object @@ -138,7 +150,7 @@ Each `result` object contains details for one alert in the codebase. Within the | `level`| **Optional.** The severity of the result. This level overrides the default severity defined by the rule. {% data variables.product.prodname_code_scanning_capc %} uses the level to filter results by severity on {% data variables.product.prodname_dotcom %}. | `message.text`| **Required.** A message that describes the result. {% data variables.product.prodname_code_scanning_capc %} displays the message text as the title of the result. Only the first sentence of the message will be displayed when visible space is limited. | `locations[]`| **Required.** The set of locations where the result was detected up to a maximum of 10. Only one location should be included unless the problem can only be corrected by making a change at every specified location. **Note:** At least one location is required for {% data variables.product.prodname_code_scanning %} to display a result. {% data variables.product.prodname_code_scanning_capc %} will use this property to decide which file to annotate with the result. Only the first value of this array is used. All other values are ignored. -| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Preventing duplicate alerts using fingerprints](#preventing-duplicate-alerts-using-fingerprints)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. +| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Providing data to track code scanning alerts across runs](#providing-data-to-track-code-scanning-alerts-across-runs)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. | `codeFlows[].threadFlows[].locations[]`| **Optional.** An array of `location` objects for a `threadFlow` object, which describes the progress of a program through a thread of execution. A `codeFlow` object describes a pattern of code execution used to detect a result. If code flows are provided, {% data variables.product.prodname_code_scanning %} will expand code flows on {% data variables.product.prodname_dotcom %} for the relevant result. For more information, see the [`location` object](#location-object). | `relatedLocations[]`| A set of locations relevant to this result. {% data variables.product.prodname_code_scanning_capc %} will link to related locations when they are embedded in the result message. For more information, see the [`location` object](#location-object). @@ -204,7 +216,7 @@ These example SARIF output files show supported properties and example values. ### Example with minimum required properties -This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties or don't include values, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. +This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties, omit values, or use an empty string, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. ```json { diff --git a/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md b/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md index 1e03a239f38e..193ee54f5aa9 100644 --- a/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md +++ b/translations/es-ES/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md @@ -58,7 +58,7 @@ For more information see the [`upload-sarif` action](https://github.com/github/c The `upload-sarif` action can be configured to run when the `push` and `scheduled` event occur. For more information about {% data variables.product.prodname_actions %} events, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." -If your SARIF file doesn't include `partialFingerprints`, the `upload-sarif` action will calculate the `partialFingerprints` field for you and attempt to prevent duplicate alerts. {% data variables.product.prodname_dotcom %} can only create `partialFingerprints` when the repository contains both the SARIF file and the source code used in the static analysis. For more information about preventing duplicate alerts, see "[About SARIF support for code scanning](/code-security/secure-coding/sarif-support-for-code-scanning#preventing-duplicate-alerts-using-fingerprints)." +If your SARIF file doesn't include `partialFingerprints`, the `upload-sarif` action will calculate the `partialFingerprints` field for you and attempt to prevent duplicate alerts. {% data variables.product.prodname_dotcom %} can only create `partialFingerprints` when the repository contains both the SARIF file and the source code used in the static analysis. For more information about preventing duplicate alerts, see "[About SARIF support for code scanning](/code-security/secure-coding/sarif-support-for-code-scanning#providing-data-to-track-code-scanning-alerts-across-runs)." {% data reusables.code-scanning.upload-sarif-alert-limit %} diff --git a/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md b/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md index 54ca86d3afa0..a9c8d47e23ff 100644 --- a/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md +++ b/translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md @@ -78,7 +78,8 @@ You can display the command-line help for any command using the `--help``--command` | | Recommended. Use to specify the build command or script that invokes the build process for the codebase. Commands are run from the current folder or, where it is defined, from `--source-root`. Not needed for Python and JavaScript/TypeScript analysis. | | `--db-cluster` | | Optional. Use in multi-language codebases to generate one database for each language specified by `--language`. | `--no-run-unnecessary-builds` | | Recommended. Use to suppress the build command for languages where the {% data variables.product.prodname_codeql_cli %} does not need to monitor the build (for example, Python and JavaScript/TypeScript). -| `--source-root` | | Optional. Use if you run the CLI outside the checkout root of the repository. By default, the `database create` command assumes that the current directory is the root directory for the source files, use this option to specify a different location. | +| `--source-root` | | Optional. Use if you run the CLI outside the checkout root of the repository. By default, the `database create` command assumes that the current directory is the root directory for the source files, use this option to specify a different location. |{% ifversion fpt or ghec or ghes > 3.2 or ghae %} +| `--codescanning-config` | | Optional (Advanced). Use if you have a configuration file that specifies how to create the {% data variables.product.prodname_codeql %} databases and what queries to run in later steps. For more information, see "[Using a custom configuration file](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-a-custom-configuration-file)" and "[database create](https://codeql.github.com/docs/codeql-cli/manual/database-create/#cmdoption-codeql-database-create-codescanning-config)." |{% endif %} For more information, see [Creating {% data variables.product.prodname_codeql %} databases](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/) in the documentation for the {% data variables.product.prodname_codeql_cli %}. diff --git a/translations/es-ES/content/code-security/dependabot/dependabot-alerts/browsing-security-advisories-in-the-github-advisory-database.md b/translations/es-ES/content/code-security/dependabot/dependabot-alerts/browsing-security-advisories-in-the-github-advisory-database.md index e4b621210dd1..983eb8443d07 100644 --- a/translations/es-ES/content/code-security/dependabot/dependabot-alerts/browsing-security-advisories-in-the-github-advisory-database.md +++ b/translations/es-ES/content/code-security/dependabot/dependabot-alerts/browsing-security-advisories-in-the-github-advisory-database.md @@ -74,7 +74,7 @@ El {% data variables.product.prodname_dependabot %} no crea {% data variables.pr ## About information in security advisories -Each security advisory contains information about the vulnerability{% ifversion GH-advisory-db-supports-malware %} or malware,{% endif %} which may include the description, severity, affected package, package ecosystem, affected versions and patched versions, impact, and optional information such as references, workarounds, and credits. Adicionalmente, las asesorías de la National Vulnerability Database contiene un enlace al registro de CVE, en donde puedes leer más sobre los detalles de la vulnerabilidad, su puntuación de CVSS y su nivel de severidad cualitativo. Para obtener más información, consulta la "[National Vulnerability Database](https://nvd.nist.gov/)" del Instituto Nacional de Estándares y Tecnología. +Cada asesoría de seguridad contiene información sobre la vulnerabilidad{% ifversion GH-advisory-db-supports-malware %} o malware,{% endif %} lo cual podría incluir la descripción, gravedad, paquete afectado, ecosistema del paquete, versiones afectadas y parchadas, impacto e información opcional tal como las referencias, soluciones alternativas y créditos. Adicionalmente, las asesorías de la National Vulnerability Database contiene un enlace al registro de CVE, en donde puedes leer más sobre los detalles de la vulnerabilidad, su puntuación de CVSS y su nivel de severidad cualitativo. Para obtener más información, consulta la "[National Vulnerability Database](https://nvd.nist.gov/)" del Instituto Nacional de Estándares y Tecnología. El nivel de gravedad es uno de cuatro niveles posibles que se definen en el [Sistema de clasificación de vulnerabilidades comunes (CVSS), Sección 5](https://www.first.org/cvss/specification-document)". - Bajo diff --git a/translations/es-ES/content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md b/translations/es-ES/content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md index 2e3b0e9caab3..fadd3dd370f9 100644 --- a/translations/es-ES/content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md +++ b/translations/es-ES/content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md @@ -84,22 +84,22 @@ Tu propietario de empresa puede habilitar o inhabilitar las {% data variables.pr {% data reusables.organizations.security-and-analysis %} 2. Debajo de "Análisis y seguridad del código", a la derecha de las {% data variables.product.prodname_dependabot_alerts %}, haz clic en **Inhabilitar todas** o **Habilitar todas**. {% ifversion fpt or ghec %} - ![Screenshot of "Configure security and analysis" features with the "Enable all" or "Disable all" button emphasized for Dependabot alerts](/assets/images/help/dependabot/dependabot-alerts-disable-or-enable-fpt.png) + ![Captura de pantalla de las características de "Configurar el análisis y la seguridad" con énfasis en el botón "Habilitar todo" o "Inhabilitar todo" para las alertas del Dependabot](/assets/images/help/dependabot/dependabot-alerts-disable-or-enable-fpt.png) {% endif %} {% ifversion ghae %} ![Botón de "Habilitar todo" o "Inhabilitar todo" para las características de "Configurar la seguridad y el análisis"](/assets/images/enterprise/github-ae/organizations/security-and-analysis-disable-or-enable-all-ghae.png) {% endif %} {% ifversion fpt or ghec %} -3. Optionally, enable {% data variables.product.prodname_dependabot_alerts %} by default for new repositories in your organization. +3. Opcionalmente, habilita las {% data variables.product.prodname_dependabot_alerts %} predeterminadas para los repositorios en tu organización. {% ifversion fpt or ghec %} - ![Screenshot of "Enable by default" option for new repositories](/assets/images/help/dependabot/dependabot-alerts-enable-by-default-organizations.png) + ![Captura de pantalla de la opción "Habilitar predeterminadamente" para los repositorios nuevos](/assets/images/help/dependabot/dependabot-alerts-enable-by-default-organizations.png) {% endif %} {% endif %} {% ifversion fpt or ghec %} -4. Click **Disable {% data variables.product.prodname_dependabot_alerts %}** or **Enable {% data variables.product.prodname_dependabot_alerts %}** to disable or enable {% data variables.product.prodname_dependabot_alerts %} for all the repositories in your organization. +4. Haz clic en **Inhabilitar las {% data variables.product.prodname_dependabot_alerts %}** o **Habilitar las {% data variables.product.prodname_dependabot_alerts %}** para inhabilitar o habilitar las {% data variables.product.prodname_dependabot_alerts %} para todos los repositorios de tu organización. {% ifversion fpt or ghec %} - ![Screenshot of "Enable Dependabot alerts" modal with button to disable or enable feature emphasized](/assets/images/help/dependabot/dependabot-alerts-enable-dependabot-alerts-organizations.png) + ![Captura de pantalla del modal "Habilitar las alertas del dependabot" con énfasis en el botón de la característica de inhabilitar o habilitar](/assets/images/help/dependabot/dependabot-alerts-enable-dependabot-alerts-organizations.png) {% endif %}{% endif %}{% endif %}{% ifversion ghes or ghae %} -{% data variables.product.prodname_dependabot_alerts %} for your organization can be enabled or disabled by your enterprise owner. For more information, see "[About Dependabot for GitHub Enterprise Server](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)." +El propietario de tu empresa puede habilitar o inhabilitar las {% data variables.product.prodname_dependabot_alerts %} para tu organización. Para obtener más información, consulta la sección "[Acerca del Dependabot para GitHub Enterprise Server](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)". {% endif %} diff --git a/translations/es-ES/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md b/translations/es-ES/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md index 3e64fdf9892b..4a5b64cab575 100644 --- a/translations/es-ES/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md +++ b/translations/es-ES/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md @@ -164,9 +164,9 @@ Si programas mucho trabajo para actualizar una dependencias o decides que una al 1. Ver los detalles de una alerta. Para obtener más información, consulta la sección "[Ver las dependencias vulnerables](#viewing-dependabot-alerts)" (anteriormente). 1. Selecciona el menú desplegable de "Descartar" y haz clic en una razón para descartar la alerta.{% ifversion reopen-dependabot-alerts %} Las alertas descartadas sin fijar pueden volverse a abrir posteriormente.{% endif %} -{% ifversion dependabot-alerts-dismissal-comment %}1. Optionally, add a dismissal comment. The dismissal comment will be added to the alert timeline and can be used as justification during auditing and reporting. You can retrieve or set a comment by using the GraphQL API. The comment is contained in the `dismissComment` field. For more information, see "[{% data variables.product.prodname_dependabot_alerts %}](/graphql/reference/objects#repositoryvulnerabilityalert)" in the GraphQL API documentation. - ![Screenshot showing how to dismiss an alert via the "Dismiss" drop-down, with the option to add a dismissal comment](/assets/images/help/repository/dependabot-alerts-dismissal-comment.png) -1. Click **Dismiss alert**. +{% ifversion dependabot-alerts-dismissal-comment %}1. Optionally, add a dismissal comment. The dismissal comment will be added to the alert timeline and can be used as justification during auditing and reporting. You can retrieve or set a comment by using the GraphQL API. El comentario se contiene en el campo `dismissComment`. Para obtener más información, consulta la sección "[{% data variables.product.prodname_dependabot_alerts %}](/graphql/reference/objects#repositoryvulnerabilityalert)" en la documentación de la API de GraphQL. + ![Captura de pantalla que muestra cómo descartar una alerta a través del menú desplegable de "Descartar" con la opción para agregar un comentario de destitución](/assets/images/help/repository/dependabot-alerts-dismissal-comment.png) +1. Haz clic en **Descargar alerta**. {% else %} ![Elegir una razón para descartar la alerta a través del menú desplegable de "Descartar"](/assets/images/help/repository/dependabot-alert-dismiss-drop-down-ungrouped.png){% endif %} {% ifversion dependabot-bulk-alerts %} diff --git a/translations/es-ES/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md b/translations/es-ES/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md index 705eb03d2b3a..ff3e91456dba 100644 --- a/translations/es-ES/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md +++ b/translations/es-ES/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md @@ -416,7 +416,7 @@ updates: ### `open-pull-requests-limit` -Predeterminadamente, {% data variables.product.prodname_dependabot %} abre un máximo de cinco solicitudes de extracción para las actualizaciones de versión. Una vez que hayan cinco solicitudes de cambio abiertas, las solicitudes nuevas se bloquearán hasta que fusiones o cierres algunas de las sollicitudes abiertas, después de lo cual, las solicitudes de cambiso nuevas pueden abrirse en actualizaciones subsecuentes. Utiliza `open-pull-requests-limit` para cambiar este límite. Esto también proporciona una forma simple de inhabilitar temporalmente las actualizaciones de versión para un administrador de paquete. +Predeterminadamente, {% data variables.product.prodname_dependabot %} abre un máximo de cinco solicitudes de extracción para las actualizaciones de versión. Once there are five open pull requests from {% data variables.product.prodname_dependabot %}, {% data variables.product.prodname_dependabot %} will not open any new requests until some of those open requests are merged or closed. Utiliza `open-pull-requests-limit` para cambiar este límite. Esto también proporciona una forma simple de inhabilitar temporalmente las actualizaciones de versión para un administrador de paquete. Esta opción no tiene impacto en las actualizaciones de seguridad que tienen un límite separado e interno de diez solicitudes de extracción abiertas. diff --git a/translations/es-ES/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md b/translations/es-ES/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md index ce00960daf6e..bfa80cfbc510 100644 --- a/translations/es-ES/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md +++ b/translations/es-ES/content/code-security/secret-scanning/protecting-pushes-with-secret-scanning.md @@ -62,27 +62,27 @@ Se mostrarán hasta cinco secretos detectados a la vez en la línea de comandos. {% ifversion push-protection-custom-link-orgs %} -Organization admins can provide a custom link that will be displayed when a push is blocked. This custom link can contain organization-specific resources and advice, such as directions on using a recommended secrets vault or who to contact for questions relating to the blocked secret. +Los administradores de las organizaciones pueden proporcionar un enlace personalizado que se mostrará cuando se bloquee una subida de información. Este enlace personalizado puede contener consejos y recursos específicos para la organización, tal como las instrucciones para utilizar una bóveda de secretos recomendada o a quién contactar para hacer preguntas relacionadas con el secreto bloqueado. {% ifversion push-protection-custom-link-orgs-beta %}{% data reusables.advanced-security.custom-link-beta %}{% endif %} -![Screenshot showing that a push is blocked when a user attempts to push a secret to a repository](/assets/images/help/repository/secret-scanning-push-protection-with-custom-link.png) +![Captura de pantalla que muestra que una subida está bloqueada cuando un usuario intenta subir un secreto a un repositorio](/assets/images/help/repository/secret-scanning-push-protection-with-custom-link.png) {% else %} -![Screenshot showing that a push is blocked when a user attempts to push a secret to a repository](/assets/images/help/repository/secret-scanning-push-protection-with-link.png) +![Captura de pantalla que muestra que una subida está bloqueada cuando un usuario intenta subir un secreto a un repositorio](/assets/images/help/repository/secret-scanning-push-protection-with-link.png) {% endif %} -{% data reusables.secret-scanning.push-protection-remove-secret %} For more information about remediating blocked secrets, see "[Pushing a branch blocked by push protection](/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection#resolving-a-blocked-push-on-the-command-line)." +{% data reusables.secret-scanning.push-protection-remove-secret %} Para obtener más información sobre los secretos de remediación bloqueados, consulta la sección "[Subir una rama que se bloqueó por una protección contra subida](/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection#resolving-a-blocked-push-on-the-command-line)". -If you confirm a secret is real and that you intend to fix it later, you should aim to remediate the secret as soon as possible. For example, you might revoke the secret and remove the secret from the repository's commit history. Real secrets that have been exposed must be revoked to avoid unauthorized access. You might consider first rotating the secret before revoking it. For more information, see "[Removing sensitive data from a repository](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)." +Si confirmas que un secreto es real y que pretendes corregirlo después, debes intentar remediarlo tan pronto como sea posible. Por ejemplo, podrías revocar el secreto y eliminarlo del historial de confirmaciones del repositorio. Los secretos reales que se expusieron deben revocarse para evitar un acceso no autorizado. Podrías considerar rotar el secreto primero antes de revocarlo. Para obtener más información, consulta la sección "[Eliminar datos confidenciales de un repositorio](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)". {% data reusables.secret-scanning.push-protection-multiple-branch-note %} ### Permitir que se suba un secreto bloqueado -If {% data variables.product.prodname_dotcom %} blocks a secret that you believe is safe to push, you can allow the secret and specify the reason why it should be allowed. +Si {% data variables.product.prodname_dotcom %} bloquea un secreto que piensas se puede subir con seguridad, puedes permitirlo y especificar la razón por la cual se debería de permitir. {% data reusables.secret-scanning.push-protection-allow-secrets-alerts %} @@ -98,33 +98,33 @@ If {% data variables.product.prodname_dotcom %} blocks a secret that you believe {% data reusables.secret-scanning.push-protection-web-ui-choice %} -{% data variables.product.prodname_dotcom %} will only display one detected secret at a time in the web UI. Si ya se detectó un secreto en particular en el repositorio y la alerta ya existe, {% data variables.product.prodname_dotcom %} no lo bloqueará. +{% data variables.product.prodname_dotcom %} solo mostrará un secreto detectado a la vez en la IU web. Si ya se detectó un secreto en particular en el repositorio y la alerta ya existe, {% data variables.product.prodname_dotcom %} no lo bloqueará. {% ifversion push-protection-custom-link-orgs %} -Organization admins can provide a custom link that will be displayed when a push is blocked. This custom link can contain resources and advice specific to your organization. For example, the custom link can point to a README file with information about the organization's secret vault, which teams and individuals to escalate questions to, or the organization's approved policy for working with secrets and rewriting commit history. +Los administradores de las organizaciones pueden proporcionar un enlace personalizado que se mostrará cuando se bloquee una subida de información. Este enlace personalizado puede contener recursos y consejos específicos para tu organización. Por ejemplo, el enlace personalizado puede apuntar a un archivo README con información sobre la bóveda de secretos de la organización, a qué individuos y equipos escalar las preguntas o la política aprobada de la organización para trabajar con secretos y reescribir el historial de confirmaciones. {% ifversion push-protection-custom-link-orgs-beta %}{% data reusables.advanced-security.custom-link-beta %}{% endif %} {% endif %} -You can remove the secret from the file using the web UI. Una vez que elimines el secreto, el letrero en la parte superior de la página cambiará y te dirá que ahora puedes confirmar tus cambios. +Puedes eliminar el secreto del archivo utilizando la IU web. Una vez que elimines el secreto, el letrero en la parte superior de la página cambiará y te dirá que ahora puedes confirmar tus cambios. - ![Screenshot showing commit in web ui allowed after secret fixed](/assets/images/help/repository/secret-scanning-push-protection-web-ui-commit-allowed.png) + ![Captura de pantalla que muestra la confirmación en la Iu web después de que se corrigió un secreto](/assets/images/help/repository/secret-scanning-push-protection-web-ui-commit-allowed.png) ### Saltar la protección contra subidas para un secreto -{% data reusables.secret-scanning.push-protection-remove-secret %} For more information about remediating blocked secrets, see "[Pushing a branch blocked by push protection](/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection#resolving-a-blocked-push-in-the-web-ui)." +{% data reusables.secret-scanning.push-protection-remove-secret %} Para obtener más información sobre los secretos de remediación bloqueados, consulta la sección "[Subir una rama que se bloqueó por una protección contra subida](/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection#resolving-a-blocked-push-in-the-web-ui)". -If you confirm a secret is real and that you intend to fix it later, you should aim to remediate the secret as soon as possible. For more information, see "[Removing sensitive data from a repository](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)." +Si confirmas que un secreto es real y que pretendes corregirlo después, debes intentar remediarlo tan pronto como sea posible. Para obtener más información, consulta la sección "[Eliminar datos confidenciales de un repositorio](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)". -If {% data variables.product.prodname_dotcom %} blocks a secret that you believe is safe to push, you can allow the secret and specify the reason why it should be allowed. +Si {% data variables.product.prodname_dotcom %} bloquea un secreto que piensas se puede subir con seguridad, puedes permitirlo y especificar la razón por la cual se debería de permitir. {% data reusables.secret-scanning.push-protection-allow-secrets-alerts %} {% data reusables.secret-scanning.push-protection-allow-email %} -If you confirm a secret is real and that you intend to fix it later, you should aim to remediate the secret as soon as possible. +Si confirmas que un secreto es real y que pretendes corregirlo después, debes intentar remediarlo tan pronto como sea posible. 1. En el letrero que aparece en la parte superior de la página cuando {% data variables.product.prodname_dotcom %} bloqueó tu confirmación, haz clic en **Saltar protección**. {% data reusables.secret-scanning.push-protection-choose-allow-secret-options %} diff --git a/translations/es-ES/content/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection.md b/translations/es-ES/content/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection.md index b21a74387a2c..1add51468101 100644 --- a/translations/es-ES/content/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection.md +++ b/translations/es-ES/content/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection.md @@ -16,13 +16,13 @@ shortTitle: Push a blocked branch ## About push protection for {% data variables.product.prodname_secret_scanning %} -The push protection feature of {% data variables.product.prodname_secret_scanning %} helps to prevent security leaks by scanning for secrets before you push changes to your repository. {% data reusables.secret-scanning.push-protection-overview %} For information on the secrets and service providers supported for push protection, see "[{% data variables.product.prodname_secret_scanning_caps %} patterns](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-push-protection)." +The push protection feature of {% data variables.product.prodname_secret_scanning %} helps to prevent security leaks by scanning for secrets before you push changes to your repository. {% data reusables.secret-scanning.push-protection-overview %} Para obtener más información sobre los secretos y proveedores de servicios compatibles para la protección contra subida de información, consulta la sección "[Patrones de los {% data variables.product.prodname_secret_scanning_caps %}](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-push-protection)". {% data reusables.secret-scanning.push-protection-remove-secret %} {% tip %} -**Tip** If {% data variables.product.prodname_dotcom %} blocks a secret that you believe is safe to push, you can allow the secret and specify the reason why it should be allowed. For more information about bypassing push protection for a secret, see "[Allowing a blocked secret to be pushed](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#allowing-a-blocked-secret-to-be-pushed)" and "[Bypassing push protection for a secret](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#bypassing-push-protection-for-a-secret)" for the command line and the web UI, respectively. +**Tip** If {% data variables.product.prodname_dotcom %} blocks a secret that you believe is safe to push, you can allow the secret and specify the reason why it should be allowed. Para obtener más información sobre cómo omitir la protección contra subida de información para un secreto, consulta las secciones "[Permitir que se suba un secreto bloqueado](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#allowing-a-blocked-secret-to-be-pushed)" y "[Omitir la protección contra subida de información para un secreto](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#bypassing-push-protection-for-a-secret)" para la línea de comandos y la IU web, respectivamente. {% endtip %} diff --git a/translations/es-ES/content/code-security/secret-scanning/secret-scanning-patterns.md b/translations/es-ES/content/code-security/secret-scanning/secret-scanning-patterns.md index d6797c26cd48..793062014e6b 100644 --- a/translations/es-ES/content/code-security/secret-scanning/secret-scanning-patterns.md +++ b/translations/es-ES/content/code-security/secret-scanning/secret-scanning-patterns.md @@ -21,10 +21,10 @@ redirect_from: {% ifversion fpt or ghec %} ## Acerca de los patrones del {% data variables.product.prodname_secret_scanning %} -{% data variables.product.product_name %} maintains these different sets of {% data variables.product.prodname_secret_scanning %} patterns: +{% data variables.product.product_name %} mantiene estos diversos conjuntos de patrones del {% data variables.product.prodname_secret_scanning %}: 1. **Patrones socios.** Se utilizan para detectar secretos potenciales en todos los repositorios públicos. Para obtener más detalles, consulta la sección "[Secretos compatibles para los patrones asociados](#supported-secrets-for-partner-patterns)". -2. **Patrones de seguridad avanzada.** Se utilizan para detectar secretos potenciales en los repositorios que tienen habilitado el {% data variables.product.prodname_secret_scanning %}. {% ifversion ghec %} For details, see "[Supported secrets for advanced security](#supported-secrets-for-advanced-security)."{% endif %}{% ifversion secret-scanning-push-protection %} +2. **Patrones de seguridad avanzada.** Se utilizan para detectar secretos potenciales en los repositorios que tienen habilitado el {% data variables.product.prodname_secret_scanning %}. {% ifversion ghec %} Para obtener más detalles, consulta la sección "[Secretos compatibles para la seguridad avanzada](#supported-secrets-for-advanced-security)".{% endif %}{% ifversion secret-scanning-push-protection %} 3. **Push protection patterns.** Used to detect potential secrets in repositories with {% data variables.product.prodname_secret_scanning %} as a push protection enabled. For details, see "[Supported secrets for push protection](#supported-secrets-for-push-protection)."{% endif %} {% ifversion fpt %} diff --git a/translations/es-ES/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md b/translations/es-ES/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md index 679346062ded..b8e4e66171e7 100644 --- a/translations/es-ES/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md +++ b/translations/es-ES/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md @@ -12,25 +12,25 @@ shortTitle: Registro de imagen privado ## Acerca de los registros de imagen y {% data variables.product.prodname_github_codespaces %} privados -Un registro es un espacio seguro para almacenar, administrar y recuperar imágenes de contenedor privadas. Puedes utilizar uno para almacenar una o más imágenes. Hay muchos ejemplos de registros, tales como el Registro de Contenedores de {% data variables.product.prodname_dotcom %}, Registro de Contenedores de Azure o DockerHub. +Un registro es un espacio seguro para almacenar, administrar y recuperar imágenes de contenedor privadas. Puedes utilizar uno para almacenar una o más imágenes. There are many examples of registries, such as {% data variables.product.prodname_container_registry %}, {% data variables.product.prodname_npm_registry %}, Azure Container Registry, or DockerHub. -El Registro de Contenedores de {% data variables.product.prodname_dotcom %} puede configurarse para extraer imágenes de contenedor sin problemas, sin tener que proporcionar credenciales de autenticación a {% data variables.product.prodname_github_codespaces %}. Para otros registros de imágenes, debes crear secretos en {% data variables.product.prodname_dotcom %} para almacenar los detalles de acceso, los cuales permitirán que los {% data variables.product.prodname_codespaces %} accedan a las imágenes almacenadas en dicho registro. +{% data variables.product.prodname_ghcr_and_npm_registry %} can be configured to allow container images to be pulled seamlessly into {% data variables.product.prodname_github_codespaces %} during codespace creation, without having to provide any authentication credentials. Para otros registros de imágenes, debes crear secretos en {% data variables.product.prodname_dotcom %} para almacenar los detalles de acceso, los cuales permitirán que los {% data variables.product.prodname_codespaces %} accedan a las imágenes almacenadas en dicho registro. -## Acceder a las imágenes almacenadas en el Registro de Contenedores de {% data variables.product.prodname_dotcom %} +## Accessing images stored in {% data variables.product.prodname_ghcr_and_npm_registry %} -El Registro de Contenedores de {% data variables.product.prodname_dotcom %} es la manera más fácil de que {% data variables.product.prodname_codespaces %} consuma imágenes de contenedor de devcontainer. +{% data variables.product.prodname_ghcr_and_npm_registry %} provide the easiest way for {% data variables.product.prodname_codespaces %} to consume dev container images. -Para obtener más información, consulta la sección "[Trabajar con el registro de contenedores](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)". +For more information, see "[Working with the Container registry](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)" and "[Working with the npm registry](/packages/working-with-a-github-packages-registry/working-with-the-npm-registry)". ### Acceder a una imagen publicada en el mismo repositorio que el codespace -Si publicas una imagen de contenedor en el Registro de Contenedores de {% data variables.product.prodname_dotcom %} en el mismo repositorio que el codespace en el cuál se lanzará, automáticamente podrás recuperar esta imagen cuando crees el codespace. No tendrás que proporcionar credenciales adicionales, a menos de que la opción **heredar acceso del repositorio** se haya deseleccionado cuando se publique la imagen de contenedor. +If you publish a container image to {% data variables.product.prodname_ghcr_or_npm_registry %} in the same repository that the codespace is being launched in, you will automatically be able to fetch that image on codespace creation. No tendrás que proporcionar credenciales adicionales, a menos de que la opción **heredar acceso del repositorio** se haya deseleccionado cuando se publique la imagen de contenedor. #### Heredar el acceso del repositorio desde el cual se publicó la imagen -Predeterminadamente, cuando publicas una imagen de contenedor en el Registro de Contenedores de {% data variables.product.prodname_dotcom %}, esta hereda la configuración de acceso del repositorio desde el cual se publicó. Por ejemplo, si el repositorio es público, la imagen también es pública. Si el repositorio es privado, la imagen también es privada, pero es accesible desde el repositorio. +By default, when you publish a container image to {% data variables.product.prodname_ghcr_or_npm_registry %}, the image inherits the access setting of the repository from which the image was published. Por ejemplo, si el repositorio es público, la imagen también es pública. Si el repositorio es privado, la imagen también es privada, pero es accesible desde el repositorio. -Este comportamiento se controla mediante la opción **heredar acceso desde el repositorio**. La opción **heredar acceso desde el repositorio** se encuentra seleccionada predeterminadamente cuando publicas a través de {% data variables.product.prodname_actions %}, pero no cuando se publica directamente al Registro de Contenedores de {% data variables.product.prodname_dotcom %} utilizando un token de acceso personal (PAT). +Este comportamiento se controla mediante la opción **heredar acceso desde el repositorio**. **Inherit access from repo** is selected by default when publishing via {% data variables.product.prodname_actions %}, but not when publishing directly to {% data variables.product.prodname_ghcr_or_npm_registry %} using a Personal Access Token (PAT). Si la opción de **heredar acceso desde el repositorio** no se seleccionó cuando se publicó la imagen, puedes agregar el repositorio manualmente a los controles de acceso de la imagen del contenedor publicado. Para obtener más información, consulta la sección "[Configurar el control de accesos y la visibilidad de un paquete](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#inheriting-access-for-a-container-image-from-a-repository)". @@ -46,13 +46,13 @@ Si quieres permitir que un subconjunto de repositorios de una organización acce ### Publicar una imagen de contenedor desde un codespace -El acceso fácil desde un codespace hasta el Registrod de Contenedores de {% data variables.product.prodname_dotcom %} se limita a las imágenes de contenedor que se extraen. Si quieres publicar una imagen de contenedor desde dentro de un codespace, debes utilizar un token de acceso personal (PAT) con el alcance `write:packages`. +Seamless access from a codespace to {% data variables.product.prodname_ghcr_or_npm_registry %} is limited to pulling container images. Si quieres publicar una imagen de contenedor desde dentro de un codespace, debes utilizar un token de acceso personal (PAT) con el alcance `write:packages`. -Te recomendamos publicar imágenes a través de {% data variables.product.prodname_actions %}. Para obtener más información, consulta la sección "[Publicar imágenes de Docker](/actions/publishing-packages/publishing-docker-images)". +Te recomendamos publicar imágenes a través de {% data variables.product.prodname_actions %}. For more information, see "[Publishing Docker images](/actions/publishing-packages/publishing-docker-images)" and "[Publishing Node.js packages](/actions/publishing-packages/publishing-nodejs-packages)." ## Acceder a las imágenes almacenadas en otros registros de contenedor -Si estás accediendo a una imagen de contenedor desde un registro diferente al Registro de Contenedores de {% data variables.product.prodname_dotcom %}, {% data variables.product.prodname_codespaces %} verifica la presencia de tres secretos, los cuales definen el nombre del servidor, nombre de usuario y token de acceso personal (PAT) de un registro de contenedores. Si se encuentran estos secretos, {% data variables.product.prodname_github_codespaces %} hará que el registro esté disponible dentro de tu codespace. +If you are accessing a container image from a registry that isn't {% data variables.product.prodname_ghcr_or_npm_registry %}, {% data variables.product.prodname_codespaces %} checks for the presence of three secrets, which define the server name, username, and personal access token (PAT) for a container registry. Si se encuentran estos secretos, {% data variables.product.prodname_github_codespaces %} hará que el registro esté disponible dentro de tu codespace. - `<*>_CONTAINER_REGISTRY_SERVER` - `<*>_CONTAINER_REGISTRY_USER` diff --git a/translations/es-ES/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md b/translations/es-ES/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md index 5cc3e82a015d..300d99c8d721 100644 --- a/translations/es-ES/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md +++ b/translations/es-ES/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md @@ -17,7 +17,7 @@ redirect_from: ## Acerca de {% data variables.product.prodname_vscode_command_palette %} -La paleta de comandos es una de las características focales de {% data variables.product.prodname_vscode %} y está disponible para que la utilices en {% data variables.product.prodname_github_codespaces %}. La {% data variables.product.prodname_vscode_command_palette %} te permite acceder a muchos comandos para {% data variables.product.prodname_codespaces %} y {% data variables.product.prodname_vscode_shortname %}. Para obtener más información sobre cómo utilizar la {% data variables.product.prodname_vscode_command_palette_shortname %}, consulta la sección "[Interfaz de usuario](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette)" en la documentación de {% data variables.product.prodname_vscode_shortname %}. +La paleta de comandos es una de las características focales de {% data variables.product.prodname_vscode %} y está disponible para que la utilices en {% data variables.product.prodname_github_codespaces %}. La paleta de comandos te permite acceder a muchos comandos para los {% data variables.product.prodname_codespaces %} y para {% data variables.product.prodname_vscode_shortname %}. Para obtener más información sobre cómo utilizar la {% data variables.product.prodname_vscode_command_palette_shortname %}, consulta la sección "[Interfaz de usuario](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette)" en la documentación de {% data variables.product.prodname_vscode_shortname %}. ## Acceder a la {% data variables.product.prodname_vscode_command_palette_shortname %} diff --git a/translations/es-ES/content/codespaces/developing-in-codespaces/getting-started-with-github-codespaces-for-machine-learning.md b/translations/es-ES/content/codespaces/developing-in-codespaces/getting-started-with-github-codespaces-for-machine-learning.md new file mode 100644 index 000000000000..6c447203712a --- /dev/null +++ b/translations/es-ES/content/codespaces/developing-in-codespaces/getting-started-with-github-codespaces-for-machine-learning.md @@ -0,0 +1,120 @@ +--- +title: Getting started with GitHub Codespaces for machine learning +shortTitle: Machine learning +intro: 'Learn about working on machine learning projects with {% data variables.product.prodname_github_codespaces %} and its out-of-the-box tools.' +product: '{% data reusables.gated-features.codespaces %}' +versions: + fpt: '*' + ghec: '*' +type: tutorial +topics: + - Codespaces + - Developer +--- + +## Introducción + +This guide introduces you to machine learning with {% data variables.product.prodname_github_codespaces %}. You’ll build a simple image classifier, learn about some of the tools that come preinstalled in {% data variables.product.prodname_github_codespaces %}, configure your development environment for NVIDIA CUDA, and use {% data variables.product.prodname_cli %} to open your codespace in JupyterLab. + +## Prerequisite + +You have access to {% data variables.product.prodname_github_codespaces %}. Para obtener más información, consulta la sección "[Crear un codespace](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-github-codespaces)". + +## Build a simple image classifier + +We'll use a Jupyter notebook to build a simple image classifier. + +Jupyter notebooks are sets of cells that you can execute one after another. The notebook we'll use includes a number of cells that build an image classifier using [PyTorch](https://pytorch.org/). Each cell is a different phase of that process: download a dataset, set up a neural network, train a model, and then test that model. + +We'll run all of the cells, in sequence, to perform all phases of building the image classifier. When we do this Jupyter saves the output back into the notebook so that you can examine the results. + +### Creating a repository and a codespace + +1. Go to the [github/codespaces-getting-started-ml](https://github.com/github/codespaces-getting-started-ml) template repository and click **Use this template**. +{% data reusables.codespaces.open-codespace-from-template-repo %} + + By default, a codespace for this repository opens in a web-based version of {% data variables.product.prodname_vscode %}. + +### Open the image classifier notebook + +The default container image that's used by {% data variables.product.prodname_github_codespaces %} includes a set of machine learning libraries that are preinstalled in your codespace. For example, Numpy, pandas, SciPy, Matplotlib, seaborn, scikit-learn, TensorFlow, Keras, PyTorch, Requests, and Plotly. For more information about the default image, see "[Introduction to dev containers](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers#using-the-default-dev-container-configuration)" and [the `devcontainers/images` repository](https://github.com/devcontainers/images/tree/main/src/codespaces#github-codespaces-default-linux-universal). + +1. In the {% data variables.product.prodname_vscode_shortname %} editor, close any "Get Started" tabs that are displayed. +1. Open the `image-classifier.ipynb` notebook file. +1. Click the Python kernel link at the top right of the editor. + + ![Screenshot of the Python kernal link](/assets/images/help/codespaces/jupyter-python-kernel-link.png) + +1. In the drop-down menu, choose the kernel in the directory `/opt/python/latest/bin/python`. + + ![Screenshot of the Python kernal drop-down menu](/assets/images/help/codespaces/jupyter-python-kernel-dropdown.png) + +### Build the image classifier + +The image classifier notebook contains all the code you need to download a dataset, train a neural network, and evaluate its performance. + +1. Click **Run All** to execute all of the notebook’s cells. + + ![Screenshot of the Run All button](/assets/images/help/codespaces/jupyter-run-all.png) + +1. Scroll down to view the output of each cell. + + ![Screenshot of Step 3 in the editor](/assets/images/help/codespaces/jupyter-notebook-step3.png) + +## Configure NVIDIA CUDA for your codespace + +Some software, such as TensorFlow, requires you to install NVIDIA CUDA to use your codespace’s GPU. Where this is the case, you can create your own custom configuration, by using a `devcontainer.json` file, and specify that CUDA should be installed. For more information on creating a custom configuration, see "[Introduction to dev containers](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers#creating-a-custom-dev-container-configuration)." + +{% note %} + +**Note**: For full details of the script that's run when you add the `nvidia-cuda` feature, see [the devcontainers/features repository](https://github.com/devcontainers/features/tree/main/src/nvidia-cuda). + +{% endnote %} + +1. Within a codespace, open the `.devcontainer/devcontainer.json` file in the editor. +1. Add a top-level `features` object with the following contents: + + ```json{:copy} + “features”: { + "ghcr.io/devcontainers/features/nvidia-cuda:1": { + "installCudnn": true + } + } + ``` + + For more information about the `features` object, see the [development containers specification](https://containers.dev/implementors/features/#devcontainer-json-properties). + + If you are using the `devcontainer.json` file from the image classifier repository you created for this tutorial, your `devcontainer.json` file will now look like this: + + ``` + { + "customizations": { + "vscode": { + "extensions": [ + "ms-python.python", + "ms-toolsai.jupyter" + ] + } + }, + “features”: { + "ghcr.io/devcontainers/features/nvidia-cuda:1": { + "installCudnn": true + } + } + } + ``` + +1. Save the change. +{% data reusables.codespaces.rebuild-command %} + The codespace container will be rebuilt. This will take several minutes. When the rebuild is complete the codespace is automatically reopened. +1. Commit the change to the repository so that CUDA will be installed in any new codespaces you create from this repository in future. + +## Open your codespace in JupyterLab + +The default container image that's used by {% data variables.product.prodname_github_codespaces %} includes JupyterLab, the web-based Jupyter IDE. You can use {% data variables.product.prodname_cli %} to open your codespace in JupyterLab without having to install anything else on your codespace. + +1. In the terminal, enter the {% data variables.product.prodname_cli %} command `gh cs jupyter`. +1. Choose the codespace you want to open. + + ![Screenshot of opening a codespace from the terminal](/assets/images/help/codespaces/open-codespace-in-jupyter.png) + diff --git a/translations/es-ES/content/codespaces/developing-in-codespaces/index.md b/translations/es-ES/content/codespaces/developing-in-codespaces/index.md index e67f1aa1b7a7..c2468004c75c 100644 --- a/translations/es-ES/content/codespaces/developing-in-codespaces/index.md +++ b/translations/es-ES/content/codespaces/developing-in-codespaces/index.md @@ -18,6 +18,7 @@ children: - /forwarding-ports-in-your-codespace - /default-environment-variables-for-your-codespace - /connecting-to-a-private-network + - /getting-started-with-github-codespaces-for-machine-learning - /using-github-codespaces-in-visual-studio-code - /using-github-codespaces-with-github-cli --- diff --git a/translations/es-ES/content/codespaces/getting-started/deep-dive.md b/translations/es-ES/content/codespaces/getting-started/deep-dive.md index f22981969a98..b4afca5e51ba 100644 --- a/translations/es-ES/content/codespaces/getting-started/deep-dive.md +++ b/translations/es-ES/content/codespaces/getting-started/deep-dive.md @@ -73,7 +73,7 @@ As you develop in your codespace, it will save any changes to your files every f ### Closing or stopping your codespace -To stop your codespace you can [use the {% data variables.product.prodname_vscode_command_palette %}](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces#suspending-or-stopping-a-codespace) (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)). If you exit your codespace without running the stop command (for example, closing the browser tab), or if you leave the codespace running without interaction, the codespace and its running processes will continue until a window of inactivity occurs, after which the codespace will stop. By default, the window of inactivity is 30 minutes. +To stop your codespace you can [use the {% data variables.product.prodname_vscode_command_palette %}](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces#suspending-or-stopping-a-codespace) (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)). If you exit your codespace without running the stop command (for example, closing the browser tab), or if you leave the codespace running without interaction, the codespace and its running processes will continue until a window of inactivity occurs, after which the codespace will stop. By default, the window of inactivity is 30 minutes. When you close or stop your codespace, all uncommitted changes are preserved until you connect to the codespace again. diff --git a/translations/es-ES/content/codespaces/getting-started/quickstart.md b/translations/es-ES/content/codespaces/getting-started/quickstart.md index 098e969ac070..22e3c46b23d4 100644 --- a/translations/es-ES/content/codespaces/getting-started/quickstart.md +++ b/translations/es-ES/content/codespaces/getting-started/quickstart.md @@ -25,12 +25,7 @@ Para obtener más información sobre cómo funcionan los {% data variables.produ ## Crea tu codespace 1. Navega al [repositorio de plantilla](https://github.com/github/haikus-for-codespaces) y selecciona **Utilizar esta plantilla**. - -1. Elige un propietario para el repositorio nuevo, ingresa un nombre de repositorio, selecciona tu ajuste de privacidad preferido y haz clic en **Crear repositorio desde plantilla**. - -1. Navega a la página principal del repositorio recientemente creado. Debajo del nombre de repositorio, utiliza el menú desplegable **{% octicon "code" aria-label="The code icon" %} Código** y la pestaña de **Codespaces** y haz clic en **Crear codespace en rama principal**. - - ![Botón de codespace nuevo](/assets/images/help/codespaces/new-codespace-button.png) +{% data reusables.codespaces.open-codespace-from-template-repo %} ## Ejecutar la aplicación diff --git a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md index 73c439fe3381..477aff088e11 100644 --- a/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md +++ b/translations/es-ES/content/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization.md @@ -39,7 +39,7 @@ To allow people to create codespaces for which your organization will be billed, {% endnote %} {% endif %} -Predeterminadamente, un codespace solo puede acceder al repositorio desde el cual se creó. If you want codespaces in your organization to be able to access other organization repositories that the codespace creator can access, see "[Managing repository access for your organization's codespaces](/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces)." +Predeterminadamente, un codespace solo puede acceder al repositorio desde el cual se creó. Si quieres que los codesapces en tu organización puedan acceder a otros repositorios en ella a los cuales tenga acceso el creador del codespace, consulta la sección "[Administrar el acceso de los repositorios a los codespaces de tu organización](/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces)". ## Choose who can create codespaces that are billed to your organization @@ -57,7 +57,7 @@ Predeterminadamente, un codespace solo puede acceder al repositorio desde el cua {% note %} - **Note:** When you select **All members and outside collaborators**, all outside collaborators who have been added to specific repositories can create and use {% data variables.product.prodname_codespaces %} for those repositories, and your organization will be billed for this usage. Para obtener más información sobre cómo administrar colaboradores externos, consulta la sección "[Acerca de los colaboradores externos](/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization#about-outside-collaborators)". + **Nota:** Cuando seleccionas **Todos los miembros y colaboradores externos**, todos los colaboradores externos que se hayan agregado a los repositorios específicos pueden crear y utilizar {% data variables.product.prodname_codespaces %} para dichos repositorios y se facturará a tu organización por dicho uso. Para obtener más información sobre cómo administrar colaboradores externos, consulta la sección "[Acerca de los colaboradores externos](/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization#about-outside-collaborators)". {% endnote %} diff --git a/translations/es-ES/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md b/translations/es-ES/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md index dd9f21efed65..13c69ceb0c46 100644 --- a/translations/es-ES/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md +++ b/translations/es-ES/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md @@ -56,27 +56,27 @@ Antes de que configures las precompilaciones para tu proyecto, se debe cumplir c ![Las opciones de activación de precompilación](/assets/images/help/codespaces/prebuilds-triggers.png) -1. Optionally, select **Reduce prebuild available to only specific regions** to limit access to your prebuild, then select which regions you want it to be available in. Los desarrolladores solo pueden crear condespaces desde una precompilación si estos se ubican en una región que selecciones. By default, your prebuild is available to all regions where codespaces is available and storage costs apply for each region. +1. Opcionalmente, selecciona **reducir la precompilación disponible para solo las regiones específicas** para limitar el acceso a tu precompilación y luego selecciona en qué regiones quieres que esté disponible. Los desarrolladores solo pueden crear condespaces desde una precompilación si estos se ubican en una región que selecciones. Predeterminadamente, tu precompilación está disponible para todas las regiones en donde los codespaces estén disponibles y los costos de almacenamiento aplican para cada región. ![Las opciones de selección de región](/assets/images/help/codespaces/prebuilds-regions.png) {% note %} **Notas**: - * The prebuild for each region will incur individual charges. Por lo tanto, solo deberías habilitar las precompilaciones para las regiones en las que sabes que se utilizarán. Para obtener más información, consulta la sección "[Acerca de las precompilaciones de {% data variables.product.prodname_github_codespaces %}](/codespaces/prebuilding-your-codespaces/about-github-codespaces-prebuilds#about-billing-for-codespaces-prebuilds)". + * La precompilación para cada región incurrirá en cargos individuales. Por lo tanto, solo deberías habilitar las precompilaciones para las regiones en las que sabes que se utilizarán. Para obtener más información, consulta la sección "[Acerca de las precompilaciones de {% data variables.product.prodname_github_codespaces %}](/codespaces/prebuilding-your-codespaces/about-github-codespaces-prebuilds#about-billing-for-codespaces-prebuilds)". * Los desarrolladores pueden configurar su región predeterminada para {% data variables.product.prodname_codespaces %}, lo que te puede permitir habilitar las precompilaciones para menos regiones. Para obtener más información, consulta la sección "[Configurar tu región predeterminada para {% data variables.product.prodname_github_codespaces %}](/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces)". {% endnote %} -1. Optionally, set the number of prebuild versions to be retained. Puedes ingresar cualquier número entre 1 y 5. La cantidad predeterminada de versiones guardadas es de 2, lo que significa que solo la versión de plantilla más reciente y la versión previa se guardan. +1. Opcionalmente, establezca el número de versiones de precompilación que se deban retener. Puedes ingresar cualquier número entre 1 y 5. La cantidad predeterminada de versiones guardadas es de 2, lo que significa que solo la versión de plantilla más reciente y la versión previa se guardan. - Depending on your prebuild trigger settings, your prebuild could change with each push or on each dev container configuration change. Retaining older versions of prebuilds enables you to create a prebuild from an older commit with a different dev container configuration than the current prebuild. Since there is a storage cost associated with retaining prebuild versions, you can choose the number of versions to be retained based on the needs of your team. Para obtener más información sobre la facturación, consulta la sección "[Acerca de la facturación para los {% data variables.product.prodname_github_codespaces %}](/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#codespaces-pricing)". + Dependiendo de los ajustes de activación de la precompilación, esta podría cambiar con cada subida o en cada cambio de configuración de contenedor dev. El retener versiones anteriores de precompilaciones te permite crear una precompilación desde una confirmación más antigua con una configuración de contenedor dev diferente que la de la precompilación actual. Ya que existe un costo de almacenamiento asociado con la retención de versiones de precompilación, puedes elegir la cantidad de versiones a retener con base en las necesidades de tu equipo. Para obtener más información sobre la facturación, consulta la sección "[Acerca de la facturación para los {% data variables.product.prodname_github_codespaces %}](/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#codespaces-pricing)". - If you set the number of prebuild versions to save to 1, {% data variables.product.prodname_codespaces %} will only save the latest version of the prebuild and will delete the older version each time the template is updated. Esto significa que no obtendrás un codespace precompilado si regresas a una configuración de contenedor dev antigua. + Si configuras la cantidad de versiones de precompilación a guardar en 1, {% data variables.product.prodname_codespaces %} solo guardará la última versión de la precompilación y borrará la versión antigua cada que se actualice la plantilla. Esto significa que no obtendrás un codespace precompilado si regresas a una configuración de contenedor dev antigua. - ![The prebuild history setting](/assets/images/help/codespaces/prebuilds-template-history-setting.png) + ![El ajuste de historial de precompilación](/assets/images/help/codespaces/prebuilds-template-history-setting.png) -1. Optionally, add users or teams to notify when the prebuild workflow run fails for this configuration. Puedes comenzar a escribir un nombre de usuario, de equipo o nombre completo y luego hacer clic en el nombre una vez que aparezca para agregarlos a la lista. Los usuarios o equipos que agregues recibirán un correo electrónico cuando ocurran fallas en la precompilación, los cuales contienen un enlace a las bitácoras de ejecución de flujo de trabajo para ayudar con las investigaciones subsecuentes. +1. Opcionalmente, agrega usuarios o equipos para notificarles cuando una ejecución de flujo de trabajo de precompilación falle para esta configuración. Puedes comenzar a escribir un nombre de usuario, de equipo o nombre completo y luego hacer clic en el nombre una vez que aparezca para agregarlos a la lista. Los usuarios o equipos que agregues recibirán un correo electrónico cuando ocurran fallas en la precompilación, los cuales contienen un enlace a las bitácoras de ejecución de flujo de trabajo para ayudar con las investigaciones subsecuentes. ![El ajuste de notificación de falla de precompilación](/assets/images/help/codespaces/prebuilds-failure-notification-setting.png) @@ -84,27 +84,27 @@ Antes de que configures las precompilaciones para tu proyecto, se debe cumplir c {% data reusables.codespaces.prebuilds-permission-authorization %} -After you create a prebuild configuration it is listed on the {% data variables.product.prodname_codespaces %} page of your repository settings. A {% data variables.product.prodname_actions %} workflow is queued and then run to create prebuilds in the regions you specified, based on the branch and dev container configuration file you selected. +Después crear una configuración de precompilación, esta se lista en la página de {% data variables.product.prodname_codespaces %} de tus ajustes de repositorio. Un flujo de trabajo de {% data variables.product.prodname_actions %} se pone en cola y luego se ejecuta para crear precompilaciones en las regiones que especificaste, con base en la rama y archivo de configuración de contenedor dev que seleccionaste. -![Screenshot of the list of prebuild configurations](/assets/images/help/codespaces/prebuild-configs-list.png) +![Captura de pantalla de la lista de configuraciones de precompilación](/assets/images/help/codespaces/prebuild-configs-list.png) -For information about editing and deleting prebuild configurations, see "[Managing prebuilds](/codespaces/prebuilding-your-codespaces/managing-prebuilds)." +Para obtener más información sobre cómo editar y borrar configuraciones de precompilación, consulta la sección "[Administrar las precompilaciones](/codespaces/prebuilding-your-codespaces/managing-prebuilds)". ## Configurar variables de ambiente Para permitir que el proceso de precompilación acceda a las variables de ambiente que se requieren para crear tu ambiente de desarrollo, puedes configurarlas ya sea como secretos de repositorio de {% data variables.product.prodname_codespaces %} o como secretos de organización de {% data variables.product.prodname_codespaces %}. Para obtener más información, consulta las secciones "[Agregar secretos para un repositorio](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-github-codespaces#adding-secrets-for-a-repository)" y "[Agregar secretos para una organización](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-github-codespaces#adding-secrets-for-an-organization)". -Secrets that you create in this way will be accessible by anyone who creates a codespace from this repository. Si no quieres esto, como alternativa, puedes configurar el secreto `CODESPACES_PREBUILD_TOKEN`. El secreto `CODESPACES_PREBUILD_TOKEN` solo se utiliza para precompilar y no se puede acceder a su valor en los codespaces de los usuarios. +Cualquiera que cree un codespace desde este repositorio podrá acceder a los secretos de que crees de esta forma. Si no quieres esto, como alternativa, puedes configurar el secreto `CODESPACES_PREBUILD_TOKEN`. El secreto `CODESPACES_PREBUILD_TOKEN` solo se utiliza para precompilar y no se puede acceder a su valor en los codespaces de los usuarios. -Prebuilds cannot use any user-level secrets while building your environment, because these are not available until after the codespace has been created. +Las precompilaciones no pueden utilizar secretos a nivel de usuario al compilar tu ambiente nuevo, ya que estos no están disponibles sino hasta después de que se haya creado el codespace. ## Configurar tareas que llevan mucho tiempo para que se incluyan en la precompilación -You can use the `onCreateCommand` and `updateContentCommand` commands in your `devcontainer.json` to include time-consuming processes as part of the prebuild creation. Para obtener más información, consulta la documentación de {% data variables.product.prodname_vscode %} "[referencia de devcontainer.json](https://code.visualstudio.com/docs/remote/devcontainerjson-reference#_lifecycle-scripts)". +Puedes utilizar los comandos `onCreateCommand` y `updateContentCommand` en tu `devcontainer.json` para incluir los procesos que llevan mucho tiempo como parte de la creación de la precompilación. Para obtener más información, consulta la documentación de {% data variables.product.prodname_vscode %} "[referencia de devcontainer.json](https://code.visualstudio.com/docs/remote/devcontainerjson-reference#_lifecycle-scripts)". -`onCreateCommand` is run only once, when the prebuild is created, whereas `updateContentCommand` is run at template creation and at subsequent template updates. Incremental builds should be included in `updateContentCommand` since they represent the source of your project and need to be included for every prebuild update. +`onCreateCommand` solo se ejecuta una vez, cuando se crea la precompilación, mientras que `updateContentCommand` se ejecuta cuando se crea la plantilla y en las actualizaciones de plantilla posteriores. Las compilaciones incrementales deben incluirse en `updateContentCommand`, ya que estas representan el origen de tu proyecto y necesitan incluirse para cada actualización de precompilación. ## Leer más -- "[Allowing a prebuild to access other repositories](/codespaces/prebuilding-your-codespaces/allowing-a-prebuild-to-access-other-repositories)" +- "[Permitir que una precompilación acceda a otros repositorios](/codespaces/prebuilding-your-codespaces/allowing-a-prebuild-to-access-other-repositories)" - "[Solucionar problemas de las compilaciones previas](/codespaces/troubleshooting/troubleshooting-prebuilds)" diff --git a/translations/es-ES/content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md b/translations/es-ES/content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md index 43418c6692e3..f76eb3e497ec 100644 --- a/translations/es-ES/content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md +++ b/translations/es-ES/content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md @@ -16,7 +16,7 @@ miniTocMaxHeadingLevel: 3 Las precompilaciones que configures para un repositorio se crean y actualizan utilizando un flujo de trabajo de {% data variables.product.prodname_actions %}, que administra el servicio de {% data variables.product.prodname_github_codespaces %}. -Depending on the settings in a prebuild configuration, the workflow to update the prebuild may be triggered by these events: +Dependiendo de los ajustes en una configuración de precompilación, el flujo de trabajo para actualizar la precompilación podría activarse con estos eventos: * Crear o actualizar la configuración de precompilación * Subir una confirmación o una solicitud de cambios a una rama que está configurada para tener precompilaciones @@ -24,7 +24,7 @@ Depending on the settings in a prebuild configuration, the workflow to update th * Un itinerario que definiste en la configuración de la precompilación * Activar el flujo de trabajo manualmente -The settings in the prebuild configuration determine which events automatically trigger an update of the prebuild. Para obtener más información, consulta la sección "[Configurar las precompilaciones](/codespaces/prebuilding-your-codespaces/configuring-prebuilds#configuring-a-prebuild)". +Los ajustes en la configuración de precompilación determinan qué eventos activan automáticamente una actualización de la precompilación. Para obtener más información, consulta la sección "[Configurar las precompilaciones](/codespaces/prebuilding-your-codespaces/configuring-prebuilds#configuring-a-prebuild)". Las personas con acceso administrativo a un repositorio pueden verificar el progreso de las precompilaciones, así como editar y borrar las configuraciones de estas. @@ -61,7 +61,7 @@ Esto muestra el historial de ejecución de flujo de trabajo para las precompilac ### Inhabilitar una configuración de precompilación -To pause the update of prebuilds for a configuration, you can disable workflow runs for the configuration. Disabling the workflow runs for a prebuild configuration does not delete any previously created prebuilds for that configuration and, as a result, codespaces will continue to be generated from an existing prebuild. +Para pausar la actualización de las precompilaciones de una configuración, puedes inhabilitar las ejecuciones de flujo de trabajo para dicha configuración. El inhabilitar las ejecuciones de flujo de trabajo para una configuración de precompilación no borra ninguna de estas que se haya creado anteriormente para dicha configuración y, como resultado, los codespaces seguirán generándose desde una precompilación existente. El inhabilitar las ejecuciones de flujos de trabajo para una configuración precompilada es útil si necesitas investigar los fallos en la creación de plantillas. @@ -74,7 +74,7 @@ El inhabilitar las ejecuciones de flujos de trabajo para una configuración prec ### Borrar una configuración de precompilación -Deleting a prebuild configuration also deletes all previously created prebuilds for that configuration. Como resultado, poco después de que borres una configuración, las precompilaciones generadas por dicha configuración ya no estarán disponibles cuando crees un codespace nuevo. +El borrar una configuración de preocmpilación también borrar todas las precompilaciones que se hayan creado previamente para dicha configuración. Como resultado, poco después de que borres una configuración, las precompilaciones generadas por dicha configuración ya no estarán disponibles cuando crees un codespace nuevo. Después de que borras una configuración de precompilación, todavía se ejecutarán las ejecuciones de flujo de trabajo de dicha configuración que se hayan puesto en cola o que hayan iniciado. Se listarán en el historial de ejecución de flujo de trabajo junto con las ejecuciones de flujo de trabajo que se hayan completado previamente. diff --git a/translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md b/translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md index 937403d0bf46..6fc957533e9b 100644 --- a/translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md +++ b/translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md @@ -155,9 +155,9 @@ Puedes agregar características a tu configuración predefinida de contenedor pa Puedes agregar algunas de las características más comunes seleccionándolas cuando configures tu contenedor predefinido. Para obtener más información sobre las características disponibles, consulta la [librería de scripts](https://github.com/microsoft/vscode-dev-containers/tree/main/script-library#scripts) en el repositorio `vscode-dev-containers`. -1. Accede a la paleta de comandos (`Shift + Command + P` / `Ctrl + Shift + P`) y luego comienza a teclear "configurar". Selecciona **Codespaces: configurar las características del devcontainer**. +1. Access the Command Palette (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)), then start typing "configure". Selecciona **Codespaces: configurar las características del devcontainer**. - ![El comando de configurar características del devcontainer en la paleta de comandos](/assets/images/help/codespaces/codespaces-configure-features.png) + ![The Configure Devcontainer Features command in the Command Palette](/assets/images/help/codespaces/codespaces-configure-features.png) 1. Actualiza tus selecciones de características y luego haz clic en **OK**. @@ -165,7 +165,7 @@ Puedes agregar algunas de las características más comunes seleccionándolas cu 1. Para aplicar los cambios, en la esquina inferior derecha de la pantalla, haz clic en **Reconstruir ahora**. Para obtener más información sobre cómo reconstruir tu contenedor, consulta la sección "[Aplicar los cambios a tu configuración](#applying-configuration-changes-to-a-codespace)". - !["Codespaces: Reconstruir contenedor" en la paleta de comandos](/assets/images/help/codespaces/rebuild-prompt.png) + !["Codespaces: Rebuild Container" in the Command Palette](/assets/images/help/codespaces/rebuild-prompt.png) ## Crear una configuración de contenedor dev personalizada diff --git a/translations/es-ES/content/codespaces/troubleshooting/github-codespaces-logs.md b/translations/es-ES/content/codespaces/troubleshooting/github-codespaces-logs.md index 7ee468914af1..c8497b8b57cc 100644 --- a/translations/es-ES/content/codespaces/troubleshooting/github-codespaces-logs.md +++ b/translations/es-ES/content/codespaces/troubleshooting/github-codespaces-logs.md @@ -28,7 +28,7 @@ Estas bitácoras contienen información detallada sobre los codespaces, el conte {% webui %} 1. Si estás utilizando {% data variables.product.prodname_codespaces %} en el buscador, asegúrate de que estés conectado al codespace que quieres depurar. -1. Abre la paleta de comandos de {% data variables.product.prodname_vscode %} (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) y teclea **Exportar bitácoras**. Selecciona **Codespaces: Exportar Bitácoras** de la lista para descargar las bitácoras. +1. Open the {% data variables.product.prodname_vscode_command_palette_shortname %} (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)) and type **Export logs**. Selecciona **Codespaces: Exportar Bitácoras** de la lista para descargar las bitácoras. 1. Define dónde guardar el archivo zip de las bitácoras y luego haz clic en **Guardar** (escritorio) o en **OK** (web). 1. Si estás utilizando {% data variables.product.prodname_codespaces %} en el buscador, haz clic derecho en el archivo zip de las bitácoras desde la vista de explorador y selecciona **Download…** para descargarlas en tu máquina local. @@ -36,7 +36,7 @@ Estas bitácoras contienen información detallada sobre los codespaces, el conte {% vscode %} -1. Abre la paleta de comandos de {% data variables.product.prodname_vscode %} (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) y teclea **Exportar bitácoras**. Selecciona **Codespaces: Exportar Bitácoras** de la lista para descargar las bitácoras. +1. Open the {% data variables.product.prodname_vscode_command_palette_shortname %} (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)) and type **Export logs**. Selecciona **Codespaces: Exportar Bitácoras** de la lista para descargar las bitácoras. 1. Define dónde guardar el archivo zip de las bitácoras y luego haz clic en **Guardar** (escritorio) o en **OK** (web). {% endvscode %} @@ -55,7 +55,7 @@ Estas bitácoras contienen información sobre el contenedor, el contenedor dev y {% webui %} 1. Conéctate al codespace que quieras depurar. -2. Abre la {% data variables.product.prodname_vscode_command_palette %} (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) y teclea **Creation logs**. Selecciona **Codespaces: View Creation Log** de la lista para abrir el archivo `creation.log`. +2. Open the {% data variables.product.prodname_vscode_command_palette_shortname %} (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)) and type **Creation logs**. Selecciona **Codespaces: View Creation Log** de la lista para abrir el archivo `creation.log`. Si quieres compartir la bitácora con soporte, puedes copiar el texto de la bitácora de creación en un editor de texto y guardar el archivo localmente. @@ -63,7 +63,7 @@ Si quieres compartir la bitácora con soporte, puedes copiar el texto de la bit {% vscode %} -Abre la paleta de comandos (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) y teclea **Creation logs**. Selecciona **Codespaces: View Creation Log** de la lista para abrir el archivo `creation.log`. +Open the {% data variables.product.prodname_vscode_command_palette_shortname %} (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)) and type **Creation logs**. Selecciona **Codespaces: View Creation Log** de la lista para abrir el archivo `creation.log`. Si quieres compartir la bitácora con soporte, puedes copiar el texto de la bitácora de creación en un editor de texto y guardar el archivo localmente. diff --git a/translations/es-ES/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md b/translations/es-ES/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md index cc3838df1d24..65d8b2106387 100644 --- a/translations/es-ES/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md +++ b/translations/es-ES/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md @@ -1,5 +1,5 @@ --- -title: Solucionar problemas de creación y borrado de Codespaces +title: Troubleshooting creation and deletion of codespaces intro: 'Este artículo te muestra los pasos para la solución de problemas comunes que podrías experimentar al crear o borrar un codespace, incluyendo los de almacenamiento y configuración.' product: '{% data reusables.gated-features.codespaces %}' versions: @@ -16,6 +16,8 @@ shortTitle: Creación y borrado ### Sin acceso para crear un codespace Los {% data variables.product.prodname_codespaces %} no están disponibles para todos los repositorios. Si no se muestra el botón de "Abrir con Codespaces", {% data variables.product.prodname_github_codespaces %} podría no estar disponible para dicho repositorio. Para obtener más información, consulta la sección "[Crear un codespace](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces)". +You can't create a codespace for a private repository that is owned by an organization, unless you have write access to the repository or the organization has enabled forking for it. + Si crees que tu organización sí [habilitó los {% data variables.product.prodname_codespaces %}](/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization#about-enabling-codespaces-for-your-organization), asegúrate de que un propietario de la organización o gerente de facturación haya configurado el límite de gastos para los {% data variables.product.prodname_codespaces %}. Para obtener más información, consulta la sección "[Administrar tu límite de gastos para {% data variables.product.prodname_codespaces %}](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces)". ### El Codespace no abre cuando se crea diff --git a/translations/es-ES/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md b/translations/es-ES/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md index 1169217c6fd1..3b0fa5c6f04c 100644 --- a/translations/es-ES/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md +++ b/translations/es-ES/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md @@ -18,7 +18,7 @@ redirect_from: Los codespaces están configurados para detenerse después de pasar 30 minutos sin actividad. Si intentas interactuar con un codespace después de que se detuvo, podrías ver un error de tipo `503 service unavailable`. - Si se muestra un botón de **Inicio** en {% data variables.product.prodname_vscode %} o en tu ventana de buscador, haz clic en **Inicio** para volverte a conectar al codespace. -- Restablece tu codespace volviendo a cargar la ventana. Desde la [paleta de comandos](/codespaces/codespaces-reference/using-the-command-palette-in-codespaces#accessing-the-command-palette) en {% data variables.product.prodname_vscode %}, haz clic en **Desarrollador: Recargar Ventana**. +- Restablece tu codespace volviendo a cargar la ventana. From the [Command Palette](/codespaces/codespaces-reference/using-the-command-palette-in-codespaces#accessing-the-command-palette) in {% data variables.product.prodname_vscode %}, click **Developer: Reload Window**. ## El buscador no se puede conectar diff --git a/translations/es-ES/content/copilot/overview-of-github-copilot/about-github-copilot.md b/translations/es-ES/content/copilot/overview-of-github-copilot/about-github-copilot.md index 3e905ad42222..d91817fa960c 100644 --- a/translations/es-ES/content/copilot/overview-of-github-copilot/about-github-copilot.md +++ b/translations/es-ES/content/copilot/overview-of-github-copilot/about-github-copilot.md @@ -22,7 +22,7 @@ You can see real-world examples of {% data variables.product.prodname_copilot %} GitHub Copilot offers suggestions from a model that OpenAI built from billions of lines of open source code. As a result, the training set for {% data variables.product.prodname_copilot %} may contain insecure coding patterns, bugs, or references to outdated APIs or idioms. When {% data variables.product.prodname_copilot %} produces suggestions based on this training data, those suggestions may also contain undesirable patterns. -You are responsible for ensuring the security and quality of your code. We recommend you take the same precautions when using code generated by {% data variables.product.prodname_copilot %} that you would when using any code you didn't write yourself. These precautions include rigorous testing, IP scanning, and tracking for security vulnerabilities. {% data variables.product.company_short %} provides a number of features to help you monitor and improve code quality, such as {% data variables.product.prodname_actions %}, {% data variables.product.prodname_dependabot %}, {% data variables.product.prodname_codeql %} and {% data variables.product.prodname_code_scanning %}. All these features are free to use in public repositories. For more information, see "[Understanding {% data variables.product.prodname_actions %}](/actions/learn-github-actions/understanding-github-actions)" and "[{% data variables.product.company_short %} security features](/code-security/getting-started/github-security-features)." +You are responsible for ensuring the security and quality of your code. We recommend you take the same precautions when using code generated by {% data variables.product.prodname_copilot %} that you would when using any code you didn't write yourself. These precautions include rigorous testing, IP scanning, and tracking for security vulnerabilities. {% data variables.product.company_short %} proporciona varias características para ayudarte a monitorear y mejorar la calidad del código, tales como las {% data variables.product.prodname_actions %}, el {% data variables.product.prodname_dependabot %}, {% data variables.product.prodname_codeql %} y el {% data variables.product.prodname_code_scanning %}. All these features are free to use in public repositories. For more information, see "[Understanding {% data variables.product.prodname_actions %}](/actions/learn-github-actions/understanding-github-actions)" and "[{% data variables.product.company_short %} security features](/code-security/getting-started/github-security-features)." {% data variables.product.prodname_copilot %} uses filters to block offensive words in the prompts and avoid producing suggestions in sensitive contexts. We are committed to constantly improving the filter system to more intelligently detect and remove offensive suggestions generated by {% data variables.product.prodname_copilot %}, including biased, discriminatory, or abusive outputs. If you see an offensive suggestion generated by {% data variables.product.prodname_copilot %}, please report the suggestion directly to copilot-safety@github.com so that we can improve our safeguards. diff --git a/translations/es-ES/content/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.md b/translations/es-ES/content/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.md index c143eadd386b..eceb516fc607 100644 --- a/translations/es-ES/content/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.md +++ b/translations/es-ES/content/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.md @@ -10,7 +10,7 @@ versions: {% 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)." +{% data variables.product.prodname_desktop %} will also show a system notification when checks fail. Para obtener más información sobre cómo habilitar las notificaciones, consulta la sección "[Configurar las notificaciones en GitHub Desktop](/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/configuring-notifications-in-github-desktop)". ## Ver y volver a ejecutar las verificaciones diff --git a/translations/es-ES/content/developers/apps/building-github-apps/authenticating-with-github-apps.md b/translations/es-ES/content/developers/apps/building-github-apps/authenticating-with-github-apps.md index 069906e9a2c2..8c7af75f816d 100644 --- a/translations/es-ES/content/developers/apps/building-github-apps/authenticating-with-github-apps.md +++ b/translations/es-ES/content/developers/apps/building-github-apps/authenticating-with-github-apps.md @@ -147,18 +147,24 @@ Para autenticarte con un token de acceso de instalación, inclúyela en el encab ```shell $ curl -i \ --H "Authorization: token YOUR_INSTALLATION_ACCESS_TOKEN" \ +-H "Authorization: Bearer YOUR_INSTALLATION_ACCESS_TOKEN" \ -H "Accept: application/vnd.github+json" \ {% data variables.product.api_url_pre %}/installation/repositories ``` `YOUR_INSTALLATION_ACCESS_TOKEN` es el valor que debes reemplazar. +{% note %} + +**Nota:** {% data reusables.getting-started.bearer-vs-token %} + +{% endnote %} + ## Acceder a las terminales de la API como una instalación Para encontrar un listado de las terminales de la API de REST disponibles para utilizarse con las {% data variables.product.prodname_github_apps %} utilizando un token de acceso de instalación, consulta la sección "[Terminales Disponibles](/rest/overview/endpoints-available-for-github-apps)". -Para encontrar un listad de terminales relacionado con las instalaciones, consulta la sección "[Instalaciones](/rest/reference/apps#installations)". +For a list of endpoints related to installations, see "[Installations](/rest/reference/apps#installations)." ## Acceso a Git basado en HTTP mediante una instalación diff --git a/translations/es-ES/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md b/translations/es-ES/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md index 30ef65cf5b01..512d70050839 100644 --- a/translations/es-ES/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md +++ b/translations/es-ES/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md @@ -108,13 +108,13 @@ Predeterminadametne, la respuesta lleva el siguiente formato. Los parámetros de El token de acceso del usuario permite que la GitHub App haga solicitudes a la API a nombre del usuario. - Authorization: token OAUTH-TOKEN + Authorization: Bearer OAUTH-TOKEN GET {% data variables.product.api_url_code %}/user Por ejemplo, en curl, puedes configurar el encabezado de autorización de la siguiente manera: ```shell -curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre %}/user +curl -H "Authorization: Bearer OAUTH-TOKEN" {% data variables.product.api_url_pre %}/user ``` ## Flujo de dispositivos @@ -133,12 +133,12 @@ Este flujo de dispositivos te permite autorizar usuarios para una app sin encabe Ya que tengas un token de OAuth para un usuario, puedes revisar a qué instalaciones puede acceder. - Authorization: token OAUTH-TOKEN + Authorization: Bearer OAUTH-TOKEN GET /user/installations También puedes verificar qué repositorios se encuentran accesibles para un usuario para una instalación. - Authorization: token OAUTH-TOKEN + Authorization: Bearer OAUTH-TOKEN GET /user/installations/:installation_id/repositories Puedes encontrar más detalles en: [Listar instalaciones de app accesibles para el token de acceso del usuario](/rest/apps#list-app-installations-accessible-to-the-user-access-token) y [Listar repositorios accesibles para el token de acceso del usuario](/rest/apps#list-repositories-accessible-to-the-user-access-token). diff --git a/translations/es-ES/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md b/translations/es-ES/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md index 829fd77ed81f..ea9fca1b45dc 100644 --- a/translations/es-ES/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md +++ b/translations/es-ES/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md @@ -23,6 +23,8 @@ Cuando una organización tiene una lista de direcciones permitidas, se negará e ## Agrega una lista de direcciones IP permitidas a una {% data variables.product.prodname_github_app %} +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.apps.settings-step %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} diff --git a/translations/es-ES/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md b/translations/es-ES/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md index badb34d08c55..b367c4646623 100644 --- a/translations/es-ES/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md +++ b/translations/es-ES/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md @@ -47,7 +47,7 @@ Las {% data variables.product.prodname_github_apps %} que hagan solicitudes de s {% ifversion fpt or ghec %} -Las {% data variables.product.prodname_github_apps %} que se instalan en una organización o repositrio dentro de una empresa en {% data variables.product.product_location %} están sujetas a un límite de 15,000 solicitudes por hora. +{% data variables.product.prodname_github_apps %} that are installed on an organization within an enterprise on {% data variables.product.product_location %} are subject to a limit of 15,000 requests per hour per organization that has installed the app. {% endif %} diff --git a/translations/es-ES/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md b/translations/es-ES/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md index dbf27e9745a5..14e7bf26d43f 100644 --- a/translations/es-ES/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md +++ b/translations/es-ES/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md @@ -107,13 +107,13 @@ Accept: application/xml El token de acceso te permite hacer solicitudes a la API a nombre de un usuario. - Authorization: token OAUTH-TOKEN + Authorization: Bearer OAUTH-TOKEN GET {% data variables.product.api_url_code %}/user Por ejemplo, en curl, puedes configurar el encabezado de autorización de la siguiente manera: ```shell -curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre %}/user +curl -H "Authorization: Bearer OAUTH-TOKEN" {% data variables.product.api_url_pre %}/user ``` ## Flujo de dispositivos diff --git a/translations/es-ES/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md b/translations/es-ES/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md index f7b42c35d616..32e7965f32fe 100644 --- a/translations/es-ES/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md +++ b/translations/es-ES/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md @@ -28,7 +28,7 @@ Si tu {% data variables.product.prodname_oauth_app %} no tiene acceso a un busca Verifica los encabezados para ver qué alcances de OAuth tienes, y cuáles acepta la acción de la API: ```shell -$ curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre %}/users/codertocat -I +$ curl -H "Authorization: Bearer OAUTH-TOKEN" {% data variables.product.api_url_pre %}/users/codertocat -I HTTP/2 200 X-OAuth-Scopes: repo, user X-Accepted-OAuth-Scopes: user diff --git a/translations/es-ES/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md b/translations/es-ES/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md index 53b6f12b043d..d9452630a022 100644 --- a/translations/es-ES/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md +++ b/translations/es-ES/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md @@ -37,12 +37,12 @@ $ export SECRET_TOKEN=your_token ## Validar cargas útiles de GitHub -Cuando se configura tu token secreto, {% data variables.product.product_name %} lo utiliza para crear una firma de hash con cada carga útil. Esta firma de hash se incluye con los encabezados de cada solicitud como `X-Hub-Signature-256`. +Cuando se configura tu token secreto, {% data variables.product.product_name %} lo utiliza para crear una firma de hash con cada carga útil. This hash signature is included with the headers of each request as `x-hub-signature-256`. {% ifversion fpt or ghes or ghec %} {% note %} -**Nota:** Para tener compatibilidad en versiones anteriores, también incluimos el encabezado `X-Hub-Signature` que se genera utilizando la función de hash SHA-1. De ser posible, te recomendamos que utilices el encabezado de `X-Hub-Signature-256` para mejorar la seguridad. El ejemplo siguiente demuestra cómo utilizar el encabezado `X-Hub-Signature-256`. +**Note:** For backward-compatibility, we also include the `x-hub-signature` header that is generated using the SHA-1 hash function. If possible, we recommend that you use the `x-hub-signature-256` header for improved security. The example below demonstrates using the `x-hub-signature-256` header. {% endnote %} {% endif %} diff --git a/translations/es-ES/content/education/contribute-with-github-community-exchange/getting-started-with-github-community-exchange.md b/translations/es-ES/content/education/contribute-with-github-community-exchange/getting-started-with-github-community-exchange.md index 96cd5b3478e6..da0d92b40a32 100644 --- a/translations/es-ES/content/education/contribute-with-github-community-exchange/getting-started-with-github-community-exchange.md +++ b/translations/es-ES/content/education/contribute-with-github-community-exchange/getting-started-with-github-community-exchange.md @@ -10,7 +10,7 @@ versions: {% data reusables.education.about-github-community-exchange-intro %} {% data variables.product.prodname_community_exchange %} can help you make your first open source contribution or grow your own open source project. -For more information about how {% data variables.product.prodname_community_exchange %} can help you as a student, see "[About {% data variables.product.prodname_community_exchange %}](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/about-github-community-exchange)." +Para obtener más información sobre cómo {% data variables.product.prodname_community_exchange %} puede ayudarte como alumno, consulta la sección "[Acerca de {% data variables.product.prodname_community_exchange %}](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-for-your-schoolwork/about-github-community-exchange)". ## Accessing {% data variables.product.prodname_community_exchange %} @@ -38,7 +38,7 @@ To star a repository: Go to your {% data variables.product.prodname_community_ex The {% data variables.product.prodname_community_exchange %} community moderates repository submissions. You can report abusive repositories, spammy, or disruptive content at any time. -To report an abusive repository: Go to your {% data variables.product.prodname_community_exchange %} home page, find the repository you want to report, click the {% octicon "kebab-horizontal" aria-label="The edit icon" %} drop-down right by its name, then click {% octicon "report" aria-label="The report symbol" %} **Report abuse**. +Para reportar un repositorio ofensivo: Dirígete a tu página principal de {% data variables.product.prodname_community_exchange %}, encuentra el repositorio que quieras reportar, haz clic en el menú desplegable de {% octicon "kebab-horizontal" aria-label="The edit icon" %} justo en su nombre y luego haz clic en {% octicon "report" aria-label="The report symbol" %} **Reportar abuso**. ## Leer más diff --git a/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students.md b/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students.md index 2021ebcd36e7..4633256b83b8 100644 --- a/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students.md +++ b/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students.md @@ -14,11 +14,11 @@ shortTitle: Para alumnos Usar {% data variables.product.prodname_dotcom %} para tus proyectos escolares es un modo práctico de colaborar con otros y crear un portfolio que exhiba experiencia práctica. -Cualquiera con una cuenta de {% data variables.product.prodname_dotcom %} puede colaborar en repositorios públicos y privados ilimitados con {% data variables.product.prodname_free_user %}. As a student, you can also apply for {% data variables.product.prodname_education %} student benefits. Your {% data variables.product.prodname_education %} student benefits and resources are all included in {% data variables.product.prodname_global_campus %}, a portal that allows you to access your education benefits, all in one place. For more information, see "[Apply to GitHub Global Campus as a student](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student)" and [{% data variables.product.prodname_education %}](https://education.github.com/). +Cualquiera con una cuenta de {% data variables.product.prodname_dotcom %} puede colaborar en repositorios públicos y privados ilimitados con {% data variables.product.prodname_free_user %}. As a student, you can also apply for {% data variables.product.prodname_education %} student benefits. Your {% data variables.product.prodname_education %} student benefits and resources are all included in {% data variables.product.prodname_global_campus %}, a portal that allows you to access your education benefits, all in one place. Para obtener más información, consulta las secciones "[Solicitar entrar a GitHub Global Campus como alumno](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student)" y [{% data variables.product.prodname_education %}](https://education.github.com/). Before applying for Global Campus, check if your learning community is already partnered with us as a {% data variables.product.prodname_campus_program %} school. Para obtener más información, consulta la sección "[Acerca de la {% data variables.product.prodname_campus_program %}](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/about-github-campus-program)". -If you're a member of a school club, a teacher can apply for {% data variables.product.prodname_global_campus %} so your team can collaborate using {% data variables.product.prodname_team %}, which allows unlimited users and private repositories, for free. For more information, see "[Apply to {% data variables.product.prodname_global_campus %} as a teacher](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)." +If you're a member of a school club, a teacher can apply for {% data variables.product.prodname_global_campus %} so your team can collaborate using {% data variables.product.prodname_team %}, which allows unlimited users and private repositories, for free. Para obtener más información, consulta la sección "[Solicitar ingresar al {% data variables.product.prodname_global_campus %} como docente](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)". Once you are a verified {% data variables.product.prodname_global_campus %} student, you can access {% data variables.product.prodname_global_campus %} anytime by going to the [{% data variables.product.prodname_education %} website](https://education.github.com). diff --git a/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student.md b/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student.md index 067bb8890705..1bffa421f51a 100644 --- a/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student.md +++ b/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student.md @@ -32,7 +32,7 @@ Es posible que se te pida periódicamente que vuelvas a verificar tu estado acad {% endnote %} -For information about renewing your {% data variables.product.prodname_global_campus %} access, see "[Expiration and renewals](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student/#expiration-and-renewals)." +Para obtener información sobre cómo renovar tu acceso al {% data variables.product.prodname_global_campus %}, consulta la sección "[Vencimiento y renovaciones](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student/#expiration-and-renewals)". ## Applying to {% data variables.product.prodname_global_campus %} diff --git a/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/about-github-global-campus-for-teachers.md b/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/about-github-global-campus-for-teachers.md index 29c16366bd1d..1e920fcaa4f2 100644 --- a/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/about-github-global-campus-for-teachers.md +++ b/translations/es-ES/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/about-github-global-campus-for-teachers.md @@ -25,7 +25,7 @@ Antes de solicitar un descuento individual, comprueba si tu comunidad de aprendi {% data variables.product.prodname_global_campus %} is a portal from which you can access your {% data variables.product.prodname_education %} benefits and resources, all in one place. On the {% data variables.product.prodname_global_campus %} portal, teachers of all levels can: {% data reusables.education.apply-for-team %} - View an overview of your active [{% data variables.product.prodname_classroom %}](https://classroom.github.com), including recent assignments and your class's progress at a glance, as well as links to {% data variables.product.prodname_classroom %}. - - View and interact with [{% data variables.product.prodname_discussions %}](https://github.com/orgs/community/discussions/categories/github-education) posted by your peers from around the world to discuss current trends in technology education, and see the latest posts from our [{% data variables.product.prodname_education %} blog](https://github.blog/category/education/). + - Ve e interactúa con los [{% data variables.product.prodname_discussions %}](https://github.com/orgs/community/discussions/categories/github-education) que publican tus compañeros de todo el mundo para debatir las tendencias actuales en la educación tecnológica y mira las publicaciones más recientes de nuestro [blog de {% data variables.product.prodname_education %}](https://github.blog/category/education/). - See student events curated by {% data variables.product.prodname_education %} and student leaders. - Stay in the know on what the student community is interested in by rewatching recent [Campus TV](https://www.twitch.tv/githubeducation) episodes. Campus TV is created by {% data variables.product.prodname_dotcom %} and student community leaders and can be watched live or on demand. - Request a {% data variables.product.prodname_dotcom %} swag bag with educational materials and goodies for your students. diff --git a/translations/es-ES/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom.md b/translations/es-ES/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom.md index b8d58ab579d6..a5ac6d80f748 100644 --- a/translations/es-ES/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom.md +++ b/translations/es-ES/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom.md @@ -30,7 +30,7 @@ The {% data variables.product.prodname_codespaces %} Education benefit gives ver {% data reusables.classroom.free-limited-codespaces-for-verified-teachers-beta-note %} -To become a verified teacher, you need to be approved for an educator or teacher benefit. For more information, see "[Apply to {% data variables.product.prodname_global_campus %} as a teacher](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)." +To become a verified teacher, you need to be approved for an educator or teacher benefit. Para obtener más información, consulta la sección "[Solicitar ingresar al {% data variables.product.prodname_global_campus %} como docente](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)". After you have confirmation that you are a verified teacher, visit [{% data variables.product.prodname_global_campus %} for Teachers](https://education.github.com/globalcampus/teacher) to upgrade the organization to GitHub Team. For more information, see [GitHub's products](/get-started/learning-about-github/githubs-products#github-team). diff --git a/translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-to-github-classroom.md b/translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-to-github-classroom.md index ca03572759d8..1b80c3756a8d 100644 --- a/translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-to-github-classroom.md +++ b/translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-to-github-classroom.md @@ -24,23 +24,22 @@ To configure an LMS to connect to {% data variables.product.prodname_classroom % ## Supported LMSes -{% data variables.product.prodname_classroom %} supports import of roster data from LMSes that implement Learning Tools Interoperability (LTI) standards. +{% note %} -- LTI version 1.0 and/or 1.1 -- LTI Names and Roles Provisioning 1.X +**Note:** {% data variables.product.prodname_classroom %} previously supported import of roster data from LMSes that implement Learning Tools Interoperability (LTI) versions 1.0 and 1.1. On June 30, 2022, the Instructional Management System (IMS) Global Learning Consortium [ended support for LTI versions 1.0 and 1.1](https://www.imsglobal.org/lti-security-announcement-and-deprecation-schedule). In the interest of keeping sensitive student information safe and secure, {% data variables.product.company_short %} has temporarily disabled importing roster data from LTI-compliant LMSes.

-Using LTI helps keep your information safe and secure. LTI is an industry-standard protocol and GitHub Classroom's use of LTI is certified by the Instructional Management System (IMS) Global Learning Consortium. For more information, see [Learning Tools Interoperability](https://www.imsglobal.org/activity/learning-tools-interoperability) and [About IMS Global Learning Consortium](http://www.imsglobal.org/aboutims.html) on the IMS Global Learning Consortium website. +Support for the latest version of Learning Tools Interoperability, [LTI 1.3](https://www.imsglobal.org/activity/learning-tools-interoperability), is currently being worked on and will be made available in {% data variables.product.prodname_classroom %} very soon. + +{% endnote %} + +LTI is an industry-standard protocol and GitHub Classroom's use of LTI is certified by the Instructional Management System (IMS) Global Learning Consortium. For more information, see [Learning Tools Interoperability](https://www.imsglobal.org/activity/learning-tools-interoperability) and [About IMS Global Learning Consortium](http://www.imsglobal.org/aboutims.html) on the IMS Global Learning Consortium website. {% data variables.product.company_short %} has tested import of roster data from the following LMSes into {% data variables.product.prodname_classroom %}. -- Canvas - Google Classroom -- Moodle -- Sakai -Currently, {% data variables.product.prodname_classroom %} doesn't support import of roster data from Blackboard or Brightspace. -## Generating configuration credentials for your classroom +## Connecting to Google Classroom {% data reusables.classroom.sign-into-github-classroom %} {% data reusables.classroom.click-classroom-in-list %} @@ -48,90 +47,16 @@ Currently, {% data variables.product.prodname_classroom %} doesn't support impor 1. If your classroom already has a roster, you can either update the roster or delete the roster and create a new roster. - For more information about deleting and creating a roster, see "[Deleting a roster for a classroom](/education/manage-coursework-with-github-classroom/manage-classrooms#deleting-a-roster-for-a-classroom)" and "[Creating a roster for your classroom](/education/manage-coursework-with-github-classroom/manage-classrooms#creating-a-roster-for-your-classroom)." - For more information about updating a roster, see "[Adding students to the roster for your classroom](/education/manage-coursework-with-github-classroom/manage-classrooms#adding-students-to-the-roster-for-your-classroom)." -1. In the list of LMSes, click your LMS. If your LMS is not supported, click **Other LMS**. - ![List of LMSes](/assets/images/help/classroom/classroom-settings-click-lms.png) -1. Read about connecting your LMS, then click **Connect to _LMS_**. -1. Copy the "Consumer Key", "Shared Secret", and "Launch URL" for the connection to the classroom. - ![Copy credentials](/assets/images/help/classroom/classroom-copy-credentials.png) - -## Configuring a generic LMS - -You must configure the privacy settings for your LMS to allow external tools to receive roster information. - -1. Navigate to your LMS. -1. Configure an external tool. -1. Provide the configuration credentials you generated in {% data variables.product.prodname_classroom %}. - - Consumer key - - Shared secret - - Launch URL (sometimes called "tool URL" or similar) - -## Configuring Canvas - -You can configure {% data variables.product.prodname_classroom %} as an external app for Canvas to import roster data into your classroom. For more information about Canvas, see the [Canvas website](https://www.instructure.com/canvas/). - -1. Sign into [Canvas](https://www.instructure.com/canvas/#login). -1. Select the Canvas course to integrate with {% data variables.product.prodname_classroom %}. -1. In the left sidebar, click **Settings**. -1. Click the **Apps** tab. -1. Click **View app configurations**. -1. Click **+App**. -1. Select the **Configuration Type** drop-down menu, and click **By URL**. -1. Paste the configuration credentials from {% data variables.product.prodname_classroom %}. For more information, see "[Generating configuration credentials for your classroom](#generating-configuration-credentials-for-your-classroom)." - - | Field in Canvas app configuration | Value or setting | - | :- | :- | - | **Consumer Key** | Consumer key from {% data variables.product.prodname_classroom %} | - | **Shared Secret** | Shared secret from {% data variables.product.prodname_classroom %} | - | **Allow this tool to access the IMS Names and Role Provisioning Service** | Enabled | - | **Configuration URL** | Launch URL from {% data variables.product.prodname_classroom %} | - - {% note %} - - **Note**: If you don't see a checkbox in Canvas labeled "Allow this tool to access the IMS Names and Role Provisioning Service", then your Canvas administrator must contact Canvas support to enable membership service configuration for your Canvas account. Without enabling this feature, you won't be able to sync the roster from Canvas. For more information, see [How do I contact Canvas Support?](https://community.canvaslms.com/t5/Canvas-Basics-Guide/How-do-I-contact-Canvas-Support/ta-p/389767) on the Canvas website. - - {% endnote %} - -1. Click **Submit**. -1. In the left sidebar, click **Home**. -1. To prompt Canvas to send a confirmation email, in the left sidebar, click **GitHub Classroom**. Follow the instructions in the email to finish linking {% data variables.product.prodname_classroom %}. - -## Configuring Moodle - -You can configure {% data variables.product.prodname_classroom %} as an activity for Moodle to import roster data into your classroom. For more information about Moodle, see the [Moodle website](https://moodle.org). - -You must be using Moodle version 3.0 or greater. - -1. Sign into [Moodle](https://moodle.org/login/). -1. Select the Moodle course to integrate with {% data variables.product.prodname_classroom %}. -1. Click **Turn editing on**. -1. Wherever you'd like {% data variables.product.prodname_classroom %} to be available in Moodle, click **Add an activity or resource**. -1. Choose **External tool** and click **Add**. -1. In the "Activity name" field, type "GitHub Classroom". -1. In the **Preconfigured tool** field, to the right of the drop-down menu, click **+**. -1. Under "External tool configuration", paste the configuration credentials from {% data variables.product.prodname_classroom %}. For more information, see "[Generating configuration credentials for your classroom](#generating-configuration-credentials-for-your-classroom)." - - | Field in Moodle app configuration | Value or setting | - | :- | :- | - | **Tool name** | {% data variables.product.prodname_classroom %} - _YOUR CLASSROOM NAME_

**Note**: You can use any name, but we suggest this value for clarity. | - | **Tool URL** | Launch URL from {% data variables.product.prodname_classroom %} | - | **LTI version** | LTI 1.0/1.1 | - | **Default launch container** | New window | - | **Consumer key** | Consumer key from {% data variables.product.prodname_classroom %} | - | **Shared secret** | Shared secret from {% data variables.product.prodname_classroom %} | - -1. Scroll to and click **Services**. -1. To the right of "IMS LTI Names and Role Provisioning", select the drop-down menu and click **Use this service to retrieve members' information as per privacy settings**. -1. Scroll to and click **Privacy**. -1. To the right of **Share launcher's name with tool** and **Share launcher's email with tool**, select the drop-down menus to click **Always**. -1. At the bottom of the page, click **Save changes**. -1. In the **Preconfigure tool** menu, click **GitHub Classroom - _YOUR CLASSROOM NAME_**. -1. Under "Common module settings", to the right of "Availability", select the drop-down menu and click **Hide from students**. -1. At the bottom of the page, click **Save and return to course**. -1. Navigate to anywhere you chose to display {% data variables.product.prodname_classroom %}, and click the {% data variables.product.prodname_classroom %} activity. - -## Importing a roster from your LMS - -For more information about importing the roster from your LMS into {% data variables.product.prodname_classroom %}, see "[Manage classrooms](/education/manage-coursework-with-github-classroom/manage-classrooms#creating-a-roster-for-your-classroom)." +1. In the list of LMSes, click Google Classroom. + ![Google Classroom](/assets/images/help/classroom/classroom-settings-click-google-classroom.png) +1. Sign in to Google, then select the Classroom to link to. + + +## Connecting to Canvas, Moodle, Sakai, and other LMSes + +Connecting to other LMSes is temporarily unavailable as {% data variables.product.company_short %} updates to Learning Tools Interoperability (LTI) version 1.3. For more information, see "[Supported LMSes](#supported-lmses)." + +In the meantime, you may manually input your roster for your class. For more information about manually importing the roster from your LMS into {% data variables.product.prodname_classroom %}, see "[Manage classrooms](/education/manage-coursework-with-github-classroom/manage-classrooms#creating-a-roster-for-your-classroom)." ## Disconnecting your LMS diff --git a/translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment.md b/translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment.md index 3a7153fb4d96..5b0acf5237e3 100644 --- a/translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment.md +++ b/translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment.md @@ -13,44 +13,44 @@ Puedes reutilizar una tarea grupal o individual existente en cualquier otra aula La tarea copiada incluye detalles de esta, tales como el nombre, el repositorio origen, pruebas de autoevaluación y el editor preferido. Puedes editar esta tarea después de que se copió para realizar cambios. No puedes hacer cambios al editor preferido. -## Reusing an assignment +## Reutilizar una tarea 1. Inicia sesión en {% data variables.product.prodname_classroom_with_url %}. -1. Navigate to the classroom that has the assignment that you want to reuse. +1. Navega al aula que tiene la tarea que quieras reutilizar. ![Aula en la lista de aulas de una organización](/assets/images/help/classroom/click-classroom-in-list.png) -1. In the list of assignments, click the assignment you want to reuse. +1. En la lista de tareas, haz clic en aquella que quieras reutilizar. ![Lista de tareas para las tareas de un aula](/assets/images/help/classroom/click-assignment-in-list.png) -1. Select the **{% octicon "pencil" aria-label="The pencil icon" %} Edit** dropdown menu in the top right of the page, then click **{% octicon "sync" aria-label="The sync icon" %} Reuse assignment**. +1. Selecciona el menú desplegable de **{% octicon "pencil" aria-label="The pencil icon" %} Editar** en la parte superior derecha de la página y luego haz clic en **{% octicon "sync" aria-label="The sync icon" %} Reutilizar tarea**. - ![Reuse assignment button](/assets/images/help/classroom/reuse-assignment-button.png) + ![Botón de reutilizar tarea](/assets/images/help/classroom/reuse-assignment-button.png) -1. In the "Reuse assignment" modal, use the **Choose an organization** dropdown menu to select the organization you want the assignment to be in. Then use the **Choose a classroom** dropdown menu to select the classroom within that organization that you want to copy the assignment to. +1. En el modl de "Reutilizar tarea", utiliza el menú desplegable **Elegir una organización** para seleccionar aquella en la cual quieras que esté la tarea. Luego, utiliza el menú desplegable **Elegir un aula** para seleccionar el aula dentro de la organización en la que quieres copiar la tarea. - ![Reuse assignment modal](/assets/images/help/classroom/reuse-assignment-modal.png) + ![Modal de reutilizar tarea](/assets/images/help/classroom/reuse-assignment-modal.png) -1. Click **Create assignment**. -1. The assignment is copied to the selected classroom, and a confirmation message is shown. If you chose to reuse an assignment with a template repository, the copying process may take a few minutes to complete, and you may need to refresh the page to see the completed message. +1. Haz clic en **Crear tarea**. +1. La tarea se copiará al aula seleccionada y se mostrará un mensaje de confirmación. Si eliges reutilizar una tarea con una plantilla de repositorio, el proceso de copiado podría llevar unos minutos para completarse y podrías necesitar actualizar la página para ver el mensaje de completado. - ![Completed message for reused assignment](/assets/images/help/classroom/reuse-assignment-completed-message.png) + ![Mensaje completado para la tarea reutilizada](/assets/images/help/classroom/reuse-assignment-completed-message.png) -## Reusing multiple assignments from a classroom +## Reutilizar tareas múltiples de un aula 1. Inicia sesión en {% data variables.product.prodname_classroom_with_url %}. -2. To the right of a classroom's name, select the {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} drop-down menu, then click **Reuse assignment**. +2. A la derecha del nombre del aula, selecciona el menú desplegable de {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} y haz clic en **Reutilizar tarea**. - ![Screenshot of classroom overview page with dropdown emphasized](/assets/images/help/classroom/classroom-reuse-assignment-modal.png) + ![Captura de pantalla de la página de resumen del aula con énfasis en el menú desplegable](/assets/images/help/classroom/classroom-reuse-assignment-modal.png) -3. In the "Reuse assignments" modal, use the **Choose an organization** dropdown menu to select the organization you want the assignments to be in. Then use the **Choose a classroom** dropdown menu to select the classroom within that organization that you want to copy the assignments to. +3. En el modal de "Reutilizar tareas", utiliza el menú desplegable **Elige una organización** para seleccionar aquella en la que quieres que estén las tareas. Luego, utiliza el menú desplegable **Elegir un aula** para seleccionar el aula dentro de la organización en la que quieres copiar la tarea. - ![Screenshot of reuse assignments modal](/assets/images/help/classroom/reuse-multiple-assignments-modal.png) + ![Captura de pantalla del modal de reutilización de tareas](/assets/images/help/classroom/reuse-multiple-assignments-modal.png) -4. To the left of each assignment, select the assignment you want to reuse. +4. A la izquierda de cada tarea, selecciona aquella que quieras reutilizar. - ![Screenshot of multiple selected assignments](/assets/images/help/classroom/multiple-assignments-selected.png) + ![Captura de pantalla de múltiples tareas seleccionadas](/assets/images/help/classroom/multiple-assignments-selected.png) -5. Click **Create assignments**. -6. The assignments are copied to the selected classroom. If you chose to reuse an assignment with a template repository, the copying process may take a few minutes to complete. +5. Haz clic en **Crear tareas**. +6. Las tareas se copiarán al aula seleccionada. Si eliges reutilizar una tarea con un repositorio de plantilla, el proceso de copiado podrá tomar unos cuantos minutos en completarse. diff --git a/translations/es-ES/content/get-started/exploring-projects-on-github/following-organizations.md b/translations/es-ES/content/get-started/exploring-projects-on-github/following-organizations.md index fbcb4c8cb008..d3bd49710afd 100644 --- a/translations/es-ES/content/get-started/exploring-projects-on-github/following-organizations.md +++ b/translations/es-ES/content/get-started/exploring-projects-on-github/following-organizations.md @@ -7,15 +7,11 @@ topics: - Profile --- -{% note %} - -**Nota:** La capacidad de seguir organizaciones se encuentra actualmente en beta público y está sujeta a cambios. - -{% endnote %} +{% data reusables.organizations.follow-organizations-beta %} ## Aceca de los seguidores en {% data variables.product.product_name %} -Cuando sigues organizaciones, puedes ver su actividad pública en tu tablero personal. Para obtener más información, consulta "[Acerca de tu tablero personal](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard#staying-updated-with-activity-from-the-community)". +{% data reusables.organizations.about-following-organizations %} For more information, see "[About your personal dashboard](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard#staying-updated-with-activity-from-the-community)." Puedes dejar de seguir a una organización si no quieres ver su actividad {% ifversion fpt or ghec %}pública{% endif %} en {% data variables.product.product_name %}. diff --git a/translations/es-ES/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md b/translations/es-ES/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md index 78176f43abed..dcc1431bc878 100644 --- a/translations/es-ES/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md +++ b/translations/es-ES/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md @@ -57,11 +57,21 @@ Si tienes repositorios o código fuente existentes que se almacenan localmente e 1. [Crear un repositorio nuevo](/repositories/creating-and-managing-repositories/creating-a-new-repository) en {% data variables.product.product_location %}. Para evitar errores, no inicialices el nuevo repositorio con archivos *README* licencia o `gitingnore`. Puedes agregar estos archivos después de que tu proyecto se haya subido a {% data variables.product.product_name %}. ![Desplegable Create New Repository (Crear nuevo repositorio)](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. Cambiar el directorio de trabajo actual en tu proyecto local. -4. Inicializar el directorio local como un repositorio de Git. - ```shell - $ git init -b main - ``` +4. Use the `init` command to initialize the local directory as a Git repository. By default, the initial branch is called `master`. + + If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using `-b`. + + ``` shell + $ git init -b main + ``` + + If you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using `&& git branch -m`. + + ``` shell + $ git init && git branch -m main + ``` 5. Agregar los archivos a tu nuevo repositorio local. Esto representa la primera confirmación. + ```shell $ git add . # Agrega el archivo en el repositorio local y lo presenta para la confirmación. {% data reusables.git.unstage-codeblock %} @@ -92,10 +102,19 @@ Si tienes repositorios o código fuente existentes que se almacenan localmente e 1. [Crear un repositorio nuevo](/articles/creating-a-new-repository) en {% data variables.product.product_location %}. Para evitar errores, no inicialices el nuevo repositorio con archivos *README* licencia o `gitingnore`. Puedes agregar estos archivos después de que tu proyecto se haya subido a {% data variables.product.product_name %}. ![Desplegable Create New Repository (Crear nuevo repositorio)](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. Cambiar el directorio de trabajo actual en tu proyecto local. -4. Inicializar el directorio local como un repositorio de Git. - ```shell - $ git init -b main - ``` +4. Use the `init` command to initialize the local directory as a Git repository. By default, the initial branch is called `master`. + + If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using `-b`. + + ``` shell + $ git init -b main + ``` + + If you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using `&& git branch -m`. + + ``` shell + $ git init && git branch -m main + ``` 5. Agregar los archivos a tu nuevo repositorio local. Esto representa la primera confirmación. ```shell $ git add . @@ -127,10 +146,19 @@ Si tienes repositorios o código fuente existentes que se almacenan localmente e 1. [Crear un repositorio nuevo](/articles/creating-a-new-repository) en {% data variables.product.product_location %}. Para evitar errores, no inicialices el nuevo repositorio con archivos *README* licencia o `gitingnore`. Puedes agregar estos archivos después de que tu proyecto se haya subido a {% data variables.product.product_name %}. ![Desplegable Create New Repository (Crear nuevo repositorio)](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. Cambiar el directorio de trabajo actual en tu proyecto local. -4. Inicializar el directorio local como un repositorio de Git. - ```shell - $ git init -b main - ``` +4. Use the `init` command to initialize the local directory as a Git repository. By default, the initial branch is called `master`. + + If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using `-b`. + + ``` shell + $ git init -b main + ``` + + If you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using `&& git branch -m`. + + ``` shell + $ git init && git branch -m main + ``` 5. Agregar los archivos a tu nuevo repositorio local. Esto representa la primera confirmación. ```shell $ git add . diff --git a/translations/es-ES/content/get-started/quickstart/be-social.md b/translations/es-ES/content/get-started/quickstart/be-social.md index 9938fad6cb1f..27cfae157f98 100644 --- a/translations/es-ES/content/get-started/quickstart/be-social.md +++ b/translations/es-ES/content/get-started/quickstart/be-social.md @@ -57,7 +57,23 @@ From your dashboard, click the drop down menu of your username on the left side ![Switch account context dropdown](/assets/images/help/overview/dashboard-contextswitcher.png) -### Exploring other projects on {% data variables.product.prodname_dotcom %} +{% ifversion for-you-feed %} + +## Following organizations + +{% data reusables.organizations.follow-organizations-beta %} + +{% data reusables.organizations.about-following-organizations %} + +To follow an organization, in the header of the organization's page, click **Follow**. + +![Screenshot of the organization header, with the follow button highlighted](/assets/images/help/profile/organization-profile-following.png) + +For more information, see "[Following organizations](/get-started/exploring-projects-on-github/following-organizations)." + +{% endif %} + +## Exploring other projects on {% data variables.product.prodname_dotcom %} You can discover new and interesting projects on {% data variables.product.prodname_dotcom %}'s Explore page. You can star interesting projects to make them easy to find again later. Visit your stars page to see all your starred projects. For more information about stars, see "[Saving repositories with stars](/get-started/exploring-projects-on-github/saving-repositories-with-stars)." diff --git a/translations/es-ES/content/get-started/quickstart/fork-a-repo.md b/translations/es-ES/content/get-started/quickstart/fork-a-repo.md index 600c30dca484..9d3c9526b65c 100644 --- a/translations/es-ES/content/get-started/quickstart/fork-a-repo.md +++ b/translations/es-ES/content/get-started/quickstart/fork-a-repo.md @@ -118,7 +118,7 @@ Right now, you have a fork of the Spoon-Knife repository, but you do not have th > Cloning into `Spoon-Knife`... > remote: Counting objects: 10, done. > remote: Compressing objects: 100% (8/8), done. - > remove: Total 10 (delta 1), reused 10 (delta 1) + > remote: Total 10 (delta 1), reused 10 (delta 1) > Unpacking objects: 100% (10/10), done. ``` diff --git a/translations/es-ES/content/graphql/guides/migrating-graphql-global-node-ids.md b/translations/es-ES/content/graphql/guides/migrating-graphql-global-node-ids.md index d784a1a9ca4f..465262cf93aa 100644 --- a/translations/es-ES/content/graphql/guides/migrating-graphql-global-node-ids.md +++ b/translations/es-ES/content/graphql/guides/migrating-graphql-global-node-ids.md @@ -32,7 +32,7 @@ Aquí tienes una solicitud de ejemplo que utiliza cURL: ``` $ curl \ - -H "Authorization: token $GITHUB_TOKEN" \ + -H "Authorization: Bearer $GITHUB_TOKEN" \ -H "X-Github-Next-Global-ID: 1" \ https://api.github.com/graphql \ -d '{ "query": "{ node(id: \"MDQ6VXNlcjM0MDczMDM=\") { id } }" }' diff --git a/translations/es-ES/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md b/translations/es-ES/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md index 1ec014d1b2ef..0a6335918aef 100644 --- a/translations/es-ES/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md +++ b/translations/es-ES/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md @@ -70,7 +70,7 @@ Puedes encontrar la ID de nodo de un proyecto organizacional si conoces el nombr ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"query{organization(login: \"ORGANIZATION\") {projectV2(number: NUMBER){id}}}"}' ``` {% endcurl %} @@ -94,7 +94,7 @@ También puedes encontrar la ID de nodo de todos los proyectos en tu organizaci ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"{organization(login: \"ORGANIZATION\") {projectsV2(first: 20) {nodes {id title}}}}"}' ``` {% endcurl %} @@ -125,7 +125,7 @@ Puedes encontrar la ID de nodo de un proyecto de usuario si conoces el número d ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"query{user(login: \"USER\") {projectV2(number: NUMBER){id}}}"}' ``` {% endcurl %} @@ -149,7 +149,7 @@ También puedes encontrar la ID de nodo de todos tus proyectos. El siguiente eje ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"{user(login: \"USER\") {projectsV2(first: 20) {nodes {id title}}}}"}' ``` {% endcurl %} @@ -180,7 +180,7 @@ El siguiente ejemplo devolverá la ID, nombre, ajustes y configuración para los ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2Field { id name } ... on ProjectV2IterationField { id name configuration { iterations { startDate id }}} ... on ProjectV2SingleSelectField { id name options { id name }}}}}}}"}' ``` {% endcurl %} @@ -284,7 +284,7 @@ Si solo necesitas el nombre e ID de un campo y no necesitas información sobre l ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2FieldCommon { id name }}}}}}"}' ``` {% endcurl %} @@ -354,7 +354,7 @@ El siguiente ejemplo devolverá las primeras 20 propuestas, solicitudes de cambi ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { items(first: 20) { nodes{ id fieldValues(first: 8) { nodes{ ... on ProjectV2ItemFieldTextValue { text field { ... on ProjectV2FieldCommon { name }}} ... on ProjectV2ItemFieldDateValue { date field { ... on ProjectV2FieldCommon { name } } } ... on ProjectV2ItemFieldSingleSelectValue { name field { ... on ProjectV2FieldCommon { name }}}}} content{ ... on DraftIssue { title body } ...on Issue { title assignees(first: 10) { nodes{ login }}} ...on PullRequest { title assignees(first: 10) { nodes{ login }}}}}}}}}"}' ``` {% endcurl %} @@ -446,7 +446,7 @@ El siguiente ejemplo agregará una propuesta o solicitud de cambios a tu proyect ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"mutation {addProjectV2ItemById(input: {projectId: \"PROJECT_ID\" contentId: \"CONTENT_ID\"}) {item {id}}}"}' ``` {% endcurl %} @@ -488,8 +488,8 @@ El siguiente ejemplo agregará un borrador de propuesta a tu proyecto. Reemplaza ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ - --data '{"query":"mutation {addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) {item {id}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) {projectItem {id}}}"}' ``` {% endcurl %} @@ -498,7 +498,7 @@ curl --request POST \ gh api graphql -f query=' mutation { addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) { - item { + projectItem { id } } @@ -512,7 +512,7 @@ La respuesta contendrá la ID de nodo del borrador de propuesta recién creado. { "data": { "addProjectV2ItemById": { - "item": { + "projectItem": { "id": "PVTI_lADOANN5s84ACbL0zgBbxFc" } } @@ -528,7 +528,7 @@ El siguiente ejemplo actualizará los ajustes de tu proyecto. Reemplaza a `PROJE ```shell curl --request POST \ --url https://api.github.com/graphql \ ---header 'Authorization: token TOKEN' \ +--header 'Authorization: Bearer TOKEN' \ --data '{"query":"mutation { updateProjectV2(input: { projectId: \"PROJECT_ID\", title: \"Project title\", public: false, readme: \"# Project README\n\nA long description\", shortDescription: \"A short description\"}) { projectV2 { id, title, readme, shortDescription }}}"}' ``` {% endcurl %} @@ -565,7 +565,7 @@ El siguiente ejemplo actualizará el valor de un campo de texto para un elemento ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { text: "Updated text" }}) { projectV2Item { id }}}"}' ``` {% endcurl %} @@ -619,7 +619,7 @@ El siguiente ejemplo actualizará el valor de un campo de selección simple para ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { singleSelectOptionId: "OPTION_ID" }}) { projectV2Item { id }}}"}' ``` {% endcurl %} @@ -659,7 +659,7 @@ El siguiente ejemplo actualizará el valor de un campo de iteración para un ele ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { singleSelectOptionId: "OPTION_ID" }}) { projectV2Item { id }}}"}' ``` {% endcurl %} @@ -694,7 +694,7 @@ El siguiente ejemplo borrará un elemento de un proyecto. Reemplaza a `PROJECT_I ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"mutation {deleteProjectV2Item(input: {projectId: \"PROJECT_ID\" itemId: \"ITEM_ID\"}) {deletedItemId}}"}' ``` {% endcurl %} diff --git a/translations/es-ES/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md b/translations/es-ES/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md index a0a5c21c5dbb..d39c4e42b9bb 100644 --- a/translations/es-ES/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md +++ b/translations/es-ES/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md @@ -24,7 +24,7 @@ Para transferir una propuesta abierta a otro repositorio, debes tener acceso de {% endnote %} -Cuando transfieres una propuesta, los comentarios, etiquetas y asignados se retienen. Los hitos de la propuesta no se retienen. Esta propuesta se mantendrá en cualquier tablero de proyecto que pertenezca al usuario o que se encuentre en la organización y se eliminará de cualquier tablero de proyecto de los repositorios. Para obtener más información, consulta "[Acerca de los tableros de proyectos](/articles/about-project-boards)." +Cuando transfieres un informe de problemas, se retendrá tanto los comentarios como las personas asignadas. Labels and milestones are also retained if they're present in the target repository, with labels matching by name and milestones matching by both name and due date. Esta propuesta se mantendrá en cualquier tablero de proyecto que pertenezca al usuario o que se encuentre en la organización y se eliminará de cualquier tablero de proyecto de los repositorios. Para obtener más información, consulta "[Acerca de los tableros de proyectos](/articles/about-project-boards)." Las personas o equipos que se mencionan en la propuesta recibirán una notificación que les haga saber que la propuesta se transfirió a un repositorio nuevo. La URL original se redirige a la URL nueva de la propuesta. Las personas que no tengan permisos de lectura en el repositorio nuevo verán un anuncio que les hará saber que la propuesta se transfirió a un repositorio nuevo al que no pueden acceder. diff --git a/translations/es-ES/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md b/translations/es-ES/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md index 7e04d40320b7..15cb0d21cdfc 100644 --- a/translations/es-ES/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md +++ b/translations/es-ES/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md @@ -38,6 +38,8 @@ También puedes configurar las direcciones IP permitidas para las organizaciones {% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %} +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} diff --git a/translations/es-ES/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md b/translations/es-ES/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md index 12cf639d3e9b..f97419459711 100644 --- a/translations/es-ES/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md +++ b/translations/es-ES/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md @@ -1,6 +1,6 @@ --- title: Habilitar o inhabilitar los debates de GitHub para una organización -intro: 'Puedes utilizar {% data variables.product.prodname_discussions %} en una organización como un lugar en el que esta pueda tener conversaciones que no sean específicas para un solo repositorio dentro de ella.' +intro: 'You can use {% data variables.product.prodname_discussions %} in an organization as a place for your organization to have conversations that aren''t specific to a single repository within your organization.' permissions: 'Organization owners can enable {% data variables.product.prodname_discussions %} for their organization.' versions: feature: discussions diff --git a/translations/es-ES/content/packages/index.md b/translations/es-ES/content/packages/index.md index a486e6d60608..3b87646850bc 100644 --- a/translations/es-ES/content/packages/index.md +++ b/translations/es-ES/content/packages/index.md @@ -18,6 +18,7 @@ featuredLinks: guideCards: - '{% ifversion docker-ghcr-enterprise-migration %}/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry{% endif %}' - '{% ifversion fpt or ghec or ghes > 3.4 %}/packages/working-with-a-github-packages-registry/working-with-the-container-registry{% else %}/packages/working-with-a-github-packages-registry/working-with-the-docker-registry{% endif %}' + - '{% ifversion packages-npm-v2 %}/packages/working-with-a-github-packages-registry/working-with-the-npm-registry{% endif %}' - /packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry changelog: label: packages diff --git a/translations/es-ES/content/packages/learn-github-packages/about-permissions-for-github-packages.md b/translations/es-ES/content/packages/learn-github-packages/about-permissions-for-github-packages.md index 504c1ca13aee..06f4205897ce 100644 --- a/translations/es-ES/content/packages/learn-github-packages/about-permissions-for-github-packages.md +++ b/translations/es-ES/content/packages/learn-github-packages/about-permissions-for-github-packages.md @@ -18,20 +18,22 @@ Los permisos de los paquetes pueden ser con alcance de repositorio o de usuario/ Un paquete con alcance de repositorio hereda los permisos y la visibilidad del repositorio al que pertenece el paquete. Puedes encontrar un paquete con alcance de un repositorio específico si vas a la página principal de este y haces clic en el enlace de **Paquetes** a la derecha de la página. {% ifversion fpt or ghec %}Para obtener más información, consulta la sección "[Conectar un repositorio con un paquete](/packages/learn-github-packages/connecting-a-repository-to-a-package)".{% endif %} -Los registros del {% data variables.product.prodname_registry %} que se mencionan a continuación utilizan permisos con alcance de repositorio: +The {% data variables.product.prodname_registry %} registries below **only** use repository-scoped permissions: {% ifversion not fpt or ghec %}- Docker registry (`docker.pkg.github.com`){% endif %} - - Registro de npm + {% ifversion packages-npm-v2 %}{% else %}- npm registry{% endif %} - Registro de RubyGems - Registro de Apache maven - Registro de NuGet +{% ifversion packages-npm-v2 %}For {% data variables.product.prodname_ghcr_and_npm_registry %}, you can choose to allow packages to be scoped to a user, an organization, or linked to a repository.{% endif %} + {% ifversion fpt or ghec %} ## Permisos granulares para paquetes con alcance de organización/usuario Los paquetes con permisos granulares tienen un alcance de una cuenta personal o de organización. Puedes cambiar el control de accesos y la visibilidad del paquete de forma separada desde un repositorio que esté conectado (o enlazado) a un paquete. -Actualmente, solo el {% data variables.product.prodname_container_registry %} ofrece permisos granulares para tus paquetes de imagen de contenedor. +Currently, the {% data variables.product.prodname_ghcr_and_npm_registry %} offer granular permissions for your container image packages. ## Permisos de visibilidad y acceso para las imágenes de contenedor diff --git a/translations/es-ES/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md b/translations/es-ES/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md index f1b170aa60c2..015ef76cff0f 100644 --- a/translations/es-ES/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md +++ b/translations/es-ES/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md @@ -16,7 +16,7 @@ shortTitle: Visibilidad & control de accesos Los paquetes con permisos granulares tienen un alcance de una cuenta personal o de organización. Puedes cambiar la visibilidad y el control de accesos de un paquete por separado desde el repositorio al cual está conectado (o enlazado). -Actualmente, solo puedes utilizar permisos granulares con el {% data variables.product.prodname_container_registry %}. Los permisos granulares no son compatibles en nuestros otros registros de paquete, tales como el registro de npm.{% ifversion docker-ghcr-enterprise-migration %} Para obtener más información sobre la migración del {% data variables.product.prodname_container_registry %}, consulta la sección "[Migrarse al {% data variables.product.prodname_container_registry %} desde el registro de Docker](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)".{% endif %} +Actualmente, solo puedes utilizar permisos granulares con el {% data variables.product.prodname_ghcr_and_npm_registry %}. Granular permissions are not supported in our other package registries, such as the RubyGems registry.{% ifversion docker-ghcr-enterprise-migration %} For more information about migration to the {% data variables.product.prodname_container_registry %}, see "[Migrating to the {% data variables.product.prodname_container_registry %} from the Docker registry](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)."{% endif %} Para obtener más información sobre los permisos de los paquetes con alcance de repositorio, los alcances relacionados con paquetes para los PAT o para administrar permisos para los flujos de trabajo de tus acciones, consulta la sección "[Acerca de los permisos para los Paquetes de GitHub](/packages/learn-github-packages/about-permissions-for-github-packages)". @@ -95,7 +95,7 @@ Para personalizar aún más el acceso a tu imagen de contenedor, consulta la sec {% ifversion fpt or ghec %} ## Asegurarse de que {% data variables.product.prodname_codespaces %} puede acceder a tu paquete -Predeterminadamente, un codespace puede acceder sin problema a algunos paquetes en el Registro de Contenedores de {% data variables.product.prodname_dotcom %}, tales como aquellos que se publican en el mismo repositorio con la opción de **Heredar acceso** seleccionada. Para obtener más información sobre qué tipo de acceso se configura automáticamente, consulta la sección "[Acceder a las imágenes almacenadas en el Registro de Contenedores de {% data variables.product.prodname_dotcom %}](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry#accessing-images-stored-in-github-container-registry)". +By default, a codespace can seamlessly access certain packages in the {% data variables.product.prodname_ghcr_and_npm_registry %}, such as those published in the same repository with the **Inherit access** option selected. For more information on which access is automatically configured, see "[Allowing your codespace to access a private image registry](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry#accessing-images-stored-in-container-registry-and-npm-registry)." De otra manera, para asegurarte de que un codespace tiene acceso a tu paquete, debes otorgar acceso al repositorio en donde se esté lanzando dicho codespace. diff --git a/translations/es-ES/content/packages/learn-github-packages/deleting-and-restoring-a-package.md b/translations/es-ES/content/packages/learn-github-packages/deleting-and-restoring-a-package.md index d4e95b815915..456eca256555 100644 --- a/translations/es-ES/content/packages/learn-github-packages/deleting-and-restoring-a-package.md +++ b/translations/es-ES/content/packages/learn-github-packages/deleting-and-restoring-a-package.md @@ -23,12 +23,12 @@ On {% data variables.product.prodname_dotcom %} if you have the required access, - an entire private package - an entire public package, if there's not more than 5000 downloads of any version of the package - a specific version of a private package -- a specific version of a public package, if the package version doesn't have more than 5000 downloads +- a specific version of a public package, if the package version doesn't have more than 5,000 downloads {% note %} **Note:** -- You cannot delete a public package if any version of the package has more than 5000 downloads. In this scenario, contact [GitHub support](https://support.github.com/contact?tags=docs-packages) for further assistance. +- You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact [GitHub support](https://support.github.com/contact?tags=docs-packages) for further assistance. - When deleting public packages, be aware that you may break projects that depend on your package. {% endnote %} @@ -46,7 +46,7 @@ You can use the REST API to manage your packages. For more information, see the {% endif %} -For packages that inherit their permissions and access from repositories, you can use GraphQL to delete a specific package version.{% ifversion fpt or ghec %} The {% data variables.product.prodname_registry %} GraphQL API does not support containers or Docker images that use the package namespace `https://ghcr.io/OWNER/PACKAGE-NAME`.{% endif %} For more information about GraphQL support, see "[Deleting a version of a repository-scoped package with GraphQL](#deleting-a-version-of-a-repository-scoped-package-with-graphql)." +For packages that inherit their permissions and access from repositories, you can use GraphQL to delete a specific package version.{% data reusables.package_registry.no-graphql-to-delete-packages %} For more information about GraphQL support, see "[Deleting a version of a repository-scoped package with GraphQL](#deleting-a-version-of-a-repository-scoped-package-with-graphql)." {% endif %} @@ -54,18 +54,19 @@ For packages that inherit their permissions and access from repositories, you ca For packages that inherit their access permissions from repositories, you can delete a package if you have admin permissions to the repository. -Repository-scoped packages on {% data variables.product.prodname_registry %} include these packages: -- npm -- RubyGems -- maven -- Gradle -- NuGet -{% ifversion not fpt or ghec %}- Docker images at `docker.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`{% endif %} +The {% data variables.product.prodname_registry %} registries below **only** use repository-scoped permissions: + + {% ifversion not fpt or ghec %}- Docker images at `docker.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`{% endif %} + {% ifversion packages-npm-v2 %}{% else %}- npm{% endif %} + - RubyGems registry + - Apache Maven registry + - NuGet registry + +{% ifversion packages-npm-v2 %}For {% data variables.product.prodname_ghcr_and_npm_registry %}, you can choose to allow packages to be scoped to a user, an organization, or linked to a repository.{% endif %} {% ifversion fpt or ghec %} -To delete a package that has granular permissions separate from a repository, such as container images stored at `https://ghcr.io/OWNER/PACKAGE-NAME`, you must have admin access to the package. -For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)." +To delete a package that has granular permissions separate from a repository, such as container images stored at `https://ghcr.io/OWNER/PACKAGE-NAME` or `https://npm.pkg.github.com/OWNER/PACKAGE-NAME`, you must have admin access to the package. For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)." {% endif %} @@ -89,9 +90,7 @@ To delete a version of a repository-scoped package, you must have admin permissi For packages that inherit their permissions and access from repositories, you can use the GraphQL to delete a specific package version. -{% ifversion fpt or ghec %} -For containers or Docker images at `ghcr.io`, GraphQL is not supported but you can use the REST API. For more information, see the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." -{% endif %} +{% data reusables.package_registry.no-graphql-to-delete-packages %}{% ifversion fpt or ghec %} You can however use the REST API. For more information, see the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)."{% endif %} Use the `deletePackageVersion` mutation in the GraphQL API. You must use a token with the `read:packages`, `delete:packages`, and `repo` scopes. For more information about tokens, see "[About {% data variables.product.prodname_registry %}](/packages/publishing-and-managing-packages/about-github-packages#authenticating-to-github-packages)." diff --git a/translations/es-ES/content/packages/learn-github-packages/introduction-to-github-packages.md b/translations/es-ES/content/packages/learn-github-packages/introduction-to-github-packages.md index fc5090006ea3..5450ffcff9f3 100644 --- a/translations/es-ES/content/packages/learn-github-packages/introduction-to-github-packages.md +++ b/translations/es-ES/content/packages/learn-github-packages/introduction-to-github-packages.md @@ -51,7 +51,7 @@ For more information about the configuration of {% data variables.product.prodna | | | |--------------------|--------------------| -| Permissions | {% ifversion fpt or ghec %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_container_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted.

For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} | +| Permissions | {% ifversion fpt or ghec %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_ghcr_and_npm_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted.

For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} | | Visibility | {% data reusables.package_registry.public-or-private-packages %} | For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)." @@ -101,7 +101,9 @@ For more information about Docker and the {% data variables.product.prodname_con ## Managing packages {% ifversion fpt or ghec %} -You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. For more information, see the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." +You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." + +{% data reusables.package_registry.no-graphql-to-delete-packages %} {% endif %} {% ifversion ghes %} @@ -112,7 +114,9 @@ You can delete a private or public package in the {% data variables.product.prod You can delete a version of a package in the {% data variables.product.product_name %} user interface or using the GraphQL API. {% endif %} -When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and "[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." +When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. + +For more information, see {% ifversion ghes or ghae %}"[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and {% endif %}"[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." You can configure webhooks to subscribe to package-related events, such as when a package is published or updated. For more information, see the "[`package` webhook event](/webhooks/event-payloads/#package)." diff --git a/translations/es-ES/content/packages/learn-github-packages/viewing-packages.md b/translations/es-ES/content/packages/learn-github-packages/viewing-packages.md index 1fe540bc95f6..bf14b2ab7c8f 100644 --- a/translations/es-ES/content/packages/learn-github-packages/viewing-packages.md +++ b/translations/es-ES/content/packages/learn-github-packages/viewing-packages.md @@ -23,15 +23,15 @@ versions: Tu capacidad de ver un paquete depende de varios factores. Predeterminadamente, puedes ver todos los paquetes que hayas publicado. -Los paquetes con alcance de repositorio heredan sus permisos y visibilidad desde el repositorio al que pertenece el paquete. Los siguientes registros utilizan este tipo de permisos:{% ifversion not fpt or ghec %} +Los paquetes con alcance de repositorio heredan sus permisos y visibilidad desde el repositorio al que pertenece el paquete. The registries below **only** use this type of permissions:{% ifversion not fpt or ghec %} - Registro de Docker (`docker.pkg.github.com`){% endif %} -- Registro de npm +{% ifversion packages-npm-v2 %}{% else %}- npm registry{% endif %} - Registro de RubyGems - Registro de Apache maven - Registro de NuGet {% ifversion fpt or ghec %} -El registro del contenedor te ofrece la opción de contar con permisos granulares y configuraciones de visibilidad que se pueden personalizar para cada paquete que pertenezca a un usuario personal o a una cuenta de organización. Puedes elegir utilizar permisos granulares o conectar el paquete a un repositorio y heredar sus permisos. Para obtener más información, consulta la sección "[Conectar un repositorio a un paquete](/packages/learn-github-packages/connecting-a-repository-to-a-package)". +The {% data variables.product.prodname_ghcr_and_npm_registry %} offer you the option of granular permissions and visibility settings that can be customized for each package owned by a personal user or organization account. Puedes elegir utilizar permisos granulares o conectar el paquete a un repositorio y heredar sus permisos. Para obtener más información, consulta la sección "[Conectar un repositorio a un paquete](/packages/learn-github-packages/connecting-a-repository-to-a-package)". {% endif %} Para obtener más información, consulta las secciones "[Acerca de los permisos para GitHub Packages](/packages/learn-github-packages/about-permissions-for-github-packages){% ifversion fpt or ghec %}" y "[Configurar el control de accesos y la visibilidad de un paquete](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility){% endif %}". diff --git a/translations/es-ES/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md b/translations/es-ES/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md index 83da88a908c6..530258476f7e 100644 --- a/translations/es-ES/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md +++ b/translations/es-ES/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md @@ -24,9 +24,9 @@ shortTitle: Publicar & instalar con acciones Puedes ampliar las capacidades de CI y CD de tu repositorio publicando o instalando paquetes como parte de tu flujo de trabajo. {% ifversion fpt or ghec %} -### Autenticarse en el {% data variables.product.prodname_container_registry %} +### Authenticating to the {% data variables.product.prodname_ghcr_and_npm_registry %} -{% data reusables.package_registry.authenticate_with_pat_for_container_registry %} +{% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} {% endif %} @@ -40,7 +40,7 @@ Puedes hacer referencia al `GITHUB_TOKEN` en tu archivo de flujo de trabajo medi {% note %} -**Nota:** Los paquetes que pertenecen a repositorios incluyen RubyGems, npm, Apache Maven, NuGet, {% ifversion fpt or ghec %}y Gradle. {% else %}Los paquetes de Gradle y de Docker que utilizan el designador de nombre del paquete `docker.pkg.github.com`.{% endif %} +**Note:** Some registries, such as RubyGems, {% ifversion packages-npm-v2 %}{% else %}npm, {% endif %}Apache Maven, NuGet, {% ifversion fpt or ghec %}and Gradle{% else %}Gradle, and Docker packages that use the package namespace `docker.pkg.github.com`{% endif %}, only allow repository-owned packages. With {% data variables.product.prodname_ghcr_and_npm_registry_full %} you can choose to allow packages to be owned by a user, an organization, or linked to a repository. {% endnote %} @@ -49,11 +49,11 @@ Cuando habilitas las Acciones de GitHub, GitHub instala una App GitHub en tu rep El {% data variables.product.prodname_registry %} te permite subir y extraer paquetes mediante el `GITHUB_TOKEN` que está disponible para un flujo de trabajo de {% data variables.product.prodname_actions %}. {% ifversion fpt or ghec %} -## Acerca de los permisos y el acceso de paquetes para el {% data variables.product.prodname_container_registry %} +## About permissions and package access for {% data variables.product.prodname_ghcr_and_npm_registry %} -El {% data variables.product.prodname_container_registry %} (`ghcr.io`) permite a los usuarios crear y administrar contenedores como recursos independientes a nivel organizacional. Los contenedores pueden pertenecerle a una cuenta personal o de organización y puedes personalizar el acceso a cada uno de ellos por separado desde los permisos de repositorio. +The {% data variables.product.prodname_ghcr_and_npm_registry_full %} allows users to create and administer packages as free-standing resources at the organization level. Packages can be owned by an organization or personal account and you can customize access to each of your packages separately from repository permissions. -Todos los flujos de trabajo que accedan al {% data variables.product.prodname_container_registry %} deben utilizar el `GITHUB_TOKEN` en vez de un token de acceso personal. Para obtener más información acerca de las mejores prácticas de seguridad, consulta la sección "[Fortalecimiento de seguridad para las GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)". +All workflows accessing the {% data variables.product.prodname_ghcr_and_npm_registry %} should use the `GITHUB_TOKEN` instead of a personal access token. Para obtener más información acerca de las mejores prácticas de seguridad, consulta la sección "[Fortalecimiento de seguridad para las GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)". ## Configuración de acceso y permisos predeterminados para los contenedores que se modifican a través de los flujos de trabajo @@ -484,9 +484,9 @@ El instalar los paquetes que hospeda el {% data variables.product.prodname_regis {% data reusables.package_registry.actions-configuration %} {% ifversion fpt or ghec %} -## Actualizar un flujo de trabajo que tiene acceso a `ghcr.io` +## Upgrading a workflow that accesses a registry using a PAT -El {% data variables.product.prodname_container_registry %} es compatible con el `GITHUB_TOKEN` para una autenticación más fácil y segura en tus flujos de trabajo. Si tu flujo de trabajo está utilizando un token de acceso personal (PAT) para autenticarse en `ghcr.io`, entonces te recomendamos ampliamente que actualices tu flujo de trabajo para utilizar el `GITHUB_TOKEN`. +The {% data variables.product.prodname_ghcr_and_npm_registry %} support the `GITHUB_TOKEN` for easy and secure authentication in your workflows. If your workflow is using a personal access token (PAT) to authenticate to the registry, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. Para obtener más información sobre el `GITHUB_TOKEN`, consulta la sección "[Autenticación en un flujo de trabajo](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)". @@ -501,9 +501,9 @@ El utilizar el `GITHUB_TOKEN` en vez de un PAT, el cual incluya el alcance de `r {% endnote %} 1. Opcionalmente, utiliza el menú desplegable de "rol", selecciona el nivel de acceso predeterminado que te gustaría que tuviera el repositorio en tu imagen de contenedor. ![Niveles de acceso de permisos para otorgar a los repositorios](/assets/images/help/package-registry/repository-permission-options-for-package-access-through-actions.png) -1. Abre tu archivo de flujo de trabajo. En la línea en donde ingresas a `ghcr.io`, reemplaza tu PAT con {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. +1. Abre tu archivo de flujo de trabajo. On the line where you log in to the registry, replace your PAT with {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. -Por ejemplo, este flujo de trabajo publica una imagen de Docker utilizando {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} para autenticarse. +For example, this workflow publishes a Docker image to the {% data variables.product.prodname_container_registry %} and uses {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} to authenticate. ```yaml{:copy} name: Demo Push diff --git a/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md b/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md index 6a866421ce16..a47d638a3b7c 100644 --- a/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md +++ b/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md @@ -42,7 +42,9 @@ Cuando instalas o publicas una imagen de Docker, el {% data variables.product.pr ## Autenticarse en el {% data variables.product.prodname_container_registry %} -{% data reusables.package_registry.authenticate_with_pat_for_container_registry %} +{% ifversion fpt or ghec or ghes > 3.4 %} +Para autenticarte en el {% data variables.product.prodname_container_registry %} (`ghcr.io`) dentro de un flujo de trabajo de {% data variables.product.prodname_actions %}, utiliza el `GITHUB_TOKEN` para obtener la mejor seguridad y experiencia. {% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} +{% endif %} {% ifversion ghes %}Asegúrate de reemplazar a `HOSTNAME` con el nombre de host o dirección IP de {% data variables.product.product_location_enterprise %} en los siguientes ejemplos.{% endif %} diff --git a/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md b/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md index 993e933de3bb..8007cd2b6f96 100644 --- a/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md +++ b/translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md @@ -21,6 +21,8 @@ shortTitle: npm registry {% data reusables.package_registry.admins-can-configure-package-types %} +{% ifversion packages-npm-v2 %} +{% else %} ## Limits for published npm versions If you publish over 1,000 npm package versions to {% data variables.product.prodname_registry %}, you may see performance issues and timeouts occur during usage. @@ -28,12 +30,17 @@ If you publish over 1,000 npm package versions to {% data variables.product.prod In the future, to improve performance of the service, you won't be able to publish more than 1,000 versions of a package on {% data variables.product.prodname_dotcom %}. Any versions published before hitting this limit will still be readable. If you reach this limit, consider deleting package versions or contact Support for help. When this limit is enforced, our documentation will be updated with a way to work around this limit. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" or "[Contacting Support](/packages/learn-github-packages/about-github-packages#contacting-support)." +{% endif %} ## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} -{% data reusables.package_registry.authenticate-packages-github-token %} +{% ifversion packages-npm-v2 %} +{% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} + +You can also choose to give access permissions to packages independently for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_actions %}. For more information, see "[Ensuring Codespaces access to your package](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-codespaces-access-to-your-package) and [Ensuring workflow access to your package](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-workflow-access-to-your-package)." +{% endif %} ### Authenticating with a personal access token @@ -94,12 +101,24 @@ $ npm login --scope=@OWNER --registry=https://HOSTNAME/_regist {% endnote %} +{% ifversion packages-npm-v2 %} +The {% data variables.product.prodname_registry %} registry stores npm packages within your organization or personal account, and allows you to associate a package with a repository. You can choose whether to inherit permissions from a repository, or set granular permissions independently of a repository. +{% endif %} + By default, {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the name field of the *package.json* file. For example, you would publish a package named `@my-org/test` to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. If you're running [npm v8.5.3](https://github.com/npm/cli/releases/tag/v8.5.3) or later, you can add a summary for the package listing page by including a *README.md* file in your package directory. For more information, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" and "[How to create Node.js Modules](https://docs.npmjs.com/getting-started/creating-node-modules)" in the npm documentation. You can publish multiple packages to the same {% data variables.product.prodname_dotcom %} repository by including a `URL` field in the *package.json* file. For more information, see "[Publishing multiple packages to the same repository](#publishing-multiple-packages-to-the-same-repository)." +{% ifversion fpt or ghec %} +When a package is published, it isn't automatically linked to a repository. You can however choose to link your published package to a repository using the user interface or command line. For more information, see "[Connecting a repository to a package](/packages/learn-github-packages/connecting-a-repository-to-a-package)." +{% endif %} + You can set up the scope mapping for your project using either a local *.npmrc* file in the project or using the `publishConfig` option in the *package.json*. {% data variables.product.prodname_registry %} only supports scoped npm packages. Scoped packages have names with the format of `@owner/name`. Scoped packages always begin with an `@` symbol. You may need to update the name in your *package.json* to use the scoped name. For example, `"name": "@codertocat/hello-world-npm"`. +{% ifversion packages-npm-v2 %} +When you first publish a package, the default visibility is private. When a package is linked to repository, the package visibility is dependent on the repository's visibility. To change the visibility or set access permissions, see "[Configuring a package's access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." +{% endif %} + {% data reusables.package_registry.viewing-packages %} ### Publishing a package using a local *.npmrc* file diff --git a/translations/es-ES/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md b/translations/es-ES/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md index b844e2251b6e..05e0b384b9e5 100644 --- a/translations/es-ES/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md +++ b/translations/es-ES/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md @@ -47,7 +47,7 @@ To set up a `www` or custom subdomain, such as `www.example.com` or `blog.exampl {% data reusables.pages.sidebar-pages %} 4. Under "Custom domain", type your custom domain, then click **Save**. If you are publishing your site from a branch, this will create a commit that adds a `CNAME` file to the root of your source branch. If you are publishing your site with a custom {% data variables.product.prodname_actions %} workflow , no `CNAME` file is created. For more information about your publishing source, see "[Configuring a publishing source for your GitHub Pages site](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." ![Save custom domain button](/assets/images/help/pages/save-custom-subdomain.png) -5. Navigate to your DNS provider and create a `CNAME` record that points your subdomain to the default domain for your site. For example, if you want to use the subdomain `www.example.com` for your user site, create a `CNAME` record that points `www.example.com` to `.github.io`. If you want to use the subdomain `www.anotherexample.com` for your organization site, create a `CNAME` record that points `www.anotherexample.com` to `.github.io`. The `CNAME` record should always point to `.github.io` or `.github.io`, excluding the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} +5. Navigate to your DNS provider and create a `CNAME` record that points your subdomain to the default domain for your site. For example, if you want to use the subdomain `www.example.com` for your user site, create a `CNAME` record that points `www.example.com` to `.github.io`. If you want to use the subdomain `another.example.com` for your organization site, create a `CNAME` record that points `another.example.com` to `.github.io`. The `CNAME` record should always point to `.github.io` or `.github.io`, excluding the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} {% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %} {% data reusables.command_line.open_the_multi_os_terminal %} diff --git a/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-merging-for-pull-requests.md b/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-merging-for-pull-requests.md index 4ad2640d8380..8ed6b48817f9 100644 --- a/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-merging-for-pull-requests.md +++ b/translations/es-ES/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-merging-for-pull-requests.md @@ -15,7 +15,7 @@ shortTitle: Configure commit merging {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -1. Under {% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-6069 %}"Pull Requests"{% else %}"Merge button"{% endif %}, select **Allow merge commits**. This allows contributors to merge a pull request with a full history of commits.{% ifversion default-merge-squash-commit-message %} ![Screenshot of Pull Request settings with allow merge commits checkbox emphasized](/assets/images/help/repository/allow-merge-commits.png){% endif %}{% ifversion ghes = 3.6 %} ![Screenshot of Pull Request settings with allow merge commits checkbox emphasized](/assets/images/help/repository/allow-merge-commits-no-dropdown.png){% endif %} +1. Under {% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-6069 %}"Pull Requests"{% else %}"Merge button"{% endif %}, select **Allow merge commits**. Esto permite que los contribuyentes fusionen una solicitud de cambios con un historial completo de confirmaciones.{% ifversion default-merge-squash-commit-message %} ![Screenshot of Pull Request settings with allow merge commits checkbox emphasized](/assets/images/help/repository/allow-merge-commits.png){% endif %}{% ifversion ghes = 3.6 %} ![Screenshot of Pull Request settings with allow merge commits checkbox emphasized](/assets/images/help/repository/allow-merge-commits-no-dropdown.png){% endif %} {% ifversion ghes < 3.6 %} ![allow_standard_merge_commits](/assets/images/help/repository/pr-merge-full-commits.png){% endif %} {% ifversion default-merge-squash-commit-message %} diff --git a/translations/es-ES/content/rest/actions/permissions.md b/translations/es-ES/content/rest/actions/permissions.md index 9b62bcbf848e..80569d139ef3 100644 --- a/translations/es-ES/content/rest/actions/permissions.md +++ b/translations/es-ES/content/rest/actions/permissions.md @@ -2,7 +2,7 @@ title: GitHub Actions Permissions allowTitleToDifferFromFilename: true shortTitle: Permisos -intro: 'The {% data variables.product.prodname_actions %} Permissions API allows you to set permissions for what enterprises, organizations, and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} are allowed to run.' +intro: 'La API de permisos de {% data variables.product.prodname_actions %} te permite configurar los permisos para cuáles empresas, organizaciones y repositorios pueden ejecutar {% data variables.product.prodname_actions %} y qué acciones{% ifversion actions-workflow-policy %} y flujos de trabajo reutilizables{% endif %} pueden ejecutarse.' topics: - API versions: diff --git a/translations/es-ES/content/rest/actions/workflow-runs.md b/translations/es-ES/content/rest/actions/workflow-runs.md index 1bd63a9ca99e..77f3b2dcb700 100644 --- a/translations/es-ES/content/rest/actions/workflow-runs.md +++ b/translations/es-ES/content/rest/actions/workflow-runs.md @@ -10,7 +10,7 @@ versions: ghec: '*' --- -## About the Workflow runs API +## Acerca de la API de ejecuciones de flujo de trabajo La API de ejecuciones de flujo de trabajo te permite ver, volver a ejecutar, cancelar y ver las bitácoras de las ejecuciones de los flujos de trabajo. {% data reusables.actions.about-workflow-runs %} Para obtener más información, consulta la sección "[Administrar una ejecución de flujo de trabajo](/actions/automating-your-workflow-with-github-actions/managing-a-workflow-run)". diff --git a/translations/es-ES/content/rest/activity/notifications.md b/translations/es-ES/content/rest/activity/notifications.md index de88cb71bf23..c9a8a99f4579 100644 --- a/translations/es-ES/content/rest/activity/notifications.md +++ b/translations/es-ES/content/rest/activity/notifications.md @@ -11,7 +11,7 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Notifications API +## Acerca de la API de notificaciones La API de notificaciones te permite administrar las notificaciones de {% data variables.product.product_name %}. Para obtener más información sobre las notificaciones, consulta la sección "[Acerca de las notificaciones](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)". diff --git a/translations/es-ES/content/rest/apps/apps.md b/translations/es-ES/content/rest/apps/apps.md index 40ee60bdb7de..0e4b884b5b5a 100644 --- a/translations/es-ES/content/rest/apps/apps.md +++ b/translations/es-ES/content/rest/apps/apps.md @@ -1,7 +1,7 @@ --- title: GitHub Apps allowTitleToDifferFromFilename: true -intro: 'The {% data variables.product.prodname_github_apps %} API enables you to retrieve information about {% data variables.product.prodname_github_apps %}.' +intro: 'La API de {% data variables.product.prodname_github_apps %} te permite recuperar información sobre las {% data variables.product.prodname_github_apps %}.' topics: - API miniTocMaxHeadingLevel: 3 @@ -12,7 +12,7 @@ versions: ghec: '*' --- -## About the {% data variables.product.prodname_github_apps %} API +## Acerca de la API de {% data variables.product.prodname_github_apps %} {% data reusables.apps.general-apps-restrictions %} @@ -20,6 +20,6 @@ Esta página lista las terminales a las que puedes acceder mientras te autentica Cuando estás autenticado como una GitHub App, la API de GitHub Apps te habilita para obtener información de alto nivel sobre una GitHub App así como para obtener información específica sobre las instalaciones de éstas. -You can access REST API endpoints while authenticated as a GitHub App. These endpoints have text that says "Works with GitHub Apps." También puedes acceder a estas terminales mientras estás autenticado como un usuario. +Puedes acceder a las terminales de la API de REST mientras estás autenticado como una GitHub App. Estas terminales tienen un texto que dice "Funciona con GitHub Apps". También puedes acceder a estas terminales mientras estás autenticado como un usuario. -A subset of REST API endpoints requires authenticating as a GitHub App installation. Consulta las [Instalaciones](/rest/reference/apps#installations) para obtener una lista de estas terminales. +Un subconjunto de terminales de la API de REST requiere autenticarse como una instalación de GitHub App. Consulta las [Instalaciones](/rest/reference/apps#installations) para obtener una lista de estas terminales. diff --git a/translations/es-ES/content/rest/apps/installations.md b/translations/es-ES/content/rest/apps/installations.md index 8b84958f1a8e..704bf7eeaf60 100644 --- a/translations/es-ES/content/rest/apps/installations.md +++ b/translations/es-ES/content/rest/apps/installations.md @@ -17,4 +17,4 @@ versions: Una _instalación_ se refiere a cualquier cuenta de usuario o de organización que tenga la app instalada. Para obtener más información sobre cómo autenticarte como una instalación y limitar el acceso a repositorios específicos, consulta la sección "[Autenticarte como una instalación](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)". -Para listar las instalaciones de una GitHub App para una organización, consulta la sección "[Listar instalaciones de la app para una organización](/rest/reference/orgs#list-app-installations-for-an-organization)". +Para listar las instalaciones de una GitHub App para una organización, consulta la sección "[Listar instalaciones de la app para una organización](/rest/orgs/orgs#list-app-installations-for-an-organization)". diff --git a/translations/es-ES/content/rest/apps/oauth-applications.md b/translations/es-ES/content/rest/apps/oauth-applications.md index 406e67d4ce90..a6b28a1c2663 100644 --- a/translations/es-ES/content/rest/apps/oauth-applications.md +++ b/translations/es-ES/content/rest/apps/oauth-applications.md @@ -12,6 +12,6 @@ versions: ghec: '*' --- -## About the {% data variables.product.prodname_oauth_app %} API +## Acerca de la API de {% data variables.product.prodname_oauth_app %} -You can use this API to manage the OAuth tokens an {% data variables.product.prodname_oauth_app %} uses to access people's accounts on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. +Puedes utilizar esta API para administrar los tokens de OAuth que utiliza una {% data variables.product.prodname_oauth_app %} para acceder a las cuentas de las personas en {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. diff --git a/translations/es-ES/content/rest/apps/webhooks.md b/translations/es-ES/content/rest/apps/webhooks.md index 6967cc2fc8a3..b74e6abe52e6 100644 --- a/translations/es-ES/content/rest/apps/webhooks.md +++ b/translations/es-ES/content/rest/apps/webhooks.md @@ -1,5 +1,5 @@ --- -title: GitHub App webhooks +title: Webhooks de las GitHub Apps allowTitleToDifferFromFilename: true shortTitle: Webhooks intro: '' @@ -13,6 +13,6 @@ versions: ghec: '*' --- -## About the {% data variables.product.prodname_github_app %} webhooks API +## Acerca de la API de webhooks de {% data variables.product.prodname_github_app %} Un webhook de {% data variables.product.prodname_github_app %} te permite recibir cargas útiles de `POST` por HTTP cada que sucedan ciertos eventos para una app. {% data reusables.webhooks.webhooks-rest-api-links %} diff --git a/translations/es-ES/content/rest/branches/branches.md b/translations/es-ES/content/rest/branches/branches.md index 622c8440a33f..073d1e4b05e0 100644 --- a/translations/es-ES/content/rest/branches/branches.md +++ b/translations/es-ES/content/rest/branches/branches.md @@ -1,6 +1,6 @@ --- title: Ramas -intro: The Branches API allows you to modify branches and their protection settings. +intro: La API de ramas te permite modificar ramas y sus ajustes de protección. versions: fpt: '*' ghes: '*' diff --git a/translations/es-ES/content/rest/code-scanning.md b/translations/es-ES/content/rest/code-scanning.md index 5894ec505cb8..8d7a3bf1f8a8 100644 --- a/translations/es-ES/content/rest/code-scanning.md +++ b/translations/es-ES/content/rest/code-scanning.md @@ -1,5 +1,5 @@ --- -title: Code Scanning +title: Escaneo de código intro: 'La API del {% data variables.product.prodname_code_scanning %} te permite recuperar y actualizar las alertas del {% data variables.product.prodname_code_scanning %} desde un repositorio.' versions: fpt: '*' @@ -17,7 +17,7 @@ redirect_from: {% data reusables.code-scanning.beta %} -## About the Code scanning API +## Acerca de la API de escaneo de código La API del {% data variables.product.prodname_code_scanning %} te permite recuperar y actualizar las alertas del {% data variables.product.prodname_code_scanning %} desde un repositorio. Puedes utilizar las terminales para crear reportes automatizados para las alertas del {% data variables.product.prodname_code_scanning %} en una organización o cargar resutlados de análisis que se hayan generado utilizando con herramientas fuera de línea del {% data variables.product.prodname_code_scanning %}. Para obtener más información, consulta la sección "[Encontrar vulnerabilidades de seguridad y errores en tu código](/github/finding-security-vulnerabilities-and-errors-in-your-code)". diff --git a/translations/es-ES/content/rest/codespaces/machines.md b/translations/es-ES/content/rest/codespaces/machines.md index d784ea44305f..8606f3b92318 100644 --- a/translations/es-ES/content/rest/codespaces/machines.md +++ b/translations/es-ES/content/rest/codespaces/machines.md @@ -1,5 +1,5 @@ --- -title: Codespaces machines +title: Máquinas de codespaces allowTitleToDifferFromFilename: true shortTitle: Máquinas intro: 'La API de máquinas de codespaces permite que un usuario determine qué tipos de máquina están disponibles para crear un codespace, ya sea en un repositorio específico o como un usuario autenticado.' @@ -11,7 +11,7 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Codespaces machines API +## Acerca de la API de máquinas de Codespaces La API de máquinas de codespaces permite que un usuario determine qué tipos de máquina están disponibles para crear un codespace, ya sea en un repositorio específico o como un usuario autenticado. Para obtener más información, consulta la sección "[Acerca de los tipos de máquina](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace#about-machine-types)". diff --git a/translations/es-ES/content/rest/collaborators/collaborators.md b/translations/es-ES/content/rest/collaborators/collaborators.md index 8d7ab7ceea44..c8081f76c0e8 100644 --- a/translations/es-ES/content/rest/collaborators/collaborators.md +++ b/translations/es-ES/content/rest/collaborators/collaborators.md @@ -1,6 +1,6 @@ --- title: Colaboradores -intro: The Collaborators API allows you manage collaborators for a repository. +intro: La API de colaboradores te permite administrar colaboradores para un repositorio. versions: fpt: '*' ghes: '*' diff --git a/translations/es-ES/content/rest/collaborators/invitations.md b/translations/es-ES/content/rest/collaborators/invitations.md index c31fc85b4bff..a2ed44ed215a 100644 --- a/translations/es-ES/content/rest/collaborators/invitations.md +++ b/translations/es-ES/content/rest/collaborators/invitations.md @@ -1,5 +1,5 @@ --- -title: Repository invitations +title: Invitaciones al repositorio allowTitleToDifferFromFilename: true shortTitle: Invitaciones intro: La API de invitaciones al repositorio te permite ver y administrar las invitaciones para colaborar en un repositorio. @@ -13,10 +13,10 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Repository invitations API +## Acerca de la API de invitaciones al repositorio La API de invitaciones al repositorio te permite ver y administrar las invitaciones para colaborar en un repositorio. Los usuarios invitados (o los servicios externos en nombre de estos) pueden elegir aceptar o rechazar la invitación. -To add a user as a collaborator, use the Collaborators API instead. Para obtener más información, consulta la sección "[Agregar un colaborador del repositorio](/rest/collaborators/collaborators#add-a-repository-collaborator)". +Para agregar a un usuario como colaborador, utiliza la API de colaboradores en su lugar. Para obtener más información, consulta la sección "[Agregar un colaborador del repositorio](/rest/collaborators/collaborators#add-a-repository-collaborator)". Toma en cuenta que el [alcance de OAuth](/developers/apps/scopes-for-oauth-apps) `repo:invite` otorga un acceso dirigido a las invitaciones **sin** otorgar también el acceso al código del repositorio, mientras que el alcance `repo` otorga permisos para el código así como para las invitaciones. diff --git a/translations/es-ES/content/rest/commits/comments.md b/translations/es-ES/content/rest/commits/comments.md index 26d7d26c8fab..ec773b1c7a03 100644 --- a/translations/es-ES/content/rest/commits/comments.md +++ b/translations/es-ES/content/rest/commits/comments.md @@ -12,7 +12,7 @@ miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true --- -## About the commit comments API +## Acerca de la API de comentarios de confirmaciones La API de comentarios de confirmaciones te permite crear y editar los comentarios que se relacionan con confirmaciones específicas. diff --git a/translations/es-ES/content/rest/dependabot/secrets.md b/translations/es-ES/content/rest/dependabot/secrets.md index ce89fb3d751a..cb324aeb93a1 100644 --- a/translations/es-ES/content/rest/dependabot/secrets.md +++ b/translations/es-ES/content/rest/dependabot/secrets.md @@ -1,7 +1,7 @@ --- -title: Dependabot secrets +title: Secretos del Dependabot shortTitle: Secretos -intro: 'With the {% data variables.product.prodname_dependabot %} secrets API, you can manage and control {% data variables.product.prodname_dependabot %} secrets for an organization or repository.' +intro: 'Con la API de secretos del {% data variables.product.prodname_dependabot %}, puedes administrar y controlar los secretos del {% data variables.product.prodname_dependabot %} de una organización o repositorio.' topics: - API versions: @@ -11,8 +11,8 @@ versions: allowTitleToDifferFromFilename: true --- -## About the {% data variables.product.prodname_dependabot %} secrets API +## Acerca de la API de secretos del {% data variables.product.prodname_dependabot %} -The {% data variables.product.prodname_dependabot %} secrets API lets you create, update, delete, and retrieve information about encrypted secrets. {% data reusables.actions.about-secrets %} Para obtener más información, consulta "[Administrar los secretos cifrados para el Dependabot](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot)". +La API de secretos del {% data variables.product.prodname_dependabot %} te permite crear, actualizar, borrar y recuperar información sobre los secretos cifrados. {% data reusables.actions.about-secrets %} Para obtener más información, consulta "[Administrar los secretos cifrados para el Dependabot](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot)". -{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `dependabot_secrets` permission to use this API. Los usuarios autenticados deben tener acceso de colaborador en el repositorio para crear, actualizar o leer los secretos. +La {% data reusables.actions.actions-authentication %} en las {% data variables.product.prodname_github_apps %} debe contar con el permiso de `dependabot_secrets` para utilizar esta API. Los usuarios autenticados deben tener acceso de colaborador en el repositorio para crear, actualizar o leer los secretos. diff --git a/translations/es-ES/content/rest/dependency-graph/dependency-review.md b/translations/es-ES/content/rest/dependency-graph/dependency-review.md index c9602dc122ec..be53ce4da129 100644 --- a/translations/es-ES/content/rest/dependency-graph/dependency-review.md +++ b/translations/es-ES/content/rest/dependency-graph/dependency-review.md @@ -1,6 +1,6 @@ --- title: Revisión de dependencias -intro: 'The Dependency review API allows you to understand dependency changes, and the security impact of these changes, before you add them to your environment.' +intro: La API de revisión de dependencias te permite entender los cambios a las dependencias y el impacto de seguridad de dichos cambios antes de que los agregues a tu ambiente. versions: fpt: '*' ghes: '>=3.6' @@ -12,8 +12,8 @@ miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true --- -## About the Dependency review API +## Acerca de la API de revisión de dependencias {% data reusables.dependency-review.dependency-review-api-beta-note %} -La API de revisión de dependencias te permite entender los cambios a las dependencias y el impacto de seguridad de estos antes de que los agregues a tu ambiente. You can view the diff of dependencies between two commits of a repository, including vulnerability data for any version updates with known vulnerabilities. Para obtener más información sobre la revisión de dependencias, consulta la sección "[Acerca de la revisión de dependencias](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)". +La API de revisión de dependencias te permite entender los cambios a las dependencias y el impacto de seguridad de estos antes de que los agregues a tu ambiente. Puedes ver el diff de las dependencias entre dos confirmaciones de un repositorio, incluyendo los datos de vulnerabilidades para cualquier actualización de versión con las vulnerabilidades conocidas. Para obtener más información sobre la revisión de dependencias, consulta la sección "[Acerca de la revisión de dependencias](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)". diff --git a/translations/es-ES/content/rest/dependency-graph/index.md b/translations/es-ES/content/rest/dependency-graph/index.md index 8def7f462441..53e715e1b8c5 100644 --- a/translations/es-ES/content/rest/dependency-graph/index.md +++ b/translations/es-ES/content/rest/dependency-graph/index.md @@ -1,6 +1,6 @@ --- title: Gráfica de dependencias -intro: 'With the Dependency Graph API, you can view dependency changes and their security impact on your repository.' +intro: 'Con la API de gráfica de dependencias, puedes ver los cambios a las dependencias y su impacto de seguridad en tu repositorio.' versions: fpt: '*' ghes: '>=3.6' diff --git a/translations/es-ES/content/rest/deployments/index.md b/translations/es-ES/content/rest/deployments/index.md index 3d0ae0be29d3..a42a60f38c7c 100644 --- a/translations/es-ES/content/rest/deployments/index.md +++ b/translations/es-ES/content/rest/deployments/index.md @@ -1,6 +1,6 @@ --- title: Implementaciones -intro: 'The deployments API allows you to create and delete deploy keys, deployments, and deployment environments.' +intro: 'La API de despliegues te permite crear y borrar llaves de despliegue, despliegues y ambientes de despliegue.' allowTitleToDifferFromFilename: true versions: fpt: '*' diff --git a/translations/es-ES/content/rest/enterprise-admin/announcement.md b/translations/es-ES/content/rest/enterprise-admin/announcement.md index 1ef49c093930..b0c0da8f8f73 100644 --- a/translations/es-ES/content/rest/enterprise-admin/announcement.md +++ b/translations/es-ES/content/rest/enterprise-admin/announcement.md @@ -1,6 +1,6 @@ --- title: Anuncio -intro: The Announcement API allows you to manage the global announcement banner in your enterprise. +intro: La API de anuncios te permite administrar el letrero de anuncios globales en tu empresa. versions: ghes: '*' ghae: '*' diff --git a/translations/es-ES/content/rest/enterprise-admin/pre-receive-environments.md b/translations/es-ES/content/rest/enterprise-admin/pre-receive-environments.md index 3adfadbdd5b9..295b22e3bddb 100644 --- a/translations/es-ES/content/rest/enterprise-admin/pre-receive-environments.md +++ b/translations/es-ES/content/rest/enterprise-admin/pre-receive-environments.md @@ -1,5 +1,5 @@ --- -title: Pre-receive Environments +title: Ambientes de pre-recepción intro: 'La API de Ambientes de Pre-recepción te permite crear, listar, actualizar y borrar ambientes para los ganchos de pre-recepción.' versions: ghes: '*' diff --git a/translations/es-ES/content/rest/enterprise-admin/pre-receive-hooks.md b/translations/es-ES/content/rest/enterprise-admin/pre-receive-hooks.md index 32ec6d3ef6b8..644022b2bbc7 100644 --- a/translations/es-ES/content/rest/enterprise-admin/pre-receive-hooks.md +++ b/translations/es-ES/content/rest/enterprise-admin/pre-receive-hooks.md @@ -1,5 +1,5 @@ --- -title: Pre-receive Hooks +title: Ganchos de pre-recepción intro: 'La API de Ganchos Pre-recepción te permite crear, listar, actualizar y borrar los ganchos de pre-recepción.' versions: ghes: '*' diff --git a/translations/es-ES/content/rest/gists/gists.md b/translations/es-ES/content/rest/gists/gists.md index 37dd44d71503..aab584797f93 100644 --- a/translations/es-ES/content/rest/gists/gists.md +++ b/translations/es-ES/content/rest/gists/gists.md @@ -1,6 +1,6 @@ --- title: Gists -intro: 'The Gists API enables the authorized user to list, create, update and delete the public gists on GitHub.' +intro: 'La API de Gists habilita al usuario habilitado para listar, crear, actualizar y borrar los gists públicos en GitHub.' versions: fpt: '*' ghes: '*' @@ -11,9 +11,9 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Gists API +## Acerca de la API de Gists -The Gist API lets you view and modify gists. For more information about gists, see "[Editing and sharing content with gists](/get-started/writing-on-github/editing-and-sharing-content-with-gists)." +La API de Gists te permite ver y modificar los gists. Para obtener más información sobre los gists, consulta la sección "[Editar y compartir el contenido con los gists](/get-started/writing-on-github/editing-and-sharing-content-with-gists)". ### Autenticación diff --git a/translations/es-ES/content/rest/git/blobs.md b/translations/es-ES/content/rest/git/blobs.md index d71ecb60fa5c..66777ae4f4ad 100644 --- a/translations/es-ES/content/rest/git/blobs.md +++ b/translations/es-ES/content/rest/git/blobs.md @@ -1,8 +1,8 @@ --- -title: Git blobs +title: Blobs de Git shortTitle: Blobs allowTitleToDifferFromFilename: true -intro: 'The Git blob API lets you create and get a Git blob (binary large object), the object type used to store the contents of each file in a repository.' +intro: 'La API de blobs de Git te permite crear y obtener un blob de Git (BLOB: Objeto binario grande, por sus siglas en inglés), el cual es el tipo de objeto que se utiliza para almacenar el contenido de cada archivo en un repositorio.' versions: fpt: '*' ghes: '*' @@ -13,7 +13,7 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Git blob API +## Acerca de la API de blobs de Git Un blob (objeto binario grande, por sus siglas en inglés) de Git es el tipo de objeto que se utiliza para almacenar el contenido de cada archivo en un repositorio. El hash SHA-1 del archivo se calcula y almacena en el objeto del blob. Estas terminales te permiten leer y escribir [objetos de blob](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects) en tu base de datos de Git en {% data variables.product.product_name %}. Los blobs aprovechan [estos tipos de medios personalizados](#custom-media-types-for-blobs). Puedes leer más acerca del uso de tipos de medios en la API [aquí](/rest/overview/media-types). diff --git a/translations/es-ES/content/rest/git/tags.md b/translations/es-ES/content/rest/git/tags.md index 23b43248c775..ed8159a146a0 100644 --- a/translations/es-ES/content/rest/git/tags.md +++ b/translations/es-ES/content/rest/git/tags.md @@ -1,5 +1,5 @@ --- -title: Git tags +title: Etiquetas de Git shortTitle: Etiquetas allowTitleToDifferFromFilename: true intro: 'The Git tags API lets you read and write tag objects to your Git database on {% data variables.product.product_name %}.' diff --git a/translations/es-ES/content/rest/guides/getting-started-with-the-checks-api.md b/translations/es-ES/content/rest/guides/getting-started-with-the-checks-api.md index ae540963c204..cd65214c858a 100644 --- a/translations/es-ES/content/rest/guides/getting-started-with-the-checks-api.md +++ b/translations/es-ES/content/rest/guides/getting-started-with-the-checks-api.md @@ -41,7 +41,7 @@ Una ejecución de verificación es una prueba individual que forma parte de una ![Flujo de trabajo de las ejecuciones de verificación](/assets/images/check_runs.png) -Si una ejecución de verificación permanece en un estado incompleto por más de 14 días, entonces la `conclusion` de ésta se convierte en `stale` y aparece en {% data variables.product.prodname_dotcom %} como quedada con el {% octicon "issue-reopened" aria-label="The issue-reopened icon" %}. Solo {% data variables.product.prodname_dotcom %} puede marcar las ejecuciones de verificación como `stale`. Para obtener más información acerca de las conclusiones posibles para una ejecución de verificación, consulta el [parámetro de `conclusion`](/rest/reference/checks#create-a-check-run--parameters). +Si una ejecución de verificación permanece en un estado incompleto por más de 14 días, entonces la `conclusion` de ésta se convierte en `stale` y aparece en {% data variables.product.prodname_dotcom %} como desactualizada con el {% octicon "issue-reopened" aria-label="The issue-reopened icon" %}. Solo {% data variables.product.prodname_dotcom %} puede marcar las ejecuciones de verificación como `stale`. Para obtener más información acerca de las conclusiones posibles para una ejecución de verificación, consulta el [parámetro de `conclusion`](/rest/reference/checks#create-a-check-run--parameters). Puedes crear la ejecución de verificación tan pronto como recibas el webhook de [`check_suite`](/webhooks/event-payloads/#check_suite), aún si ésta todavía no se completa. Puedes actualizar el `status` de la ejecución de verificación ya que se completa con los valores `queued`, `in_progress`, o `completed`, y puedes actualizar la `output` conforme vayan estando disponibles los detalles adicionales. Una ejecución de verificación puede contener estampas de tiempo, un enlace para encontrar más detalles en tu sitio externo, anotaciones detalladas para líneas de código específcas, e información acerca del análisis que se llevó a cabo. diff --git a/translations/es-ES/content/rest/guides/getting-started-with-the-rest-api.md b/translations/es-ES/content/rest/guides/getting-started-with-the-rest-api.md index 13bfbea29fb1..1a65d14e322a 100644 --- a/translations/es-ES/content/rest/guides/getting-started-with-the-rest-api.md +++ b/translations/es-ES/content/rest/guides/getting-started-with-the-rest-api.md @@ -32,7 +32,7 @@ Para hacer una solicitud, primero encuentra el método HTTP y la ruta para la op {% endnote %} -Si aún no estás autenticado en el {% data variables.product.prodname_cli %}, debes utilizar el subcomando `gh auth login` para autenticarte antes de hacer hacer cualquier tipo de solicitud. For more information, see "[Authenticating](#authenticating)." +Si aún no estás autenticado en el {% data variables.product.prodname_cli %}, debes utilizar el subcomando `gh auth login` para autenticarte antes de hacer hacer cualquier tipo de solicitud. Para obtener más información, consulta la sección "[Autenticarse](#authenticating)". Para hacer una solicitud utilizando el {% data variables.product.prodname_cli %}, utiliza el subcomando `api` junto con la ruta. Utiliza el marcador `--method` o `-X` para especificar el método. @@ -166,7 +166,7 @@ curl --request GET \ {% note %} -**Nota:** En la mayoría de los casos, puedes utilizar `Authorization: Bearer` o `Authorization: token`. Los tokens web JSON (JWT) solo funcionarán con `Authorization: Bearer`. +**Nota:** {% data reusables.getting-started.bearer-vs-token %} {% endnote %} diff --git a/translations/es-ES/content/rest/interactions/orgs.md b/translations/es-ES/content/rest/interactions/orgs.md index 321fce5ec0b0..04d052cdc3fb 100644 --- a/translations/es-ES/content/rest/interactions/orgs.md +++ b/translations/es-ES/content/rest/interactions/orgs.md @@ -1,5 +1,5 @@ --- -title: Organization interactions +title: Interacciones de organización shortTitle: Organización intro: 'La API de interacciones de organización permite que los propietarios de la organización restrinjan temporalmente qué tipo de usuarios pueden comentar, abrir propuestas o crear solicitudes de cambios en los repositorios públicos de dicha organización.' versions: @@ -11,7 +11,7 @@ miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true --- -## About the Organization interactions API +## Acerca de la API de interacciones de organización La API de interacciones de organización permite que los propietarios de la organización restrinjan temporalmente qué tipo de usuarios pueden comentar, abrir propuestas o crear solicitudes de cambios en los repositorios públicos de dicha organización. {% data reusables.interactions.interactions-detail %} Aquí puedes aprender más sobre los tipos de usuario de {% data variables.product.product_name %}: diff --git a/translations/es-ES/content/rest/interactions/repos.md b/translations/es-ES/content/rest/interactions/repos.md index 9224e9c10971..1c5c3d82a444 100644 --- a/translations/es-ES/content/rest/interactions/repos.md +++ b/translations/es-ES/content/rest/interactions/repos.md @@ -1,5 +1,5 @@ --- -title: Repository interactions +title: Interacciones de repositorio shortTitle: Repositorio intro: 'La API de interacciones de repositorio permite a las personas con acceso administrativo o de propietario restringir temporalmente qué tipo de usuario puede comentar, abrir propuestas o crear solicitudes de cambios en un repositorio privado.' versions: @@ -11,7 +11,7 @@ miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true --- -## About the Repository interactions API +## Acerca de la API de interacciones de repositorio La API de interacciones de repositorio permite a las personas con acceso administrativo o de propietario restringir temporalmente qué tipo de usuario puede comentar, abrir propuestas o crear solicitudes de cambios en un repositorio privado. {% data reusables.interactions.interactions-detail %} Aquí puedes aprender más sobre los tipos de usuario de {% data variables.product.product_name %}: diff --git a/translations/es-ES/content/rest/issues/labels.md b/translations/es-ES/content/rest/issues/labels.md index 9e6dfc84ce41..c8a6a2e513a4 100644 --- a/translations/es-ES/content/rest/issues/labels.md +++ b/translations/es-ES/content/rest/issues/labels.md @@ -11,6 +11,6 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Labels API +## Acerca de la API de etiquetas -The Labels API supports managing labels for a repository and adding or removing labels to issues and pull requests. {% data reusables.pull_requests.issues-pr-shared-api %} +La API de etiquetas es compatible con administrar etiquetas para un repositorio y agregar o eliminar etiquetas para las propuestas y solicitudes de cambio. {% data reusables.pull_requests.issues-pr-shared-api %} diff --git a/translations/es-ES/content/rest/metrics/community.md b/translations/es-ES/content/rest/metrics/community.md index e6e3f7d92f86..2064af0ae271 100644 --- a/translations/es-ES/content/rest/metrics/community.md +++ b/translations/es-ES/content/rest/metrics/community.md @@ -1,8 +1,8 @@ --- -title: Community metrics +title: Métricas comunitarias shortTitle: Comunidad allowTitleToDifferFromFilename: true -intro: The Community metrics API lets you get data about your community profile. +intro: La API de métricas comunitarias te permite obtener datos sobre el perfil de tu comunidad. versions: fpt: '*' ghec: '*' diff --git a/translations/es-ES/content/rest/metrics/traffic.md b/translations/es-ES/content/rest/metrics/traffic.md index 05d5337041e4..f10105c24cf6 100644 --- a/translations/es-ES/content/rest/metrics/traffic.md +++ b/translations/es-ES/content/rest/metrics/traffic.md @@ -1,8 +1,8 @@ --- -title: Repository traffic +title: Tráfico de repositorio shortTitle: Tráfico allowTitleToDifferFromFilename: true -intro: The Repository traffic API provides access to the information provided in your repository graph. +intro: La API de tráfico de repositorio proporciona acceso a la información proporcionada en tu gráfica de repositorio. versions: fpt: '*' ghec: '*' @@ -11,6 +11,6 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Repository traffic API +## Acerca de la API de tráfico de repositorio -For repositories that you have push access to, the Repository traffic API provides access to the information provided in your repository graph. Para obtener más información, consulta la sección "[Ver el tráfico hacia un repositorio](/repositories/viewing-activity-and-data-for-your-repository/viewing-traffic-to-a-repository)". +Para los repositorios a los cuales tienes acceso de subida, la API de tráfico de repositorio proporciona acceso a la información que se proporciona en tu gráfica de repositorio. Para obtener más información, consulta la sección "[Ver el tráfico hacia un repositorio](/repositories/viewing-activity-and-data-for-your-repository/viewing-traffic-to-a-repository)". diff --git a/translations/es-ES/content/rest/migrations/orgs.md b/translations/es-ES/content/rest/migrations/orgs.md index fd9856ea4b6f..0eb7f48e9e18 100644 --- a/translations/es-ES/content/rest/migrations/orgs.md +++ b/translations/es-ES/content/rest/migrations/orgs.md @@ -1,5 +1,5 @@ --- -title: Organization migrations +title: Migraciones de organización allowTitleToDifferFromFilename: true shortTitle: Organizaciones intro: '' @@ -13,7 +13,7 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Organization migrations API +## Acerca de la API de migraciones de organización La API de Migraciones solo está disponible para los propietarios autenticados de la organización. Para obtener más información, consulta las secciones "[Roles en una organización](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#permission-levels-for-an-organization)" y "[Otros métodos de autenticación](/rest/overview/other-authentication-methods)". diff --git a/translations/es-ES/content/rest/oauth-authorizations.md b/translations/es-ES/content/rest/oauth-authorizations.md index 3c22e5dd082e..ef94233ad5f7 100644 --- a/translations/es-ES/content/rest/oauth-authorizations.md +++ b/translations/es-ES/content/rest/oauth-authorizations.md @@ -1,6 +1,6 @@ --- -title: OAuth authorizations -intro: The OAuth authorizations lets you manage the access OAuth applications have to your account. +title: Autorizaciones de OAuth +intro: Las autorizaciones de OAuth te permiten administrar el acceso que las aplicaciones de OAuth tienen en tu cuenta. versions: ghes: '*' topics: @@ -10,7 +10,7 @@ redirect_from: - /rest/reference/oauth-authorizations --- -## About the OAuth authorizations API +## Acerca de la API de autorizaciones OAuth Puedes utilizar esta API para administrar el acceso que las aplicaciones de OAuth tienen en tu cuenta. Solo puedes acceder a esta API a través de la [Autenticación Básica](/rest/overview/other-authentication-methods#basic-authentication) utilizando tu nombre de usuario y contraseña, y no los tokens. diff --git a/translations/es-ES/content/rest/orgs/custom-roles.md b/translations/es-ES/content/rest/orgs/custom-roles.md index 748da0f6cc33..ae1e5dd230b1 100644 --- a/translations/es-ES/content/rest/orgs/custom-roles.md +++ b/translations/es-ES/content/rest/orgs/custom-roles.md @@ -1,5 +1,5 @@ --- -title: Custom Repository Roles +title: Roles de repositorio personalizados intro: '' versions: fpt: '*' diff --git a/translations/es-ES/content/rest/orgs/outside-collaborators.md b/translations/es-ES/content/rest/orgs/outside-collaborators.md index 42c4707e7200..f6ffa6c21fd5 100644 --- a/translations/es-ES/content/rest/orgs/outside-collaborators.md +++ b/translations/es-ES/content/rest/orgs/outside-collaborators.md @@ -1,5 +1,5 @@ --- -title: Outside Collaborators +title: Colaboradores externos intro: '' versions: fpt: '*' diff --git a/translations/es-ES/content/rest/overview/other-authentication-methods.md b/translations/es-ES/content/rest/overview/other-authentication-methods.md index b75ab9852500..d8147fdb5d4f 100644 --- a/translations/es-ES/content/rest/overview/other-authentication-methods.md +++ b/translations/es-ES/content/rest/overview/other-authentication-methods.md @@ -86,10 +86,16 @@ If you have two-factor authentication enabled, make sure you understand how to [ {% endnote %} +{% note %} + +**Note:** {% data reusables.getting-started.bearer-vs-token %} + +{% endnote %} + If you're using the API to access an organization that enforces [SAML SSO][saml-sso] for authentication, you'll need to create a personal access token (PAT) and [authorize the token][allowlist] for that organization. Visit the URL specified in `X-GitHub-SSO` to authorize the token for the organization. ```shell -$ curl -v -H "Authorization: token TOKEN" {% data variables.product.api_url_pre %}/repos/octodocs-test/test +$ curl -v -H "Authorization: Bearer TOKEN" {% data variables.product.api_url_pre %}/repos/octodocs-test/test > X-GitHub-SSO: required; url=https://github.com/orgs/octodocs-test/sso?authorization_request=AZSCKtL4U8yX1H3sCQIVnVgmjmon5fWxks5YrqhJgah0b2tlbl9pZM4EuMz4 { @@ -101,7 +107,7 @@ $ curl -v -H "Authorization: token TOKEN" {% data variables.product.api When requesting data that could come from multiple organizations (for example, [requesting a list of issues created by the user][user-issues]), the `X-GitHub-SSO` header indicates which organizations require you to authorize your personal access token: ```shell -$ curl -v -H "Authorization: token TOKEN" {% data variables.product.api_url_pre %}/user/issues +$ curl -v -H "Authorization: Bearer TOKEN" {% data variables.product.api_url_pre %}/user/issues > X-GitHub-SSO: partial-results; organizations=21955855,20582480 ``` diff --git a/translations/es-ES/content/rest/overview/resources-in-the-rest-api.md b/translations/es-ES/content/rest/overview/resources-in-the-rest-api.md index 6bf30239c169..7dd81b93322d 100644 --- a/translations/es-ES/content/rest/overview/resources-in-the-rest-api.md +++ b/translations/es-ES/content/rest/overview/resources-in-the-rest-api.md @@ -79,7 +79,7 @@ $ curl -u "username" {% data variables.product.api_url_pre %} ### Token de OAuth (enviado en un encabezado) ```shell -$ curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre %} +$ curl -H "Authorization: Bearer OAUTH-TOKEN" {% data variables.product.api_url_pre %} ``` {% note %} @@ -88,6 +88,12 @@ Nota: GitHub recomienda enviar los tokens de OAuth utilizando el encabezado de a {% endnote %} +{% note %} + +**Nota:** {% data reusables.getting-started.bearer-vs-token %} + +{% endnote %} + Lee [más acerca de OAuth2](/apps/building-oauth-apps/). Nota que los tokens de OAuth2 pueden adquirirse utilizando el [flujo de aplicaciones web](/developers/apps/authorizing-oauth-apps#web-application-flow) para las aplicaciones productivas. {% ifversion fpt or ghes or ghec %} diff --git a/translations/es-ES/content/rest/overview/troubleshooting.md b/translations/es-ES/content/rest/overview/troubleshooting.md index 7562d15e460f..a401fbd9681c 100644 --- a/translations/es-ES/content/rest/overview/troubleshooting.md +++ b/translations/es-ES/content/rest/overview/troubleshooting.md @@ -44,13 +44,13 @@ curl -u my_user:my_password https://api.github.com/user/repos En vez de esto, utiliza un [token de acceso personal](/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) cuando pruebes las terminales o cuando realices desarrollos locales: ```bash -curl -H 'Authorization: token my_access_token' https://api.github.com/user/repos +curl -H 'Authorization: Bearer my_access_token' https://api.github.com/user/repos ``` Para las Apps de Oauth, debes utilizar el [flujo de aplicaciones web](/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) para generar un token de OAuth para utilizar el encabezado de la llamada a la API: ```bash -curl -H 'Authorization: token my-oauth-token' https://api.github.com/user/repos +curl -H 'Authorization: Bearer my-oauth-token' https://api.github.com/user/repos ``` ## Exceder el tiempo de espera diff --git a/translations/es-ES/content/rest/projects/columns.md b/translations/es-ES/content/rest/projects/columns.md index d3049358c30a..50da2d5df507 100644 --- a/translations/es-ES/content/rest/projects/columns.md +++ b/translations/es-ES/content/rest/projects/columns.md @@ -1,8 +1,8 @@ --- -title: '{% data variables.product.prodname_project_v1_caps %} columns' +title: 'Columnas de {% data variables.product.prodname_project_v1_caps %}' shortTitle: Columnas allowTitleToDifferFromFilename: true -intro: 'The {% data variables.product.prodname_project_v1 %} columns API lets you create and manage columns on a {% data variables.projects.projects_v1_board %}.' +intro: 'La API de columnas de {% data variables.product.prodname_project_v1 %} te permite crear y administrar columnas en un {% data variables.projects.projects_v1_board %}.' versions: fpt: '*' ghes: '*' diff --git a/translations/es-ES/content/rest/projects/projects.md b/translations/es-ES/content/rest/projects/projects.md index 79c2aaa6b174..69c8cbf99fcb 100644 --- a/translations/es-ES/content/rest/projects/projects.md +++ b/translations/es-ES/content/rest/projects/projects.md @@ -1,8 +1,8 @@ --- title: '{% data variables.product.prodname_projects_v1_caps %}' -shortTitle: Boards +shortTitle: Tableros allowTitleToDifferFromFilename: true -intro: 'The {% data variables.product.prodname_projects_v1 %} API lets you create and manage {% data variables.projects.projects_v1_boards %} in a repository.' +intro: 'La API de {% data variables.product.prodname_projects_v1 %} te permite crear y fusionar {% data variables.projects.projects_v1_boards %} en un repositorio.' versions: fpt: '*' ghes: '*' diff --git a/translations/es-ES/content/rest/pulls/reviews.md b/translations/es-ES/content/rest/pulls/reviews.md index fe739aefdc87..77aade526c12 100644 --- a/translations/es-ES/content/rest/pulls/reviews.md +++ b/translations/es-ES/content/rest/pulls/reviews.md @@ -13,6 +13,6 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Pull request reviews API +## Acerca de la API de revisiones de solicitudes de cambio -Pull Request Reviews are groups of pull request review comments on a pull request, grouped together with a state and optional body comment. +Las revisiones de solicitudes de cambio son grupos de comentarios en dichas revisiones que se agrupan con un estado y comentario de cuerpo opcional. diff --git a/translations/es-ES/content/rest/quickstart.md b/translations/es-ES/content/rest/quickstart.md index 7649232acc6e..498bf4499eab 100644 --- a/translations/es-ES/content/rest/quickstart.md +++ b/translations/es-ES/content/rest/quickstart.md @@ -103,15 +103,15 @@ Puedes utilizar Octokit.js para interactuar con la API de REST de {% data variab {% warning %} - **Warning**: Treat your access token like a password. + **Advertencia**: Trata a tu token de acceso como si fuera una contraseña. - To keep your token secure, you can store your token as a secret and run your script through {% data variables.product.prodname_actions %}. For more information, see the "[Using Octokit.js in {% data variables.product.prodname_actions %}](#using-octokitjs-in-github-actions)" section. + Para mantener seguro a tu token, puedes almacenarlo como un secreto y ejecutar tu script mediante {% data variables.product.prodname_actions %}. For more information, see the "[Using Octokit.js in {% data variables.product.prodname_actions %}](#using-octokitjs-in-github-actions)" section. {%- ifversion fpt or ghec %} - You can also store your token as a {% data variables.product.prodname_codespaces %} secret and run your script in {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} + You can also store your token as a {% data variables.product.prodname_codespaces %} secret and run your script in {% data variables.product.prodname_codespaces %}. Para obtener más información, consulta la sección "[Administrar los secretos cifrados para tus codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)".{% endif %} - If these options are not possible, consider using another service such as [the 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) to store your token securely. + Si estas opciones no son posibles, considera utilizar otro servicio tal como [el 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) para almacenar tu token de forma segura. {% endwarning %} @@ -136,18 +136,18 @@ Puedes utilizar Octokit.js para interactuar con la API de REST de {% data variab ### Using Octokit.js in {% data variables.product.prodname_actions %} -You can also execute your JavaScript scripts in your {% data variables.product.prodname_actions %} workflows. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." +You can also execute your JavaScript scripts in your {% data variables.product.prodname_actions %} workflows. Para obtener más información, consultala sección "[Sintaxis de flujo de trabajo para GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)". {% data variables.product.prodname_dotcom %} recomienda que utilices el `GITHUB_TOKEN` integrado en vez de crear un token. Si esto es imposible, almacena tu token como un secreto y reemplaza a `GITHUB_TOKEN` por el nombre de tu secreto en el siguiente ejemplo. Para obtener más información sobre el `GITHUB_TOKEN`, consulta ""[Automatic token authentication](/actions/security-guides/automatic-token-authentication)". Para obtener más información sobre los secretos, consulta la sección "[Secretos cifrados](/actions/security-guides/encrypted-secrets)". -The following example workflow: +El siguiente flujo de trabajo de ejemplo: -1. Checks out the repository content -1. Sets up Node.js -1. Installs `octokit` -1. Stores the value of `GITHUB_TOKEN` as an environment variable called `TOKEN` and runs `.github/actions-scripts/use-the-api.mjs`, which can access that environment variable as `process.env.TOKEN` +1. Verifica el contenido del repositorio +1. Configura a Node.js +1. Instala `octokit` +1. Almacena el valor de `GITHUB_TOKEN` como una variable de ambiente llamada `TOKEN` y ejecuta `.github/actions-scripts/use-the-api.mjs`, que puede acceder a esa variable de ambiente como `process.env.TOKEN` -Example workflow: +Flujo de trabajo de ejemplo: ```yaml on: @@ -177,7 +177,7 @@ jobs: TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} ``` -Example JavaScript script, with the file path `.github/actions-scripts/use-the-api.mjs`: +Script de JavaScript de ejemplo con la ruta de archivo `.github/actions-scripts/use-the-api.mjs`: ```javascript import { Octokit } from "octokit" @@ -256,20 +256,20 @@ jobs: {% endnote %} -1. Install cURL if cURL isn't already installed on your machine. To check if cURL is installed, execute `curl --version` in the command line. If the output is information about the cURL version, cURL is installed. If you get a message similar to `command not found: curl`, you need to download and install cURL. For more information, see [the cURL project download page](https://curl.se/download.html). +1. Install cURL if cURL isn't already installed on your machine. To check if cURL is installed, execute `curl --version` in the command line. If the output is information about the cURL version, cURL is installed. If you get a message similar to `command not found: curl`, you need to download and install cURL. Para obtener más información, consulta [la página de descarga del proyecto cURL](https://curl.se/download.html). 1. Crear un token de acceso. Por ejemplo, crea un token de acceso personal (PAT) o un token de acceso de usuario a servidor de {% data variables.product.prodname_github_app %}. For more information, see "[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)" or "[Identifying and authorizing users for GitHub Apps](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps)." {% warning %} - **Warning**: Treat your access token like a password. + **Advertencia**: Trata a tu token de acceso como si fuera una contraseña. {%- ifversion fpt or ghec %} - To keep your token secure, you can store your token as a {% data variables.product.prodname_codespaces %} secret and use the command line through {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} + To keep your token secure, you can store your token as a {% data variables.product.prodname_codespaces %} secret and use the command line through {% data variables.product.prodname_codespaces %}. Para obtener más información, consulta la sección "[Administrar los secretos cifrados para tus codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)".{% endif %} - You can also use {% data variables.product.prodname_cli %} instead of cURL. {% data variables.product.prodname_cli %} will take care of authentication for you. For more information, see the {% data variables.product.prodname_cli %} version of this page. + You can also use {% data variables.product.prodname_cli %} instead of cURL. El {% data variables.product.prodname_cli %} se encargará de la autenticación por ti. Para obtener más información, consulta la versión del {% data variables.product.prodname_cli %} de esta página. - If these options are not possible, consider using another service such as [the 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) to store your token securely. + Si estas opciones no son posibles, considera utilizar otro servicio tal como [el 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) para almacenar tu token de forma segura. {% endwarning %} @@ -284,7 +284,7 @@ jobs: {% note %} - **Note:** In most cases, you can use `Authorization: Bearer` or `Authorization: token`. JSON web tokens (JWTs) only work with `Authorization: Bearer`. + **Nota:** {% data reusables.getting-started.bearer-vs-token %} {% endnote %} diff --git a/translations/es-ES/content/rest/rate-limit.md b/translations/es-ES/content/rest/rate-limit.md index b779a8e124cd..f6f2f8bad166 100644 --- a/translations/es-ES/content/rest/rate-limit.md +++ b/translations/es-ES/content/rest/rate-limit.md @@ -1,6 +1,6 @@ --- title: Limite de tasa -intro: 'With the Rate limit API, you can check the current rate limit status of various REST APIs.' +intro: 'Con la API de límites de tasa, puedes verificar el estado de límite de tasa actual de varias API de REST.' versions: fpt: '*' ghes: '*' @@ -13,7 +13,7 @@ redirect_from: - /rest/reference/rate-limit --- -## About the Rate limit API +## Acerca de la API de límites de tasa La documentación general de la API de REST describe las [reglas de los límites de tasa](/rest/overview/resources-in-the-rest-api#rate-limiting). Puedes revisar tu estado actual de límite de tasa en cualquier momento utilizando la API de Límites de Tasa que se describe a continuación. diff --git a/translations/es-ES/content/rest/releases/releases.md b/translations/es-ES/content/rest/releases/releases.md index 09a0da8dd3dc..c0b0e14cced4 100644 --- a/translations/es-ES/content/rest/releases/releases.md +++ b/translations/es-ES/content/rest/releases/releases.md @@ -1,6 +1,6 @@ --- title: Lanzamientos -intro: 'The Releases API allows you to create, modify, and delete releases and release assets.' +intro: 'La API de lanzamientos te permite crear, modificar y borrar los lanzamientos y activos de lanzamiento.' versions: fpt: '*' ghes: '*' diff --git a/translations/es-ES/content/rest/teams/discussion-comments.md b/translations/es-ES/content/rest/teams/discussion-comments.md index 728a28d1f0bf..10a4ce9b6723 100644 --- a/translations/es-ES/content/rest/teams/discussion-comments.md +++ b/translations/es-ES/content/rest/teams/discussion-comments.md @@ -1,8 +1,8 @@ --- -title: Team discussion comments +title: Comentarios de debates de equipo allowTitleToDifferFromFilename: true shortTitle: Comentarios de debate -intro: 'The team discussion comments API allows you to get, create, edit, and delete discussion comments on a [team discussion](/rest/reference/teams#discussions) post.' +intro: 'La API de comentarios de debate de equipo te permite obtener, crear, editar y borrar comentarios de debates en una publicación de un [debate de equipo](/rest/reference/teams#discussions).' versions: fpt: '*' ghes: '*' @@ -13,7 +13,7 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Team discussion comments API +## Acerca de la API de comentarios de debates de equipo Cualquier miembro de la [organización](/rest/reference/orgs) del equipo puede crear y leer los comentarios de un debate público. Para obtener más detalles, consulta la sección "[Acerca de los debates de equipo](/organizations/collaborating-with-your-team/about-team-discussions/)". diff --git a/translations/es-ES/content/rest/teams/external-groups.md b/translations/es-ES/content/rest/teams/external-groups.md index a93b9ddc0b08..023babf84bed 100644 --- a/translations/es-ES/content/rest/teams/external-groups.md +++ b/translations/es-ES/content/rest/teams/external-groups.md @@ -19,7 +19,7 @@ Para utilizar esta API, el usuario autenticado debe ser un mantenedor del equipo **Notas:** -- La API de grupos externos solo se encuentra disponible para aquellas organizaciones que sean parte de una empresa que utilice {% data variables.product.prodname_emus %}. Para obtener más información, consulta la sección "[Acerca de los Usuarios Empresariales Administrados](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)". +- The external groups API is only available for organizations that are part of an enterprise using {% data variables.product.prodname_emus %}. Para obtener más información, consulta la sección "[Acerca de los Usuarios Empresariales Administrados](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)". - Si tu organización utiliza la sincronización de equipos, puedes usar la API de Sincronización de Equipos. Para obtener más información, consulta la "[API de sincronización de equipos](#team-synchronization)". {% endnote %} diff --git a/translations/es-ES/content/rest/teams/team-sync.md b/translations/es-ES/content/rest/teams/team-sync.md index 0e69b0283c72..890e8bfc5628 100644 --- a/translations/es-ES/content/rest/teams/team-sync.md +++ b/translations/es-ES/content/rest/teams/team-sync.md @@ -1,6 +1,6 @@ --- title: Sincronización de equipos -intro: 'The Team synchronization API allows you to manage connections between {% data variables.product.product_name %} teams and external identity provider (IdP) groups.' +intro: 'La API de sincronización de equipos te permite administrar las conexiones entre los equipos de {% data variables.product.product_name %} y los grupos de proveedores de identidad (IdP) externos.' versions: fpt: '*' ghec: '*' @@ -10,7 +10,7 @@ miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true --- -## About the Team synchronization API +## Acerca de la API de sincronización Para utilizar esta API, el usuario autenticado debe ser un mantenedor del equipo o un propietario de la organización asociada con éste. El token que utilizas para autenticarte también necesitará autorizarse para su uso con tu proveedor IdP (SSO). Para obtener más información, consulta la sección "[Autorizar un token de acceso personal para su uso con una organización que tiene inicio de sesión único de SAML](/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)". diff --git a/translations/es-ES/content/rest/teams/teams.md b/translations/es-ES/content/rest/teams/teams.md index e86f3a7da3c2..0336191421be 100644 --- a/translations/es-ES/content/rest/teams/teams.md +++ b/translations/es-ES/content/rest/teams/teams.md @@ -1,6 +1,6 @@ --- title: Equipos -intro: 'With the Teams API, you can create and manage teams in your GitHub organization.' +intro: 'Con la API de equipos, puedes crear y administrar equipos en tu organización de GitHub.' versions: fpt: '*' ghes: '*' @@ -11,6 +11,6 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Teams API +## Acerca de la API de equipos {% data reusables.organizations.team-api %} diff --git a/translations/es-ES/content/rest/users/index.md b/translations/es-ES/content/rest/users/index.md index 0b7ddad6f2fc..ea53a69bded4 100644 --- a/translations/es-ES/content/rest/users/index.md +++ b/translations/es-ES/content/rest/users/index.md @@ -19,5 +19,6 @@ children: - /followers - /gpg-keys - /keys + - /ssh-signing-keys --- diff --git a/translations/es-ES/content/rest/users/keys.md b/translations/es-ES/content/rest/users/keys.md index 45b91e594751..8c46a7889fb2 100644 --- a/translations/es-ES/content/rest/users/keys.md +++ b/translations/es-ES/content/rest/users/keys.md @@ -1,5 +1,5 @@ --- -title: Git SSH Keys +title: Llaves SSH de Git intro: '' versions: fpt: '*' @@ -12,6 +12,6 @@ miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true --- -## About the User Git SSH keys API +## Acerca de la API de llaves SSH de usuario de Git {% data reusables.user-settings.user-api %} diff --git a/translations/es-ES/content/rest/users/ssh-signing-keys.md b/translations/es-ES/content/rest/users/ssh-signing-keys.md new file mode 100644 index 000000000000..33f57a42788a --- /dev/null +++ b/translations/es-ES/content/rest/users/ssh-signing-keys.md @@ -0,0 +1,13 @@ +--- +title: SSH signing keys +intro: '' +versions: + fpt: '*' + ghes: '>=3.7' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + diff --git a/translations/es-ES/content/rest/webhooks/repos.md b/translations/es-ES/content/rest/webhooks/repos.md index 55bc892fc3e0..c53356342f26 100644 --- a/translations/es-ES/content/rest/webhooks/repos.md +++ b/translations/es-ES/content/rest/webhooks/repos.md @@ -1,5 +1,5 @@ --- -title: Repository Webhooks +title: Webhooks de repositorio intro: '' versions: fpt: '*' diff --git a/translations/es-ES/content/site-policy/github-terms/github-community-code-of-conduct.md b/translations/es-ES/content/site-policy/github-terms/github-community-code-of-conduct.md index 75c2b26d17d6..ffdf5505f030 100644 --- a/translations/es-ES/content/site-policy/github-terms/github-community-code-of-conduct.md +++ b/translations/es-ES/content/site-policy/github-terms/github-community-code-of-conduct.md @@ -16,7 +16,7 @@ topics: Millones de desarrolladores en todo el mundo hospedan millones de proyectos, tanto de código propietario como de código libre, en GitHub. Somo afortunados de poder tomar parte en habilitar la colaboración a lo largo de la comunidad de desarrolladores cada día, lo cual es una responsabilidad que no nos tomamos a la ligera. Juntos, tenemos la emocionante oportunidad de hacer de esta una comunidad de la cual podamos estar orgullosos. -GitHub Community, powered by GitHub Discussions, is intended to be a place for further collaboration, support, and brainstorming. Este es un lugar civilizado para conectarse con otros usuarios, aprender nuevas habilidades, compartir comentarios e ideas y encontrar todo el apoyo que necesitas para tus proyectos de GitHub. By participating in GitHub Community, you are agreeing to the same [Terms of Service](/github/site-policy/github-terms-of-service/) and [GitHub Acceptable Use Policies](/github/site-policy/github-acceptable-use-policies) that apply to GitHub.com, as well as this GitHub Community-specific Code of Conduct. +GitHub Community, powered by GitHub Discussions, is intended to be a place for further collaboration, support, and brainstorming. Este es un lugar civilizado para conectarse con otros usuarios, aprender nuevas habilidades, compartir comentarios e ideas y encontrar todo el apoyo que necesitas para tus proyectos de GitHub. Si participas en la Comunidad de GitHub, estás de acuerdo con los mismos [Términos de servicio](/github/site-policy/github-terms-of-service/) y [Políticas de uso aceptable de GitHub](/github/site-policy/github-acceptable-use-policies) que aplican a GitHub.com, así como este Código de Conducta específico de la Comunidad de GitHub. With this Code of Conduct, we hope to help you understand how best to collaborate in GitHub Community, what you can expect from moderators, and what type of actions or content may result in temporary or permanent suspension from community participation. We will investigate any abuse reports and may moderate public content within GitHub Community that we determine to be in violation of either the GitHub Terms of Service or this Code of Conduct. diff --git a/translations/es-ES/content/site-policy/privacy-policies/github-privacy-statement.md b/translations/es-ES/content/site-policy/privacy-policies/github-privacy-statement.md index bad3f3d93385..3a6910d82768 100644 --- a/translations/es-ES/content/site-policy/privacy-policies/github-privacy-statement.md +++ b/translations/es-ES/content/site-policy/privacy-policies/github-privacy-statement.md @@ -15,7 +15,7 @@ topics: - Legal --- -Fecha de entrada en vigor: 31 de mayo de 2022 +Effective date: September 1, 2022 Gracias por confiarle tu código fuente, tus proyectos y tus datos personales a GitHub Inc. o a GitHub B.V. ("GitHub", "nosotros", "de nosotros" o "nuestro"). Esta Declaración de Privacidad explica nuestras prácticas con respecto a la recopilación, el uso y la divulgación de tus datos, incluyendo cualquier dato personal que recolectemos y procesemos en conexión con nuestro sitio web y cualquier aplicación, software, producto y servicio que proporcione GitHub, incluyendo cualquier Vistas Previas Beta (en conjunto "El Servicio"). @@ -25,28 +25,28 @@ Todos los términos en mayúsculas tienen su definición en las [Condiciones de ## La versión corta -Utilizamos tu información personal como lo describe la presente Declaración de Privacidad. Sin importar quién seas, dónde vives, o cuál sea tu nacionalidad, proporcionames el mismo estándar alto de protección de la privacidad a todos nuestros usuarios en el mundo, sin importar su país de orígen o su ubicación. +Utilizamos tu información personal como lo describe la presente Declaración de Privacidad. No matter where you are, where you live, or what your citizenship is, you have the same high standard of privacy protection when using GitHub's products as all our users around the world, regardless of their country of origin or location. Para ver nuestro Aviso de Privacidad para los residentes de California, refiérete al [Aviso de GitHub sobre la Ley de Privacidad del Consumidor en California](#githubs-notice-to-california-residents) o desplázate hacia abajo. ## Resumen -| Sección | ¿Qué puedes encontrar allí? | -| ------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [Quién es responsable del procesamiento de tu información](#who-is-responsible-for-the-processing-of-your-information) | Sujeto a excepciones limitadas, GitHub es el controlador y entidad responsable de procesar tus datos personales en conexión con el sitio web o servicio. | -| [Qué información recopila GitHub](#what-information-github-collects) | GitHub recopila información directamente a partir de tu registro, tus pagos, tus transacciones y del perfil del usuario. También, cuando es necesario, recopilamos automáticamente información de tu uso, cookies e información de dispositivo sujetos, cuando sea necesario, a tu consentimiento. GitHub también podría recopilar datos personales de terceros. Solo recopilamos la cantidad mínima de datos personales tuyos necesaria, a menos de que elijas proporcionar más. | -| [Cómo utiliza GitHub tu información](#how-github-uses-your-information) | En esta sección, describimos las formas en las que utilizamos tu información, incluyendo para proporcionarte el Servicio, para comunicarnos contigo, para propósitos de cumplimiento y seguridad y para mejorar nuestro sitio web o servicio o para desarrollar características y funcionalidades nuevas para estos. También describimos la base legal sobre la cual procesamos tu información personal, cuando se exige legalmente. | -| [Cómo compartimos la información que recopilamos](#how-we-share-the-information-we-collect) | Puede que compartamos tu información con terceros en una de las siguientes circunstancias: con tu consentimiento, con nuestros proveedores de servicio, por motivos de seguridad, para cumplir con nuestras obligaciones legales o cuando exista un cambio de control o venta de las entidades corporativas o unidades de negocios. En GitHub, no vendemos tu información personal y no alojamos publicidad. | -| [Tus elecciones con respecto a nuestro procesamiento de tus datos personales](#your-choices-regarding-our-processing-of-your-personal-data) | Proporcionamos formas para que accedas, modifiques o elimines tu información personal. | -| [Cookies](#cookies) | Solo utilizamos las cookies estrictamente necesarias para proporcionar, asegurar y mejorar nuestro sitio web o servicio para desarrollar características y funcionalidades nuevas de nuestro sitio web o servicio. Ofrecemos una página que hace que esto sea muy transparente. No enviamos ningún tipo de información a servicios de analítica terceros. | -| [Cómo asegura GiitHub tu información](#how-github-secures-your-information) | Tomamos todas las medidas razonables necesarias para proteger la confidencialidad, integridad y disponibilidad de tus datos personales en GitHub y para proteger la resiliencia de nuestros servidores. | -| [Preferencias de comunicación](#communication-preferences) | Nos comunicamos contigo por correo electrónico. Puedes controlar la manera en que te contactamos en las configuraciones de la cuenta o poniéndote en contacto con nosotros. | -| [Resolver reclamos](#resolving-complaints) | En el caso improbable de que no podamos resolver una inquietud sobre la privacidad de forma rápida y exhaustiva, proporcionaremos un medio de resolución por medio de una disputa. | -| [Cambios en tu Declaración de privacidad](#changes-to-our-privacy-statement) | Te notificamos los cambios importantes en esta Declaración de privacidad 30 días antes de que cualquier cambio entre en vigencia. Puedes rastrear los cambios en nuestro repositorio de Políticas del sitio. | -| [Licencia](#license) | La presente Declaración de privacidad está autorizada por la [licencia Creative Commons Zero](https://creativecommons.org/publicdomain/zero/1.0/). | -| [Contactarse con GitHub](#contacting-github) | Siéntete libre de contactarnos si tienes preguntas acerca de nuestra Declaración de privacidad. | -| [Traducciones](#translations) | Proporcionamos enlaces a algunas traducciones de la Declaración de privacidad. | +| Sección | ¿Qué puedes encontrar allí? | +| ------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [Quién es responsable del procesamiento de tu información](#who-is-responsible-for-the-processing-of-your-information) | Subject to limited exceptions, GitHub is the controller and entity responsible for the processing of your personal data in connection with the Website or Service if you are in North America. For individuals outside North America the data controller is GitHub B.V. | +| [Qué información recopila GitHub](#what-information-github-collects) | GitHub recopila información directamente a partir de tu registro, tus pagos, tus transacciones y del perfil del usuario. También, cuando es necesario, recopilamos automáticamente información de tu uso, cookies e información de dispositivo sujetos, cuando sea necesario, a tu consentimiento. GitHub también podría recopilar datos personales de terceros. Solo recopilamos la cantidad mínima de datos personales tuyos necesaria, a menos de que elijas proporcionar más. | +| [Cómo utiliza GitHub tu información](#how-github-uses-your-information) | En esta sección, describimos las formas en las que utilizamos tu información, incluyendo para proporcionarte el Servicio, para comunicarnos contigo, para propósitos de cumplimiento y seguridad y para mejorar nuestro sitio web o servicio o para desarrollar características y funcionalidades nuevas para estos. También describimos la base legal sobre la cual procesamos tu información personal, cuando se exige legalmente. | +| [Cómo compartimos la información que recopilamos](#how-we-share-the-information-we-collect) | Puede que compartamos tu información con terceros en una de las siguientes circunstancias: con tu consentimiento, con nuestros proveedores de servicio, por motivos de seguridad, para cumplir con nuestras obligaciones legales o cuando exista un cambio de control o venta de las entidades corporativas o unidades de negocios. En GitHub, no vendemos tu información personal y no alojamos publicidad. | +| [Tus elecciones con respecto a nuestro procesamiento de tus datos personales](#your-choices-regarding-our-processing-of-your-personal-data) | Proporcionamos formas para que accedas, modifiques o elimines tu información personal. | +| [Cookies](#cookies) | Except for cookies used on our Enterprise Marketing Pages, we only use strictly necessary cookies to provide, secure, and improve our Website or Service or develop new features and functionality of our Website or Service.

As described below, we may use non-essential cookies on certain pages of our website to support our enterprise marketing efforts and market our products and services to enterprise customers, for example on resources.github.com (collectively “Enterprise Marketing Pages”).

We offer a [page](https://github.com/privacy/cookies) that makes all uses of cookies very transparent. | +| [Cómo asegura GiitHub tu información](#how-github-secures-your-information) | Tomamos todas las medidas razonables necesarias para proteger la confidencialidad, integridad y disponibilidad de tus datos personales en GitHub y para proteger la resiliencia de nuestros servidores. | +| [Preferencias de comunicación](#communication-preferences) | Nos comunicamos contigo por correo electrónico. Puedes controlar la manera en que te contactamos en las configuraciones de la cuenta o poniéndote en contacto con nosotros. | +| [Resolver reclamos](#resolving-complaints) | En el caso improbable de que no podamos resolver una inquietud sobre la privacidad de forma rápida y exhaustiva, proporcionaremos un medio de resolución por medio de una disputa. | +| [Cambios en tu Declaración de privacidad](#changes-to-our-privacy-statement) | Te notificamos los cambios importantes en esta Declaración de privacidad 30 días antes de que cualquier cambio entre en vigencia. Puedes rastrear los cambios en nuestro repositorio de Políticas del sitio. | +| [Licencia](#license) | La presente Declaración de privacidad está autorizada por la [licencia Creative Commons Zero](https://creativecommons.org/publicdomain/zero/1.0/). | +| [Contactarse con GitHub](#contacting-github) | Siéntete libre de contactarnos si tienes preguntas acerca de nuestra Declaración de privacidad. | +| [Traducciones](#translations) | Proporcionamos enlaces a algunas traducciones de la Declaración de privacidad. | ## Declaración de Privacidad de GitHub @@ -122,13 +122,14 @@ Podríamos utilizar tu información para proporcionar, administrar, analizar, ad - La personalización de nuestro servicio al entender tus preferencias y a ti mismo para mejorar tu experiencia y disfrute de nuestro servicio. - Proporcionar soporte al cliente y responder tus preguntas. - Entregarte comunicaciones promocionales sobre nuestros nuevos servicios, características, ofertas, promociones y otra información sobre nuestro servicio. +- Personalize and measure the effectiveness of enterprise business ads, promotional communications or marketing you receive related to the Enterprise Marketing Pages. - Enviarte información, incluyendo las confirmaciones, facturas, avisos técnicos, actualizaciones alertas de seguridad, soporte y mensajes administrativos. Combinamos los datos que recopilamos de diversas fuentes para estos propósitos y para darte una experiencia personalizad, consistente y más consistente. ## Cómo compartimos la información que recopilamos -Compartimos los datos personales con tu consentimiento o conforme sea necesario para completar tus transacciones o proporcionar los servicios que has solicitado o autorizado. Adicionalmente, podríamos compartir cada una de las categorías de tus datos personales descritas anteriormente con los tipos de terceros que se describen a continuación para los siguientes propósitos de negocios: +We share personal data as described below, including with your consent or as necessary to complete your transactions or provide the services you have requested or authorized. In addition, we may share each of the categories of your personal data described above with the types of third parties described below for the following business purposes: ### Información pública Puedes seleccionar las opciones disponibles a través de nuestro servicio para mostrar y compartir públicamente tu nombre o nombre de usuario y otra información específica, tal como tu perfil, datos, contenido y archivos demográficos o datos de ubicación geográfica. Por ejemplo, si quisieras que tu dirección de correo electrónico permanezca privada, incluso cuando estás comentando en repositorios públicos, [puedes configurar los ajustes de tu dirección de correo electrónico en tu perfil de usuario como privados](https://github.com/settings/emails). También puedes [actualizar tu configuración local de Git para utilizar tu dirección de correo electrónico privada](/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address). Por favor, consulta la información adicional sobre las direcciones de correo electrónico en los mensajes de confirmación [aquí](/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address). @@ -144,9 +145,9 @@ Puedes habilitar o agregar aplicaciones de terceros, conocidas como "Productos d Puedes indicar, a través de tus acciones en GitHub, que quieres compartir tus datos personales. Si colaboras o te conviertes en miembro de una organización, entonces tus propietarios de cuenta podrían recibir tus datos personales. Cuando aceptas una invitación a una organización, se te notificará sobre los tipos de información que los propietarios pueden ver (para obtener más información, consulta la sección [Acerca de la membresía de la organización](/github/setting-up-and-managing-your-github-user-account/about-organization-membership)). Contacta a los propietarios de cuenta para obtener más información sobre cómo podrían procesar tus datos personales en su organización y las formas en las que puedes acceder, actualizar, alterar o borrar dichos datos personales almacenados en la cuenta. ### Proveedores de servicios -Compartimos tus datos personales con los proveedores de servicio que procesan la información en nuestro nombre para proporcionar o mejorar nuestro servicio. Por ejemplo, nuestros proveedores de servicios podrían realizar el procesamiento de pagos, tickets de soporte de cliente, transmisión de datos de red, seguridad y otros servicios similares. Si bien GitHub procesa todos los datos personales en los Estados Unidos, nuestros proveedores de servicio podrían procesarlos fuera de los Estados Unidos o de la Unión Europea. Dicho procesamiento por parte de los proveedores de servicios cumplirá con las leyes aplicables, incluyendo cualquier mecanismo de transferencia. +Compartimos tus datos personales con los proveedores de servicio que procesan la información en nuestro nombre para proporcionar o mejorar nuestro servicio. For example, our service providers may perform payment processing, customer support ticketing, network data transmission, web analytics, marketing operations, security, and other similar services. Si bien GitHub procesa todos los datos personales en los Estados Unidos, nuestros proveedores de servicio podrían procesarlos fuera de los Estados Unidos o de la Unión Europea. Dicho procesamiento por parte de los proveedores de servicios cumplirá con las leyes aplicables, incluyendo cualquier mecanismo de transferencia. - ### Afiliados Habilitamos el acceso a los datos personales a lo largo de nuestras sucursales, afiliados y empresas relacionadas, por ejemplo, en donde compartimos sistemas de datos comunes o donde se requiere acceso para operar y proporcionar el servicio. + ### Affiliates We enable access to personal data across our subsidiaries, affiliates, and related companies, for example, where we share common data systems, when affiliates provide services on our behalf, or where access is needed to operate and provide the Service. ### Con fines de seguridad Divulgaremos datos personales si creemos que esto es necesario para: @@ -171,7 +172,7 @@ Nosotros *no* vendemos tus datos personales por consideraciones monetarias u otr ## Tus elecciones con respecto a nuestro procesamiento de tus datos personales Proporcionamos elecciones sobre los datos personales que recopilamos de ti. Las elecciones que hagas no aplicarán a los datos personales asociados con una organización bajo tu cuenta. -Acceso, corrección y borrado. Si eres un usuario de GitHub, podrías acceder, actualizar, alterar o borrar tu información básica de perfil de usuario al [editar tu perfil](https://github.com/settings/profile) o contactar al [Soporte de GitHub](https://support.github.com/contact) o al [Soporte Premium de GitHub](https://enterprise.githubsupport.com/hc/en-us). Puedes controlar la información que recopilamos acerca de ti limitando la información que contiene tu perfil, manteniendo tu información actual, o poniéndote en contacto con [GitHub Support](https://support.github.com/contact) o [GitHub Premium Support](https://enterprise.githubsupport.com/hc/en-us). +Acceso, corrección y borrado. Si eres un usuario de GitHub, podrías acceder, actualizar, alterar o borrar tu información básica de perfil de usuario al [editar tu perfil](https://github.com/settings/profile) o contactar al [Soporte de GitHub](https://support.github.com/contact) o al [Soporte Premium de GitHub](https://enterprise.githubsupport.com/hc/en-us). You can control the information we collect about you by limiting what information is in your profile, by keeping your information current, by changing your cookie preferences, or by contacting [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://enterprise.githubsupport.com/hc/en-us). Retenemos y utilizamos tu información tal como se describe en esta declaración de privacidad pero, salvo los requisitos legales, borraremos tu perfil completo después de que hayan transcurrido 90 días desde tu solicitud. Después de que una cuenta se ha eliminado, ciertos datos, tales como contribuciones a los repositorios de otros usuarios y comentarios en asuntos ajenos, permanecerán. Sin embargo, borraremos o desidentificaremos tus datos personales, incluyendo tu nombre de usuario y dirección de correo electrónico, en el campo de autor de las propuestas, solicitudes de cambio y comentarios y los asociaremos con un usuario fantasma. Dicho esto, la dirección de correo electrónico que proporcionaste a través de tus ajustes para confirmaciones de Git siempre se asociarán con tus confirmaciones en el sistema de Git. Si eliges hacer tu dirección de correo electrónico privada, también deberías actualizar la configuración de tu confirmación de cambios de Git. No podemos cambiar o eliminar datos en el historial de confirmación de Git (el software de Git está diseñado para mantener un registro) pero te permitimos controlar qué información pones en ese registro. @@ -208,13 +209,65 @@ Dependemos da diversas bases legales para recopilar y procesar datos personales ### Cookies y tecnologías de rastreo -GitHub utiliza cookies para proporcionar, asegurar y mejorar nuestro Servicio o para desarrollar características y funcionalidades nuevas del mismo. Por ejemplo, las utilizamos para mantenerte en tu sesión, recordar tus preferencias, identificar tu dispositivo para propósitos de seguridad, compilar reportes estadísticos y proporcionar información sobre el desarrollo futuro de GitHub. Utilizamos nuestras propias cookies y no usamos ningún proveedor de servicios tercero en este contexto. Si inhabilitas la capacidad de tu dispositivo o buscador para aceptar estas cookies, no podrás iniciar sesión ni utilizar nuestro servicio. Proporcionamos más información acerca de las [cookies en GitHub](/github/site-policy/github-subprocessors-and-cookies#cookies-on-github) en nuestra página de [Subprocesadores y cookies de GitHub](/github/site-policy/github-subprocessors-and-cookies), en la cual se describen las cookies que configuramos, las necesidades que tenemos para utilizarlas, y la vigencia de las mismas. +GitHub uses cookies to provide, secure and improve our Service or to develop new features and functionality of our Service. For example, we use them to (i) keep you logged in, (ii) remember your preferences, (iii) identify your device for security and fraud purposes, including as needed to maintain the integrity of our Service, (iv) compile statistical reports, and (v) provide information and insight for future development of GitHub. We provide more information about [cookies on GitHub](https://github.com/privacy/cookies) that describes the cookies we set, the needs we have for those cookies, and the expiration of such cookies. + +For Enterprise Marketing Pages, we may also use non-essential cookies to (i) gather information about enterprise users’ interests and online activities to personalize their experiences, including by making the ads, content, recommendations, and marketing seen or received more relevant and (ii) serve and measure the effectiveness of targeted advertising and other marketing efforts. If you disable the non-essential cookies on the Enterprise Marketing Pages, the ads, content, and marketing you see may be less relevant. Nuestros correos electrónicos a los usuarios podrían contener una etiqueta de pixel, que es una imagen clara y pequeña que nos puede decir si abriste un correo electrónico o no y cuál es tu dirección IP. Utilizamos esta etiqueta de pixel para hacer nuestras comunicaciones por correo electrónico más efectivas y para asegurarnos de que no estemos enviando correo no deseado. -### DNT +The length of time a cookie will stay on your browser or device depends on whether it is a “persistent” or “session” cookie. Session cookies will only stay on your device until you stop browsing. Persistent cookies stay until they expire or are deleted. The expiration time or retention period applicable to persistent cookies depends on the purpose of the cookie collection and tool used. You may be able to delete cookie data as described here. + +#### What are cookies and similar technologies? + +We use cookies and similar technologies, such as web beacons, local storage, and mobile analytics, to operate and provide our Services. When visiting Enterprise Marketing Pages, like resources.github.com, these and additional cookies, like advertising IDs, may be used for sales and marketing purposes. + +Cookies are small text files stored by your browser on your device. A cookie can later be read when your browser connects to a web server in the same domain that placed the cookie. The text in a cookie contains a string of numbers and letters that may uniquely identify your device and can contain other information as well. This allows the web server to recognize your browser over time, each time it connects to that web server. + +Web beacons are electronic images (also called “single-pixel” or “clear GIFs”) that are contained within a website or email. When your browser opens a webpage or email that contains a web beacon, it automatically connects to the web server that hosts the image (typically operated by a third party). This allows that web server to log information about your device and to set and read its own cookies. In the same way, third-party content on our websites (such as embedded videos, plug-ins, or ads) results in your browser connecting to the third-party web server that hosts that content. + +Mobile identifiers for analytics can be accessed and used by apps on mobile devices in much the same way that websites access and use cookies. When visiting Enterprise Marketing pages, like resources.github.com, on a mobile device these may allow us and our third-party analytics and advertising partners to collect data for sales and marketing purposes. + +We may also use so-called “flash cookies” (also known as “Local Shared Objects” or “LSOs”) to collect and store information about your use of our Services. Flash cookies are commonly used for advertisements and videos. + +#### How do we and our partners use cookies and similar technologies? + +The GitHub Services use cookies and similar technologies for a variety of purposes, including to store your preferences and settings, enable you to sign-in, analyze how our Services perform, track your interaction with the Services, develop inferences, combat fraud, and fulfill other legitimate purposes. Some of these cookies and technologies may be provided by third parties, including service providers and advertising partners. For example, our analytics and advertising partners may use these technologies in our Services to collect personal information (such as the pages you visit, the links you click on, and similar usage information, identifiers, and device information) related to your online activities over time and across Services for various purposes, including targeted advertising. GitHub will place non-essential cookies on pages where we market products and services to enterprise customers, for example, on resources.github.com. + +We and/or our partners also share the information we collect or infer with third parties for these purposes. + +The table below provides additional information about how we use different types of cookies: + +| Propósito | Descripción | +|:---------------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Required Cookies | GitHub uses required cookies to perform essential website functions and to provide the services. For example, cookies are used to log you in, save your language preferences, provide a shopping cart experience, improve performance, route traffic between web servers, detect the size of your screen, determine page load times, improve user experience, and for audience measurement. These cookies are necessary for our websites to work. | +| Analítica | We allow third parties to use analytics cookies to understand how you use our websites so we can make them better. For example, cookies are used to gather information about the pages you visit and how many clicks you need to accomplish a task. We also use some analytics cookies to provide personalized advertising. | +| Social Media | GitHub and third parties use social media cookies to show you ads and content based on your social media profiles and activity on GitHub’s websites. This ensures that the ads and content you see on our websites and on social media will better reflect your interests. This also enables third parties to develop and improve their products, which they may use on websites that are not owned or operated by GitHub. | +| Advertising | In addition, GitHub and third parties use advertising cookies to show you new ads based on ads you've already seen. Cookies also track which ads you click or purchases you make after clicking an ad. This is done both for payment purposes and to show you ads that are more relevant to you. For example, cookies are used to detect when you click an ad and to show you ads based on your social media interests and website browsing history. | + +#### What are your cookie choices and controls? + + You have several options to disable non-essential cookies: + + 1. **Specifically on GitHub Enterprise Marketing Pages** + + Any GitHub page that serves non-essential cookies will have a link in the page’s footer to cookie settings. You can express your preferences at any time by clicking on that linking and updating your settings. + + Some users will also be able to manage non-essential cookies via a cookie consent banner, including the options to accept, manage, and reject all non-essential cookies. + 2. **Generally for all websites** + + You can control the cookies you encounter on the web using a variety of widely-available tools. Por ejemplo: + - If your browser sends a [Do Not Track](https://en.wikipedia.org/wiki/Do_Not_Track) (DNT) signal, GitHub will not set non-essential cookies and will not load third party resources which set non-essential cookies. + - Many browsers provide cookie controls which may limit the types of cookies you encounter online. Check out the documentation for your browser to learn more. + - If you enable a browser extension designed to block tracking, such as [Privacy Badger](https://en.wikipedia.org/wiki/Privacy_Badger), non-essential cookies set by a website or third parties may be disabled. + - If you enable a browser extension designed to block unwanted content, such as [uBlock Origin](https://en.wikipedia.org/wiki/UBlock_Origin), non-essential cookies will be disabled to the extent that content that sets non-essential cookies will be blocked. + - Advertising controls. Our advertising partners may participate in associations that provide simple ways to opt out of ad targeting, which you can access at: + - United States: [NAI](http://optout.networkadvertising.org) and [DAA](http://optout.aboutads.info/) + - Canada: [Digital Advertising Alliance of Canada](https://youradchoices.ca/) + - Europe: [European Digital Advertising Alliance](http://www.youronlinechoices.com/) + + These choices are specific to the browser you are using. If you access our Services from other devices or browsers, take these actions from those systems to ensure your choices apply to the data collected when you use those systems. + -"[No Rastrear](https://www.eff.org/issues/do-not-track)" (DNT, por sus siglas en inglés) es una preferencia de privacidad que puedes configurar en tu buscador si no quieres que los servicios en línea recolecten y compartan ciertos tipos de información acerca de tu actividad en línea desde los servicios de rastreo de terceros. GitHub responde a las señales DNT del navegador y sigue el estándar [W3C para responder a las señales DNT](https://www.w3.org/TR/tracking-dnt/). Si deseas configurar tu navegador para que indique que no deseas que se rastree, revisa la documentación de tu navegador acerca de cómo habilitar esa señal. También hay buenas aplicaciones que bloquean el rastro en línea, como [Privacy Badger](https://privacybadger.org/). ## Retención de datos personales Retenemos datos personales por tanto como sea necesario para proporcionar los servicios y llevar a cabo las transacciones que hayas solicitad, para cumplir con nuestras obligaciones legales, resolver disputas, hacer valer nuestros acuerdos y otros propósitos de negocio legales y legítimos. Ya que estas necesidades pueden variar para los diferentes tipos de datos en el contexto de diferentes servicios, los periodos de retención reales pueden variar significativamente con base en los criterios tales como las expectativas o el consentimiento de los usuarios, la sensibilidad de los datos y la disponibilidad de los controles automáticos que permiten que los usuarios borren datos y nuestras obligaciones contractuales. Por ejemplo, podríamos retener tus datos personales por periodos más largos, cuando fuese necesario, sujeto a la ley aplicable y por propósitos de seguridad. @@ -232,21 +285,17 @@ Adicionalmente, si tu cuenta tiene repositorios privados, controlas el acceso a GitHub proporcionará un aviso con respecto al acceso al repositorio privado cuando la ley no lo prohíba y como respuesta a las amenazas de seguridad u otros riesgos a esta. -### Transferencias de datos transfronterizas +### Cross-border data transfers GitHub procesa datos personales tanto dentro como fuera de los Estados Unidos y depende de los mecanismos legales tales como las Cláusulas Contractuales Estándar para transferir legalmente los datos desde el Área Económica Europea y el Reino Unido y Suiza hacia los Estados Unidos. Puedes solicitar una copia de las Cláusulas Contractuales Estándar utilizando los detalles de contacto que se proporcionan en la sección denominada "Contactar a GitHub" a continuación. ### Resolver reclamos Si tienes inquietudes sobre la forma en que GitHub maneja tus datos personales, por favor, déjanos saberlo de inmediato. Queremos ayudar. Puedes ponerte en contacto con nosotros completando el [Formulario de contacto de privacidad](https://support.github.com/contact/privacy). También puedes contactarnos directamente enviando un mensaje por correo electrónico a **(privacy [at] github [dot] com)** con el título "Privacy Concerns". Responderemos rápidamente, dentro de los 45 días a más tardar. -También puedes ponerte en contacto directamente con nuestro Responsable de Protección de Datos. +You may also contact our Data Protection Officer directly at at **github [at]dp-officer [dot] com** + +**If you are in North America:**
GitHub Data Protection Officer
88 Colin P. Kelly Jr. St.
San Francisco, CA 94107
United States
**privacy [at] github [dot] com**
-| Nuestra casa central de los Estados Unidos | Nuestra oficina de la UE | -| ------------------------------------------ | --------------------------------- | -| Oficial de Protección de Datos de GitHub | GitHub BV | -| 88 Colin P. Kelly Jr. St. | Vijzelstraat 68-72 | -| San Francisco, CA 94107 | 1017 HL Amsterdam | -| Estados Unidos | Países Bajos | -| **privacy [at] github [dot] com** | **privacy [at] github [dot] com** | +**If you are outside of North America:**
Github Data Protection Officer
c/o DP Dock DPO Services GmbH,
Attn: GitHub BV, Gut Projensdorf,
24161 Altenholz, Germany
github@dp-officer.com cc: **privacy [at] github [dot] com**
CC: GitHub BV, Vijzelstraat 68-72, 1017 HL Amsterdam, The Netherlands ### Proceso de resolución de disputas @@ -254,7 +303,7 @@ En el improbable caso de que surja una disputa entre tú y GitHub con respecto a ## Cambios en tu Declaración de privacidad -Aunque es probable que la mayoría de los cambios sean mínimos, GitHub puede cambiar nuestra Declaración de privacidad de manera ocasional. Les notificaremos a los Usuarios acerca de los cambios materiales a esta Declaración de privacidad por medio de nuestro Sitio web, al menos, 30 días antes de que el cambio entre en vigencia a través de la publicación de un aviso en nuestra página de inicio o enviando un correo electrónico a la dirección principal de correo electrónico que se especifica en tu cuenta de GitHub. También actualizaremos nuestro [Repositorio de políticas del sitio](https://github.com/github/site-policy/), que realiza un seguimiento de todos los cambios de esta política. Para otros cambios en esta declaración de privacidad, invitamos a los usuarios a [consultar](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository) o a revisar el repositorio de nuestra política del sitio con frecuencia. +Aunque es probable que la mayoría de los cambios sean mínimos, GitHub puede cambiar nuestra Declaración de privacidad de manera ocasional. Les notificaremos a los Usuarios acerca de los cambios materiales a esta Declaración de privacidad por medio de nuestro Sitio web, al menos, 30 días antes de que el cambio entre en vigencia a través de la publicación de un aviso en nuestra página de inicio o enviando un correo electrónico a la dirección principal de correo electrónico que se especifica en tu cuenta de GitHub. También actualizaremos nuestro [Repositorio de políticas del sitio](https://github.com/github/site-policy/), que realiza un seguimiento de todos los cambios de esta política. For other changes to this Privacy Statement, we encourage Users to [watch](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository) or to check our Site Policy repository frequently. ## Licencia diff --git a/translations/es-ES/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md b/translations/es-ES/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md index a4e303e98fec..0508bfdb7dfc 100644 --- a/translations/es-ES/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md +++ b/translations/es-ES/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md @@ -14,74 +14,23 @@ topics: - Legal --- -Fecha de entrada en vigor: **2 de abril de 2021** +Fecha de entrada en vigor: **1 de septiembre de 2022** -{% note %} - -**Nota:** Los cambios a la lista de cookies en esta página están pendientes actualmente. - -{% endnote %} GitHub ofrece una gran cantidad de transparencia en cuanto a cómo usamos tus datos, cómo recopilamos tus datos y con quién los compartimos. Para este propósito, proporcionamos esta página, la cual detalla [nuestros subprocesadores](#github-subprocessors) y cómo utilizamos las [cookies](#cookies-on-github). ## Subprocesadores de GitHub -Cuando compartimos tu información con subprocesadores de terceros, como nuestros vendedores y proveedores de servicios, seguimos siendo responsables de ella. Trabajamos arduamente para mantener tu confianza cuando traemos nuevos proveedores y exigimos que todos los proveedores celebren acuerdos de protección de datos con nosotros que restrinjan su procesamiento de la información personal de los usuarios (tal como se define en la [Declaración de Privacidad](/articles/github-privacy-statement/)). Puedes iniciar sesión para recibir actualizaciones de la lista de subprocesadores [aquí](https://www.github.com/privacy/subprocessors). +Cuando compartimos tu información con subprocesadores de terceros, como nuestros vendedores y proveedores de servicios, seguimos siendo responsables de ella. Trabajamos arduamente para mantener tu confianza cuando traemos nuevos proveedores y exigimos que todos los proveedores celebren acuerdos de protección de datos con nosotros que restrinjan su procesamiento de la información personal de los usuarios (tal como se define en la [Declaración de Privacidad](/articles/github-privacy-statement/)). -| Nombre del subprocesador | Descripción del procesamiento | Ubicación del procesamiento | Ubicación Corporativa | -|:------------------------ |:----------------------------------------------------------------------------------------------- |:--------------------------- |:--------------------- | -| Automattic | Servicio de alojamiento | Estados Unidos | Estados Unidos | -| AWS Amazon | Alojamiento de datos | Estados Unidos | Estados Unidos | -| Braintree (PayPal) | Procesador de pagos de suscripción con tarjeta de crédito | Estados Unidos | Estados Unidos | -| Clearbit | Servicio de enriquecimiento de datos de marketing | Estados Unidos | Estados Unidos | -| Discourse | Proveedor de software del foro de la comunidad | Estados Unidos | Estados Unidos | -| Eloqua | Automatización de campañas de marketing | Estados Unidos | Estados Unidos | -| Google Apps | Infraestructura interna de la empresa | Estados Unidos | Estados Unidos | -| MailChimp | Proveedor de servicios de correo de billetaje de clientes | Estados Unidos | Estados Unidos | -| Mailgun | Proveedor de servicios de correo transaccional | Estados Unidos | Estados Unidos | -| Microsoft | Servicios de Microsoft | Estados Unidos | Estados Unidos | -| Nexmo | Proveedor de notificaciones SMS | Estados Unidos | Estados Unidos | -| Salesforce.com | Gestión de relaciones con clientes | Estados Unidos | Estados Unidos | -| Sentry.io | Proveedor de monitoreo de aplicaciones | Estados Unidos | Estados Unidos | -| Stripe | Proveedor de pagos | Estados Unidos | Estados Unidos | -| Twilio & Twilio Sendgrid | Proveedor de notificaciones por SMS & proveedor de servicio de correo electrónico transaccional | Estados Unidos | Estados Unidos | -| Zendesk | Sistema de tickets de soporte al cliente | Estados Unidos | Estados Unidos | -| Zuora | Sistema de facturación corporativa | Estados Unidos | Estados Unidos | +When we bring on a new subprocessor who handles our Users' Personal Information, or remove a subprocessor, or we change how we use a subprocessor, we will update the list of subprocessors. You can view the current list of subprocessors, and sign up to receive subprocessor list updates, at [https://www.github.com/privacy/subprocessors](https://www.github.com/privacy/subprocessors). -Cuando traemos un nuevo subprocesador que maneja la información personal de nuestros usuarios o eliminas un subprocesador, o cambiamos la manera en que usamos un subprocesador, actualizaremos esta página. Si tienes preguntas o inquietudes acerca de un nuevo subprocesador, estaremos encantados de ayudarte. Ponte en contacto con nosotros vía{% data variables.contact.contact_privacy %}. +Si tienes preguntas o inquietudes acerca de un nuevo subprocesador, estaremos encantados de ayudarte. Ponte en contacto con nosotros vía{% data variables.contact.contact_privacy %}. ## Cookies en GitHub GitHub utiliza cookies para proporcionar y asegurar nuestros sitios web, así como para analizar el uso de los mismos, para poder ofrecerte una gran experiencia de usuario. Por favor, echa un vistazo a nuestra [Declaración de privacidad](/github/site-policy/github-privacy-statement#our-use-of-cookies-and-tracking) si te gustaría obtener más información sobre las cookies y sobre cómo y por qué las utilizamos. -Ya que la cantidad de nombres y cookies puede cambiar, la tabla siguiente se podría actualizar a menudo. - -| Proveedor de servicios | Nombre de la Cookie | Descripción | Vencimiento* | -|:---------------------- |:------------------------------------ |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |:------------------------------------------------------------------------------------------ | -| GitHub | `app_manifest_token` | Esta cookie se utiliza durante el flujo del manifiesto de la app para mantener su estado durante la redirección para obtener una sesión de usuario. | cinco minutos | -| GitHub | `color_mode` | Esta cookie se utiliza para indicar que el usuario seleccionó la preferencia de tema. | sesión | -| GitHub | `_device_id` | Esta cookie se utiliza para rastrear los dispositivos reconocidos para propósitos de seguridad. | un año | -| GitHub | `dotcom_user` | Esta cookie se utiliza para indicarnos que el usuario ya está registrado. | un año | -| GitHub | `_gh_ent` | Esta cookie se utiliza para la aplicación temporal y el estado del marco de trabajo entre las páginas como en qué paso se encuentra el cliente dentro de un formulario de varios pasos. | dos semanas | -| GitHub | `_gh_sess` | Esta cookie se usa para la aplicación temporal y el estado del marco entre las páginas como para indicar en qué paso está el usuario en un formulario de múltiples pasos. | sesión | -| GitHub | `gist_oauth_csrf` | Esta cookie se establece por Gist para asegurar que el usuario que inició el flujo oauth sea el mismo usuario que lo completa. | se borra al validar el estado de oauth | -| GitHub | `gist_user_session` | Gist utiliza esta cookie cuando se ejecuta en un host por separado. | dos semanas | -| GitHub | `has_recent_activity` | Esta cookie se utiliza para prevenir que se muestre la seguridad que es intersticial a los usuarios que han visitado la app recientemente. | una hora | -| GitHub | `__Host-gist_user_session_same_site` | Esta cookie se configura para asegurar que los navegadores que soportan las cookies de SameSite puedan verificar si una solicitud se origina desde GitHub. | dos semanas | -| GitHub | `__Host-user_session_same_site` | Esta cookie se configura para asegurar que los navegadores que soportan las cookies de SameSite puedan verificar si una solicitud se origina desde GitHub. | dos semanas | -| GitHub | `logged_in` | Esta cookie se utiliza para indicarnos que el usuario ya está registrado. | un año | -| GitHub | `marketplace_repository_ids` | Esta cookie se utiliza para el flujo de instalación de marketplace. | una hora | -| GitHub | `marketplace_suggested_target_id` | Esta cookie se utiliza para el flujo de instalación de marketplace. | una hora | -| GitHub | `_octo` | Esta cookie se utiliza para la administración de sesiones, incluyendo el almacenamiento en caché del contenido dinámico, el acceso de características condicionales, los metadatos de solicitud de soporte y la analítica de las primeras partes. | un año | -| GitHub | `org_transform_notice` | Esta cookie se utiliza para proporcionar notificaciones durante las transformaciones de las organizaciones. | una hora | -| GitHub | `private_mode_user_session` | Esta cookie se utiliza para las solicitudes de autenticación empresarial. | dos semanas | -| GitHub | `saml_csrf_token` | Esta cookie se establece mediante el método de ruta de autenticación de SAML para asociar un token con el cliente. | hasta que el usuario cierre el buscador o hasta que complete la solicitud de autenticación | -| GitHub | `saml_csrf_token_legacy` | Esta cookie se establece mediante el método de ruta de autenticación de SAML para asociar un token con el cliente. | hasta que el usuario cierre el buscador o hasta que complete la solicitud de autenticación | -| GitHub | `saml_return_to` | Esta cookie se establece mediante el método de ruta de autenticación de SAML para mantener el estado durante el bucle de autenticación de SAML. | hasta que el usuario cierre el buscador o hasta que complete la solicitud de autenticación | -| GitHub | `saml_return_to_legacy` | Esta cookie se establece mediante el método de ruta de autenticación de SAML para mantener el estado durante el bucle de autenticación de SAML. | hasta que el usuario cierre el buscador o hasta que complete la solicitud de autenticación | -| GitHub | `tz` | Esta cookie nos permite personalizar las marcas de tiempo a tu zona horaria. | sesión | -| GitHub | `user_session` | Esta cookie se utiliza para que inicies sesión. | dos semanas | - -_*_ Las fechas de **vencimiento** para las cookies que se listan a continuación generalmente se aplican permanentemente. +You can view the current list of cookies on GitHub, and sign up to receive cookie list updates, at [https://github.com/privacy/cookies](https://github.com/privacy/cookies). -(i) Por favor, ten encuenta que si bien limitamos nuestro uso de cookies de terceros a aquellas necesarias para proporcionar una funcionalidad externa cuando interpretamos el contenido externo, algunas páginas en nuestro sitio web podrían configurar otras cookies de terceros. Por ejemplo, es posible que insertemos contenido, como vídeos, desde otro sitio que establezca una cookie. Si bien tratamos de minimizar estas cookies de terceros, no siempre podemos controlar qué cookies configura dicho contenido. +(i) Por favor, ten encuenta que si bien limitamos nuestro uso de cookies de terceros a aquellas necesarias para proporcionar una funcionalidad externa cuando interpretamos el contenido externo, algunas páginas en nuestro sitio web podrían configurar otras cookies de terceros. Por ejemplo, es posible que insertamos contenido, como vídeos, desde otro sitio que establezca una cookie. Si bien tratamos de minimizar estas cookies de terceros, no siempre podemos controlar qué cookies establece este contenido de terceros. diff --git a/translations/es-ES/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md b/translations/es-ES/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md index 15580fe9d53a..69770fe7bff0 100644 --- a/translations/es-ES/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md +++ b/translations/es-ES/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md @@ -25,7 +25,7 @@ shortTitle: Patrocina a un contribuyente Puedes patrocinar una cuenta en nombre de tu cuenta personal para invertir en los proyectos de los cuales te beneficies personalmente. Puedes patrocinar una cuenta en nombre de tu organización por varias razones. - Mantener bibliotecas específicas de las cuales dependa el trabajo de tu organización -- Invertir en el ecosistema del cual dependes como organización (tal como blockchain) +- Invertir en el ecosistema del que dependes como organización (tal como blockchain) - Desarrollar una conciencia de marca como una organización que valora el código abierto - Agradecer a los desarrolladores de código abierto por crear bibliotecas que complementan el producto que ofrece tu organización diff --git a/translations/es-ES/data/features/actions-hosted-runners.yml b/translations/es-ES/data/features/actions-hosted-runners.yml new file mode 100644 index 000000000000..fcc88d707de7 --- /dev/null +++ b/translations/es-ES/data/features/actions-hosted-runners.yml @@ -0,0 +1,5 @@ +#Reference: #6458 +#Larger GitHub-hosted runners +versions: + fpt: '*' + ghec: '*' diff --git a/translations/es-ES/data/features/code-scanning-exclude-queries-from-analysis.yml b/translations/es-ES/data/features/code-scanning-exclude-queries-from-analysis.yml new file mode 100644 index 000000000000..2157533a6d34 --- /dev/null +++ b/translations/es-ES/data/features/code-scanning-exclude-queries-from-analysis.yml @@ -0,0 +1,7 @@ +#Issue 7617 +#Users can easily exclude CodeQL queries from code scanning analyses - [GA] +versions: + fpt: '*' + ghec: '*' + ghes: '>3.6' + ghae: 'issue-7617' diff --git a/translations/es-ES/data/features/packages-npm-v2.yml b/translations/es-ES/data/features/packages-npm-v2.yml new file mode 100644 index 000000000000..572e412e4a45 --- /dev/null +++ b/translations/es-ES/data/features/packages-npm-v2.yml @@ -0,0 +1,5 @@ +#Issue 7039 +#npm Package Registry Improvements (v2) GA +versions: + fpt: '*' + ghec: '*' diff --git a/translations/es-ES/data/features/streaming-datadog.yml b/translations/es-ES/data/features/streaming-datadog.yml new file mode 100644 index 000000000000..ab90546c8d4e --- /dev/null +++ b/translations/es-ES/data/features/streaming-datadog.yml @@ -0,0 +1,4 @@ +#Reference #7495 +#Documentation for audit log streaming to a Datadog endpoint +versions: + ghec: '*' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-1/20.yml b/translations/es-ES/data/release-notes/enterprise-server/3-1/20.yml index e5a8d1f35795..a518cef9b173 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-1/20.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-1/20.yml @@ -6,11 +6,11 @@ sections: - 'El cargar nodos en un par con disponibilidad alta con un paquete de mejora pudo haber causado que Elasticsearch ingresara en un estado inconsistente en algunos casos.' - 'En algunas topologías de clúster, no pudieron ejecutarse las utilidades de línea de comandos `ghe-spokesctl` y `ghe-btop`.' - 'Los índices de Elastisearch podrían duplicarse durante la mejora de un paquete debido a que el servicio de `elasticsearch-upgrade` se ejecutó varias veces en paralelo.' - - 'The `maint_host_low` job queues were not processed, resulting in some maintenance tasks failing to run.' + - 'Las colas de job `maint_host_low` no se procesaron y esto dio como resultado que algunas tareas de mantenimiento no se pudieran ejecutar.' - 'Cuando conviertes una cuenta de usuario en una organización, si dicha cuenta fue propietaria de la cuenta empresarial de {% data variables.product.prodname_ghe_server %}, la organización convertida se mostró incorrectamente en la lista de propietarios de la empresa.' - 'El crear un token de OAuth de personificación utilizando la API de REST de administración de empresas dio como resultado un error cuando una integración que coincidió con la ID de aplicación de OAuth ya existía.' changes: - - 'When attempting to cache a value larger than the maximum allowed in Memcached, an error was raised however the key was not reported.' + - 'Cuando se intenta guardar en caché un valor mayor al máximo permitido en memcached, un error se levantó pero la llave no se reportó.' known_issues: - 'El registor de npm del {% data variables.product.prodname_registry %} ya no regresa un valor de tiempo en las respuestas de metadatos. Esto se hizo para permitir mejoras de rendimiento sustanciales. Seguimos teniendo todos los datos necesarios para devolver un valor de tiempo como parte de la respuesta de metadatos y terminaremos de devolver este valor ene l futuro una vez que hayamos resuelto los problemas de rendimiento existentes.' - 'En una instancia recién configurada de {% data variables.product.prodname_ghe_server %} sin ningún usuario, un atacante podría crear el primer usuario adminsitrador.' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-2/12.yml b/translations/es-ES/data/release-notes/enterprise-server/3-2/12.yml index 15273f31a9f4..59507e58e6c2 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-2/12.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-2/12.yml @@ -7,11 +7,11 @@ sections: - 'En algunas topologías de clúster, no pudieron ejecutarse las utilidades de línea de comandos `ghe-spokesctl` y `ghe-btop`.' - 'Los índices de Elastisearch podrían duplicarse durante la mejora de un paquete debido a que el servicio de `elasticsearch-upgrade` se ejecutó varias veces en paralelo.' - 'Cuando conviertes una cuenta de usuario en una organización, si dicha cuenta fue propietaria de la cuenta empresarial de {% data variables.product.prodname_ghe_server %}, la organización convertida se mostró incorrectamente en la lista de propietarios de la empresa.' - - 'Creating an impersonation OAuth token using the Enterprise Administration REST API worked incorrectly when an integration matching the OAuth Application ID already existed.' + - 'El crear un token de OAuth de personificación utilizando la API de REST de administración de empresas funcionó de forma incorrecta cuando una integración que coincidió con la ID de aplicación de OAuth ya existía.' changes: - 'Los errores de configuración que detienen una ejecución de aplicación de configuraciones ahora son el producto de la terminal adicionalmente a la bitácora de configuración.' - 'Al intentar almacenar en caché un valor que fuera más grande que el máximo permitido en Memcached, se levantó un error pero la clave no se reportó.' - - 'The {% data variables.product.prodname_codeql %} starter workflow no longer errors even if the default token permissions for {% data variables.product.prodname_actions %} are not used.' + - 'El flujo de trabajo inicial de {% data variables.product.prodname_codeql %} ya no muestra un error, incluso si no se utilizan los permisos del token predeterminado para {% data variables.product.prodname_actions %}.' - 'Si se habilitaron las características de {% data variables.product.prodname_GH_advanced_security %} en tu instancia, el rendimiento de los jobs en segundo plano mejoró al procesar los lotes para las contribuciones de repositorio.' known_issues: - 'En una instancia recién configurada de {% data variables.product.prodname_ghe_server %} sin ningún usuario, un atacante podría crear el primer usuario adminsitrador.' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-2/17.yml b/translations/es-ES/data/release-notes/enterprise-server/3-2/17.yml index 6a8d6c8af9aa..62417df964b9 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-2/17.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-2/17.yml @@ -6,7 +6,7 @@ sections: - | **ALTA**: Las aplicaciones instaladas anteriormente en las cuentas de usuario obtuvieron permiso automáticamente para acceder a una organización en los tokens de acceso en el alcance después de que la cuenta de usuario se transformó en una cuenta de organización. Esta vulnerabilidad se reportó a través del [Programa de Recompensas por Errores de GitHub](https://bounty.github.com). bugs: - - When a custom dormancy threshold was set for the instance, suspending all dormant users did not reliably respect the threshold. For more information about dormancy, see "[Managing dormant users](/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users)." + - Cuando se configuró un umbral de inactividad personalizado para la instancia, el suspender a todos los usuarios inactivos no respetó confiablemente dicho umbral. Para obtener más información sobre la inactividad, consulta la sección "[Administrar a los usuarios inactivos](/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users)". known_issues: - En una instancia recién configurada de {% data variables.product.prodname_ghe_server %} sin ningún usuario, un atacante podría crear el primer usuario adminsitrador. - Las reglas de cortafuegos personalizadas se eliminan durante el proceso de actualización. diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-2/18.yml b/translations/es-ES/data/release-notes/enterprise-server/3-2/18.yml new file mode 100644 index 000000000000..3f5d1e9bc5df --- /dev/null +++ b/translations/es-ES/data/release-notes/enterprise-server/3-2/18.yml @@ -0,0 +1,16 @@ +date: '2022-08-30' +sections: + bugs: + - Duplicate administrative SSH keys could appear in both the Management Console and the `/home/admin/.ssh/authorized_keys` file. + - In some cases, background tasks could stall due to a library that was used concurrently despite not being thread-safe. + changes: + - Generation of support bundles is faster as a result of parallelized log sanitization. For more information about support bundles, see "[Providing data to GitHub Support](/support/contacting-github-support/providing-data-to-github-support)." + known_issues: + - En una instancia recién configurada de {% data variables.product.prodname_ghe_server %} sin ningún usuario, un atacante podría crear el primer usuario adminsitrador. + - Las reglas de cortafuegos personalizadas se eliminan durante el proceso de actualización. + - Los archivos rastreados del LFS de Git que se [cargaron mediante la interface web](https://github.com/blog/2105-upload-files-to-your-repositories) se agregaron incorrecta y directamente al repositorio. + - Las propuestas no pudieron cerrarse si contenían un permalink a un blob en el mismo repositorio en donde la ruta de archvio del blob era más grande a 255 caracteres. + - Cuando se habilita la opción "Los usuarios pueden buscar en GitHub.com" con las propuestas de {% data variables.product.prodname_github_connect %}, las propuestas en los repositorios internos y privados no se incluyen en los resultados de búsqueda de {% data variables.product.prodname_dotcom_the_website %}. + - El registor de npm del {% data variables.product.prodname_registry %} ya no regresa un valor de tiempo en las respuestas de metadatos. Esto se hizo para permitir mejoras de rendimiento sustanciales. Seguimos teniendo todos los datos necesarios para devolver un valor de tiempo como parte de la respuesta de metadatos y terminaremos de devolver este valor ene l futuro una vez que hayamos resuelto los problemas de rendimiento existentes. + - Los límites de recursos que son específicos para procesar ganchos de pre-recepción podrían ocasionar que fallen algunos ganchos de pre-recepción. + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-3/12.yml b/translations/es-ES/data/release-notes/enterprise-server/3-3/12.yml index 06cfe6183080..caafc57aab49 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-3/12.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-3/12.yml @@ -6,9 +6,9 @@ sections: - | **ALTA**: Las aplicaciones instaladas anteriormente en las cuentas de usuario obtuvieron permiso automáticamente para acceder a una organización en los tokens de acceso en el alcance después de que la cuenta de usuario se transformó en una cuenta de organización. Esta vulnerabilidad se reportó a través del [Programa de Recompensas por Errores de GitHub](https://bounty.github.com). bugs: - - When a custom dormancy threshold was set for the instance, suspending all dormant users did not reliably respect the threshold. For more information about dormancy, see "[Managing dormant users](/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users)." + - Cuando se configuró un umbral de inactividad personalizado para la instancia, el suspender a todos los usuarios inactivos no respetó confiablemente dicho umbral. Para obtener más información sobre la inactividad, consulta la sección "[Administrar a los usuarios inactivos](/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users)". changes: - - 'The enterprise audit log now includes more user-generated events, such as `project.create`. The REST API also returns additional user-generated events, such as `repo.create`. For more information, see "[Accessing the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)" and "[Using the audit log API for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise#querying-the-audit-log-rest-api)."' + - 'La bitácora de auditoría ahora incluye más eventos generados por los usuarios, tal como `project.create`. La API de REST también devuelve eventos generados por el usuario, tal como `repo.create`. Para obtener más información, consulta las secciones "[Acceder a la bitácora de auditoría de tu empresa](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)" y "[Utilizar la API de bitácora de auditoría para tu empresa](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise#querying-the-audit-log-rest-api)".' known_issues: - Después de haber actualizado a {% data variables.product.prodname_ghe_server %} 3.3, podría que las {% data variables.product.prodname_actions %} no inicien automáticamente. Para resolver este problema, conéctate al aplicativo a través de SSH y ejecuta el comando `ghe-actions-start`. - En una instancia recién configurada de {% data variables.product.prodname_ghe_server %} sin ningún usuario, un atacante podría crear el primer usuario adminsitrador. diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-3/13.yml b/translations/es-ES/data/release-notes/enterprise-server/3-3/13.yml new file mode 100644 index 000000000000..66730dd55184 --- /dev/null +++ b/translations/es-ES/data/release-notes/enterprise-server/3-3/13.yml @@ -0,0 +1,23 @@ +date: '2022-08-30' +sections: + bugs: + - After unlocking a repository for temporary access, a site administrator was unable to manage settings for security products in the repository. + - Duplicate administrative SSH keys could appear in both the Management Console and the `/home/admin/.ssh/authorized_keys` file. + - In some cases, running `ghe-cluster-config-apply` could replicate an empty configuration to existing nodes in a cluster. + - In some cases, configuration runs started with `ghe-config-apply` did not complete, or returned a `Container count mismatch` error. + - After updating a self-signed TLS certificate on a GitHub Enterprise Server instance, UI elements on some pages in the web interface did not appear. + - In some cases, background tasks could stall due to a library that was used concurrently despite not being thread-safe. + changes: + - Generation of support bundles is faster as a result of parallelized log sanitization. For more information about support bundles, see "[Providing data to GitHub Support](/support/contacting-github-support/providing-data-to-github-support)." + - 'La bitácora de auditoría ahora incluye más eventos generados por los usuarios, tal como `project.create`. La API de REST también devuelve eventos generados por el usuario, tal como `repo.create`. Para obtener más información, consulta las secciones "[Acceder a la bitácora de auditoría de tu empresa](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)" y "[Utilizar la API de bitácora de auditoría para tu empresa](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise#querying-the-audit-log-rest-api)".' + known_issues: + - Después de haber actualizado a {% data variables.product.prodname_ghe_server %} 3.3, podría que las {% data variables.product.prodname_actions %} no inicien automáticamente. Para resolver este problema, conéctate al aplicativo a través de SSH y ejecuta el comando `ghe-actions-start`. + - En una instancia recién configurada de {% data variables.product.prodname_ghe_server %} sin ningún usuario, un atacante podría crear el primer usuario adminsitrador. + - Las reglas de cortafuegos personalizadas se eliminan durante el proceso de actualización. + - Los archivos rastreados del LFS de Git que se [cargaron mediante la interface web](https://github.com/blog/2105-upload-files-to-your-repositories) se agregaron incorrecta y directamente al repositorio. + - Las propuestas no pudieron cerrarse si contenían un permalink a un blob en el mismo repositorio en donde la ruta de archvio del blob era más grande a 255 caracteres. + - Cuando se habilita la opción "Los usuarios pueden buscar en GitHub.com" con las propuestas de {% data variables.product.prodname_github_connect %}, las propuestas en los repositorios internos y privados no se incluyen en los resultados de búsqueda de {% data variables.product.prodname_dotcom_the_website %}. + - El registor de npm del {% data variables.product.prodname_registry %} ya no regresa un valor de tiempo en las respuestas de metadatos. Esto se hizo para permitir mejoras de rendimiento sustanciales. Seguimos teniendo todos los datos necesarios para devolver un valor de tiempo como parte de la respuesta de metadatos y terminaremos de devolver este valor ene l futuro una vez que hayamos resuelto los problemas de rendimiento existentes. + - Los límites de recursos que son específicos para procesar ganchos de pre-recepción podrían ocasionar que fallen algunos ganchos de pre-recepción. + - 'Los ajustes de almacenamiento de {% data variables.product.prodname_actions %} no pueden validarse y guardarse en la {% data variables.enterprise.management_console %} cuando se selecciona "Forzar estilo de ruta" y, en su lugar, debe configurarse la utilidad de línea de comando `ghe-actions-precheck`.' + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-3/7.yml b/translations/es-ES/data/release-notes/enterprise-server/3-3/7.yml index d4118e7d0d19..c015a2080886 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-3/7.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-3/7.yml @@ -9,10 +9,10 @@ sections: - 'Se acumularon los archivos de bitácora rotados con la extensión `.backup` enlos directorios que contenían bitácoras de sistema.' - 'En algunas topologías de clúster, no pudieron ejecutarse las utilidades de línea de comandos `ghe-spokesctl` y `ghe-btop`.' - 'Los índices de Elastisearch podrían duplicarse durante la mejora de un paquete debido a que el servicio de `elasticsearch-upgrade` se ejecutó varias veces en paralelo.' - - 'In the pull request and commit views, rich diffs would fail to load for some files tracked by Git LFS.' + - 'En las vistas de confirmación y solicitud de cambios, las diferencias enriquecidas no pudieron cargar para algunos archivos rastreados por Git LFS.' - 'Cuando conviertes una cuenta de usuario en una organización, si dicha cuenta fue propietaria de la cuenta empresarial de {% data variables.product.prodname_ghe_server %}, la organización convertida se mostró incorrectamente en la lista de propietarios de la empresa.' - 'El crear un token de OAuth de personificación utilizando la API de REST de administración de empresas dio como resultado un error cuando una integración que coincidió con la ID de aplicación de OAuth ya existía.' - - 'The Secret Scanning REST API would return a `500` response code when there were UTF8 characters present in a detected secret.' + - 'La API de REST del escaneo de secretos devolvió un código de respuesta `500` cuando hubo caracteres UTF8 presentes en un secreto detectado.' - 'Los servidores de caché del repositorio pudieron servir datos de ubicaciones fuera del caché, incluso cuando los datos estuvieron disponibles en la ubicación del caché local.' changes: - 'Los errores de configuración que detienen una ejecución de aplicación de configuraciones ahora son el producto de la terminal adicionalmente a la bitácora de configuración.' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-4/2.yml b/translations/es-ES/data/release-notes/enterprise-server/3-4/2.yml index 0e7becdeaf60..3e02d47236d4 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-4/2.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-4/2.yml @@ -11,10 +11,10 @@ sections: - 'Los índices de Elastisearch podrían duplicarse durante la mejora de un paquete debido a que el servicio de `elasticsearch-upgrade` se ejecutó varias veces en paralelo.' - 'Los servidores de caché del repositorio pudieron servir datos de ubicaciones fuera del caché, incluso cuando los datos estuvieron disponibles en la ubicación del caché local.' - 'Cuando conviertes una cuenta de usuario en una organización, si dicha cuenta fue propietaria de la cuenta empresarial de {% data variables.product.prodname_ghe_server %}, la organización convertida se mostró incorrectamente en la lista de propietarios de la empresa.' - - 'The `/stafftools/users/ip_addresses/:address` page responded with a `500 Internal Server Error` when attempting to display the page for an IPv6 address.' + - 'La página `/stafftools/users/ip_addresses/:address` respondió con un `500 Internal Server Error` cuando se intentó mostrar la página para una dirección IPv6.' - 'El crear un token de OAuth de personificación utilizando la API de REST de administración de empresas dio como resultado un error cuando una integración que coincidió con la ID de aplicación de OAuth ya existía.' changes: - - 'Added support for replica domain names that are more than 63 characters.' + - 'Se agregó compatibilidad para los nombres de dominio de réplica que tienen más de 63 caracteres.' - 'Los errores de configuración que detienen una ejecución de aplicación de configuraciones ahora son el producto de la terminal adicionalmente a la bitácora de configuración.' - 'Si se habilitaron las características de {% data variables.product.prodname_GH_advanced_security %} en tu instancia, el rendimiento de los jobs en segundo plano mejoró al procesar los lotes para las contribuciones de repositorio.' known_issues: diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-4/7.yml b/translations/es-ES/data/release-notes/enterprise-server/3-4/7.yml index e5aee4aba312..cd5d3665fa26 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-4/7.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-4/7.yml @@ -8,7 +8,7 @@ sections: bugs: - In some cases, GitHub Enterprise Server instances on AWS that used the `r4.4xlarge` instance type would fail to boot. - 'When calculating committers for GitHub Advanced Security, it was not possible to specify individual repositories. For more information, see "[Site admin dashboard](/admin/configuration/configuring-your-enterprise/site-admin-dashboard#advanced-security-committers)."' - - When a custom dormancy threshold was set for the instance, suspending all dormant users did not reliably respect the threshold. For more information about dormancy, see "[Managing dormant users](/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users)." + - Cuando se configuró un umbral de inactividad personalizado para la instancia, el suspender a todos los usuarios inactivos no respetó confiablemente dicho umbral. Para obtener más información sobre la inactividad, consulta la sección "[Administrar a los usuarios inactivos](/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users)". changes: - '`pre_receive_hook.rejected_push` events were not displayed in the enterprise audit log.' - Both migration archives for repositories and archive exports for user accounts include release reactions. diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-4/8.yml b/translations/es-ES/data/release-notes/enterprise-server/3-4/8.yml new file mode 100644 index 000000000000..a6dcaaaa4579 --- /dev/null +++ b/translations/es-ES/data/release-notes/enterprise-server/3-4/8.yml @@ -0,0 +1,26 @@ +date: '2022-08-30' +sections: + bugs: + - After unlocking a repository for temporary access, a site administrator was unable to manage settings for security products in the repository. + - Duplicate administrative SSH keys could appear in both the Management Console and the `/home/admin/.ssh/authorized_keys` file. + - The site admin page for individual users at http(s)://HOSTNAME/stafftools/users/USERNAME/admin contained functionality not intended for GitHub Enterprise Server. + - In some cases, running `ghe-cluster-config-apply` could replicate an empty configuration to existing nodes in a cluster. + - In some cases, configuration runs started with `ghe-config-apply` did not complete, or returned a `Container count mismatch` error. + - After updating a self-signed TLS certificate on a GitHub Enterprise Server instance, UI elements on some pages in the web interface did not appear. + - In some cases, background tasks could stall due to a library that was used concurrently despite not being thread-safe. + changes: + - Generation of support bundles is faster as a result of parallelized log sanitization. For more information about support bundles, see "[Providing data to GitHub Support](/support/contacting-github-support/providing-data-to-github-support)." + - APIs that contain the `organization` or `org` route now accept either the organization's slug or ID. Previously, the APIs only accepted slugs, which caused `Link` headers for GitHub Advanced Security endpoints to be inaccessible. For more information, see "[Organizations](https://docs.github.com/rest/orgs/orgs)" in the REST API documentation. + - 'La bitácora de auditoría ahora incluye más eventos generados por los usuarios, tal como `project.create`. La API de REST también devuelve eventos generados por el usuario, tal como `repo.create`. Para obtener más información, consulta las secciones "[Acceder a la bitácora de auditoría de tu empresa](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)" y "[Utilizar la API de bitácora de auditoría para tu empresa](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise#querying-the-audit-log-rest-api)".' + known_issues: + - En una instancia recién configurada de {% data variables.product.prodname_ghe_server %} sin ningún usuario, un atacante podría crear el primer usuario adminsitrador. + - Las reglas de cortafuegos personalizadas se eliminan durante el proceso de actualización. + - Los archivos rastreados del LFS de Git que se [cargaron mediante la interface web](https://github.com/blog/2105-upload-files-to-your-repositories) se agregaron incorrecta y directamente al repositorio. + - Las propuestas no pudieron cerrarse si contenían un permalink a un blob en el mismo repositorio en donde la ruta de archvio del blob era más grande a 255 caracteres. + - Cuando se habilita la opción "Los usuarios pueden buscar en GitHub.com" con las propuestas de {% data variables.product.prodname_github_connect %}, las propuestas en los repositorios internos y privados no se incluyen en los resultados de búsqueda de {% data variables.product.prodname_dotcom_the_website %}. + - El registor de npm del {% data variables.product.prodname_registry %} ya no regresa un valor de tiempo en las respuestas de metadatos. Esto se hizo para permitir mejoras de rendimiento sustanciales. Seguimos teniendo todos los datos necesarios para devolver un valor de tiempo como parte de la respuesta de metadatos y terminaremos de devolver este valor ene l futuro una vez que hayamos resuelto los problemas de rendimiento existentes. + - Los límites de recursos que son específicos para procesar ganchos de pre-recepción podrían ocasionar que fallen algunos ganchos de pre-recepción. + - | + Después de registrar un ejecutor auto-hospedado con el parámetro `--ephemeral` en más de un nivel (por ejemplo, tanto en la empresa como en la organización), el ejecutor podría atorarse en un estado inactivo y requerir un nuevo registro. [Actualizado: 2022-06-17] + - Después de mejorar a {% data variables.product.prodname_ghe_server %} 3.4, podría parecer que los lanzamientos no están en los repositorios. Esto puede ocurrir cuando las migraciones de índice de Elasticsearch requeridas no se han completado exitosamente. + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-5/0.yml b/translations/es-ES/data/release-notes/enterprise-server/3-5/0.yml index d5d30923ba32..7ffe59353b36 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-5/0.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-5/0.yml @@ -200,8 +200,8 @@ sections: heading: Volver a abrir las alertas descartadas del Dependabot notes: - | - You can now reopen dismissed Dependabot alerts through the UI page for a closed alert. This does not affect Dependabot pull requests or the GraphQL API. For more information, see "[About Dependabot alerts](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - - **Note**: This feature was unavailable in GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2, and 3.5.3. The feature is available in 3.5.4 and later. [Updated: 2022-08-16] + Ahora puedes volver a abrir las alertas del Dependabot que se descartaron mediante la página de IU en el caso de las alertas cerradas. Esto no afecta a las solicitudes de cambio ni a la API de GraphQL. Para obtener más información, consulta la sección "[Acerca de las alertas del Dependabot](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)". + - **Nota**: Esta característica no estuvo disponible en GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2 y 3.5.3. La característica está disponible en la versión 3.5.4 y posteriores. [Actualizado: 2022-08-16] - heading: La compatibilidad de Pub para las actualizaciones de versión del Dependabot se encuentra en beta público notes: @@ -261,12 +261,12 @@ sections: heading: Más formas de mantener actualizada la rama de tema de una solicitud de cambios notes: - | - The **Update branch** button on the pull request page lets you update your pull request's branch with the latest changes from the base branch. This is useful for verifying your changes are compatible with the current version of the base branch before you merge. Two enhancements now give you more ways to keep your branch up-to-date. + El botón de **Rama actualizada* en la página de la solicitud de cambios te permite actualizar la rama de esta solicitud con los últimos cambios de la rama base. Esto es útil para verificar que tus cambios sean compatibles con la versión actual de la rama base antes de que hagas la fusión. Estas dos mejoras ahora te proporcionan más formas de mantener tu rama actualizada. - - When your pull request's topic branch is out of date with the base branch, you now have the option to update it by rebasing on the latest version of the base branch. Rebasing applies the changes from your branch onto the latest version of the base branch, resulting in a branch with a linear history since no merge commit is created. To update by rebasing, click the drop down menu next to the **Update Branch** button, click **Update with rebase**, and then click **Rebase branch**. Previously, **Update branch** performed a traditional merge that always resulted in a merge commit in your pull request branch. This option is still available, but now you have the choice. For more information, see "[Keeping your pull request in sync with the base branch](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/keeping-your-pull-request-in-sync-with-the-base-branch)." + - Cuando la rama de tema de tu solicitud de cambios está desactualizada con la rama base, ahora tienes la opción de actualizarla rebasándola en la versión más reciente de la rama base. El rebase aplica los cambios de tu rama en la última versión de la rama base, lo que da como resultado una rama con un historial linear, ya que no se crea ninguna confirmación de fusión. Para actualizar por rebase, haz clic en el menú desplegable junto al botón**Actualizar rama**, luego en **Actualizar con rebase** y luego en *Rebasar rama*. Anteriormente, **Actualizar rama** realizaba una fusión tradicional que siembre daba como resultado una confirmación de fusión en la rama de tu solicitud de cambios. Esta opción aún está disponible, pero ahora tienes una elección. Para obtener más información, consulta la sección "[Mantener tu solicitud de cambios sincronizada con la rama base](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/keeping-your-pull-request-in-sync-with-the-base-branch)". - - A new repository setting allows the **Update branch** button to always be available when a pull request's topic branch is not up to date with the base branch. Previously, this button was only available when the **Require branches to be up to date before merging** branch protection setting was enabled. People with admin or maintainer access can manage the **Always suggest updating pull request branches** setting from the **Pull Requests** section in repository settings. For more information, see "[Managing suggestions to update pull request branches](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-suggestions-to-update-pull-request-branches)." - - **Note**: This feature was unavailable in GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2, and 3.5.3. The feature is available in 3.5.4 and later. [Updated: 2022-08-16] + - Un ajuste nuevo de repositorio permite que el botón **Actualizar rama** siempre esté disponible cuando la rama de tema de una solicitud de cambios no esté actualizada con la rama base. Anteriormente, este botón solo estaba disponible cuando estaba habilitado el ajuste de protección de rama **Requerir que las ramas estén actualizadas antes de fusionarlas**. Las personas con acceso de mantenedor o administrador pueden administrar el ajuste de **Siempre sugerir actualizar las ramas de solicitudes de cambios** de la sección **Solicitudes de cambios* en los ajustes de repositorio. Para obtener más información, consulta la sección "[Administrar sugerencias para actualizar las ramas de las solicitudes de cambios](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-suggestions-to-update-pull-request-branches)". + - **Nota**: Esta característica no estuvo disponible en GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2 y 3.5.3. La característica está disponible en la versión 3.5.4 y posterior. [Actualizado: 2022-08-16] - heading: Configurar los encabezados personalizados de HTTP para los sitios de GitHub Pages notes: @@ -281,8 +281,8 @@ sections: heading: El tema claro de contraste alto está disponible en general notes: - | - A light high contrast theme, with greater contrast between foreground and background elements, is now generally available. For more information, see "[Managing your theme settings](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-theme-settings)." - - **Note**: This feature was unavailable in GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2, and 3.5.3. The feature is available in 3.5.4 and later. [Updated: 2022-08-16] + Ahora hay un tema claro de alto contraste disponible para el público en general, el cual tiene un mayor contraste entre los elementos de fondo y superpuestos. Para obtener más información, consulta la sección "[Administrar los ajustes de tu tema](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-theme-settings)". + - **Note**: Esta característica no estuvo disponible en GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2 y 3.5.3. La característica está disponible en la versión 3.5.4 y posterior. [Actualizado: 2022-08-16] - heading: Reglas de protección de etiquetas notes: @@ -351,10 +351,10 @@ sections: - 'Deleted repositories will not be purged from disk automatically after the 90-day retention period ends. This issue is resolved in the 3.5.1 patch release. [Updated: 2022-06-10]' - 'La consola de administración podría haberse mostrado atascada en la pantalla de _Starting_ después de mejorar una instancia subaprovisionada para GitHub Enterprise Server 3.5. [Actualizado: 2022-06-20]' - | - The following features were unavailable for users in GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2, and 3.5.3. The features are available in 3.5.4 and later. [Updated: 2022-08-16] + Las siguientes características no estuvieron disponibles para los usuarios en GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2 y 3.5.3. Las características están disponibles en la versión 2.5.4 y posterior. [Actualizado: 2022-08-16] - - Detection of GitHub Actions workflow files for the dependency graph - - Reopening of dismissed Dependabot alerts - - Enabling the **Update branch** button for all pull requests in a repository - - Light high contrast theme + - Detección de archivos de flujo de GitHub Actions para la gráfica de dependencias + - Reapertura de las alertas descartadas del Dependabot + - Habilitar el botón **Actualizar rama** para todas las solicitudes de cambio en un repositorio + - Tema claro de alto contraste - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-5/1.yml b/translations/es-ES/data/release-notes/enterprise-server/3-5/1.yml index 59535991ee6c..a9f689542303 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-5/1.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-5/1.yml @@ -32,10 +32,10 @@ sections: - 'Los repositorios borrados no se purgarán del disco automáticamente después de que finalice el periodo de retención de 90 días. Esta propuesta se resolvió en el lanzamiento 3.5.1. [Actualizado: 2022-06-10]' - 'La consola de administración podría haberse mostrado atascada en la pantalla de _Starting_ después de mejorar una instancia subaprovisionada para GitHub Enterprise Server 3.5. [Actualizado: 2022-06-20]' - | - The following features were unavailable for users in GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2, and 3.5.3. The features are available in 3.5.4 and later. [Updated: 2022-08-16] + Las siguientes características no estuvieron disponibles para los usuarios en GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2 y 3.5.3. Las características están disponibles en la versión 2.5.4 y posterior. [Actualizado: 2022-08-16] - - Detection of GitHub Actions workflow files for the dependency graph - - Reopening of dismissed Dependabot alerts - - Enabling the **Update branch** button for all pull requests in a repository - - Light high contrast theme + - Detección de archivos de flujo de GitHub Actions para la gráfica de dependencias + - Reapertura de las alertas descartadas del Dependabot + - Habilitar el botón **Actualizar rama** para todas las solicitudes de cambio en un repositorio + - Tema claro de alto contraste - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-5/2.yml b/translations/es-ES/data/release-notes/enterprise-server/3-5/2.yml index a9b35aafaeb5..206837c08fe3 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-5/2.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-5/2.yml @@ -33,10 +33,10 @@ sections: - Los límites de recursos que son específicos para procesar ganchos de pre-recepción podrían ocasionar que fallen algunos ganchos de pre-recepción. - Los servicios de las acciones necesitan reiniciarse después de restablecer un aplicativo de un respaldo que se llevó a un host diferente. - | - The following features were unavailable for users in GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2, and 3.5.3. The features are available in 3.5.4 and later. [Updated: 2022-08-16] + Las siguientes características no estuvieron disponibles para los usuarios en GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2 y 3.5.3. Las características están disponibles en la versión 3.5.4 y posteriores. [Actualizado: 2022-08-16] - - Detection of GitHub Actions workflow files for the dependency graph - - Reopening of dismissed Dependabot alerts - - Enabling the **Update branch** button for all pull requests in a repository - - Light high contrast theme + - Detección de archivos del flujo de trabajo de GitHub Actions para la gráfica de dependencias + - Reapertura de alertas descartadas del Dependabot + - Habilitar el botón de *Rama actualizada** para todas las solicitudes de cambio en un repositorio + - Tema claro de alto contraste - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-5/3.yml b/translations/es-ES/data/release-notes/enterprise-server/3-5/3.yml index 962af1fb115c..08c43001b33a 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-5/3.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-5/3.yml @@ -30,5 +30,5 @@ sections: - 'El registor de npm del {% data variables.product.prodname_registry %} ya no regresa un valor de tiempo en las respuestas de metadatos. Esto se hizo para permitir mejoras de rendimiento sustanciales. Seguimos teniendo todos los datos necesarios para devolver un valor de tiempo como parte de la respuesta de metadatos y terminaremos de devolver este valor ene l futuro una vez que hayamos resuelto los problemas de rendimiento existentes.' - 'Los límites de recursos que son específicos para procesar ganchos de pre-recepción podrían ocasionar que fallen algunos ganchos de pre-recepción.' - 'Los servicios de las acciones necesitan reiniciarse después de restablecer un aplicativo de un respaldo que se llevó a un host diferente.' - - "The following features were unavailable for users in GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2, and 3.5.3. The features are available in 3.5.4 and later. [Updated: 2022-08-16]\n\n- Detection of GitHub Actions workflow files for the dependency graph\n- Reopening of dismissed Dependabot alerts\n- Enabling the **Update branch** button for all pull requests in a repository\n- Light high contrast theme\n" + - "Las siguientes características no estuvieron disponibles para los usuarios en GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2 y 3.5.3. Las características están disponibles en la versión 2.5.4 y posterior. [Actualizado: 2022-08-16]\n\n- Detección de archivos de flujo de GitHub Actions para la gráfica de dependencias\n- Reapertura de las alertas descartadas del Dependabot\n- Habilitar el botón **Actualizar rama** para todas las solicitudes de cambio en un repositorio\n- Tema claro de alto contraste\n" - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-5/4.yml b/translations/es-ES/data/release-notes/enterprise-server/3-5/4.yml index 03b028709f03..b91d5e3a57e2 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-5/4.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-5/4.yml @@ -2,9 +2,9 @@ date: '2022-08-11' sections: security_fixes: - | - **CRITICAL**: GitHub Enterprise Server's Elasticsearch container used a version of OpenJDK 8 that was vulnerable to an integer truncation issue when processing malicious XSLT stylesheets. The vulnerability is tracked as [CVE-2022-34169](https://github.com/advisories/GHSA-9339-86wc-4qgf). + **CRÍTICA**: El contenedor de Elasticsearch de GitHub Enterprise Server utilizó una versión de OpenJDK 8 que estuvo vulnerable a un problema de truncamiento de número al procesar hojas de estilo de XSLT malintencionadas. La vulnerabilidad se rastreó como [CVE-2022-34169](https://github.com/advisories/GHSA-9339-86wc-4qgf). - | - **HIGH**: Previously installed apps on user accounts were automatically granted permission to access an organization on scoped access tokens after the user account was transformed into an organization account. This vulnerability was reported via the [GitHub Bug Bounty program](https://bounty.github.com). + **ALTA**: Las aplicaciones instaladas anteriormente en las cuentas de usuario obtuvieron permiso automáticamente para acceder a una organización en los tokens de acceso en el alcance después de que la cuenta de usuario se transformó en una cuenta de organización. Esta vulnerabilidad se reportó a través del [Programa de Recompensas por Errores de GitHub](https://bounty.github.com). bugs: - In some cases, GitHub Enterprise Server instances on AWS that used the `r4.4xlarge` instance type would fail to boot. - In some cases, UI elements within a pull request's **Files changed** tab could overlap. @@ -12,10 +12,10 @@ sections: - 'When calculating committers for GitHub Advanced Security, it was not possible to specify individual repositories. For more information, see "[Site admin dashboard](/admin/configuration/configuring-your-enterprise/site-admin-dashboard#advanced-security-committers)."' - In some cases, Elasticsearch's post-upgrade `es:upgrade` process could crash before completion. - The script for migration to internal repositories failed to convert the visibility for public repositories to internal or private. For more information about the migration, see "[Migrating to internal repositories](/admin/user-management/managing-repositories-in-your-enterprise/migrating-to-internal-repositories)." - - 'Detection of GitHub Actions workflow files for the dependency graph was unavailable in GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2, and 3.5.3, but is now available in 3.5.4. For more information, see "[About the dependency graph](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph#supported-package-ecosystems)."' - - 'The ability to reopen dismissed Dependabot alerts was unavailable in GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2, and 3.5.3, but is now available in 3.5.4. For more information, see "[Viewing and updating Dependabot alerts](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts#viewing-and-updating-closed-alerts)."' - - The ability to always suggest updates from the base branch to a pull request's HEAD was unavailable in GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2, and 3.5.3, but is now available in 3.5.4. For more information, see "[Managing suggestions to update pull request branches](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-suggestions-to-update-pull-request-branches)." - - The light high contrast theme was unavailable in GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2, and 3.5.3, but is now available in 3.5.4. For more information, see "[Managing your theme settings](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-theme-settings)." + - 'La detección de archivos de flujo de trabajo de GitHub Actions para la gráfica de dependencias no estuvo disponible en GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2 y 3.5.3, pero están ahora disponibles en la versión 3.5.4. Para obtener más información, consulta la sección "[Acerca de la gráfica de dependencias](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph#supported-package-ecosystems)".' + - 'La capacidad de reabrir alertas descartadas del Depedabot no estaba disponible en GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2 y 3.5.3, pero ahora está disponible en la versión 3.5.4. Para obtener más información, consulta la sección "[Ver y actualizar las alertas del Dependabot](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts#viewing-and-updating-closed-alerts)".' + - La capacidad de siempre sugerir actualizaciones desde la rama base hacia un ENCABEZADO de una solicitud de cambios no estaba disponible en GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2 y 3.5.3, pero está ahora disponible en la versión 3.5.4. Para obtener más información, consulta la sección "[Administrar las sugerencias para actualizar las ramas de las solicitudes de cambios](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-suggestions-to-update-pull-request-branches)". + - El tema claro de alto contraste no estuvo disponible en GitHub Enterprise Server 3.5.0, 3.5.1, 3.5.2 y 3.5.3, pero ahora está disponible en la versión 3.5.4. Para obtener más información, consulta la sección "[Administrar los ajustes de tu tema](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-theme-settings)". changes: - '`pre_receive_hook.rejected_push` events were not displayed in the enterprise audit log.' known_issues: diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-5/5.yml b/translations/es-ES/data/release-notes/enterprise-server/3-5/5.yml new file mode 100644 index 000000000000..93e1bf5ac4af --- /dev/null +++ b/translations/es-ES/data/release-notes/enterprise-server/3-5/5.yml @@ -0,0 +1,27 @@ +date: '2022-08-30' +sections: + bugs: + - After unlocking a repository for temporary access, a site administrator was unable to manage settings for security products in the repository. + - Duplicate administrative SSH keys could appear in both the Management Console and the `/home/admin/.ssh/authorized_keys` file. + - The site admin page for individual users at http(s)://HOSTNAME/stafftools/users/USERNAME/admin contained functionality not intended for GitHub Enterprise Server. + - In some cases, running `ghe-cluster-config-apply` could replicate an empty configuration to existing nodes in a cluster. + - In some cases, configuration runs started with `ghe-config-apply` did not complete, or returned a `Container count mismatch` error. + - After updating a self-signed TLS certificate on a GitHub Enterprise Server instance, UI elements on some pages in the web interface did not appear. + - The site admin bar at the top of the web interface contained a broken link to the SHA for the currently running version of the application. + - In some cases, background tasks could stall due to a library that was used concurrently despite not being thread-safe. + - Alerts from secret scanning for GitHub Advanced Security customers were missing in the web UI and REST API if a site administrator did not upgrade directly to GitHub Enterprise Server 3.4. The alerts are now visible. + - When a user forked a repository into an organization, a long list of organizations would not render properly. + changes: + - Generation of support bundles is faster as a result of parallelized log sanitization. For more information about support bundles, see "[Providing data to GitHub Support](/support/contacting-github-support/providing-data-to-github-support)." + - APIs that contain the `organization` or `org` route now accept either the organization's slug or ID. Previously, the APIs only accepted slugs, which caused `Link` headers for GitHub Advanced Security endpoints to be inaccessible. For more information, see "[Organizations](https://docs.github.com/rest/orgs/orgs)" in the REST API documentation. + - 'La bitácora de auditoría ahora incluye más eventos generados por los usuarios, tal como `project.create`. La API de REST también devuelve eventos generados por el usuario, tal como `repo.create`. Para obtener más información, consulta las secciones "[Acceder a la bitácora de auditoría de tu empresa](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)" y "[Utilizar la API de bitácora de auditoría para tu empresa](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise#querying-the-audit-log-rest-api)".' + - In some cases, cache replicas could reject some Git operations on recently updated repositories. For more information about repository caching, see "[About repository caching](/admin/enterprise-management/caching-repositories/about-repository-caching)." + known_issues: + - En una instancia recién configurada de {% data variables.product.prodname_ghe_server %} sin ningún usuario, un atacante podría crear el primer usuario adminsitrador. + - Las reglas de cortafuegos personalizadas se eliminan durante el proceso de actualización. + - Los archivos rastreados del LFS de Git que se [cargaron mediante la interface web](https://github.com/blog/2105-upload-files-to-your-repositories) se agregaron incorrecta y directamente al repositorio. + - Las propuestas no pudieron cerrarse si contenían un permalink a un blob en el mismo repositorio en donde la ruta de archvio del blob era más grande a 255 caracteres. + - Cuando se habilita "Los usuarios pueden buscar en GitHub.com" con GitHub Connect, las propuestas en los repositorios privados e internos no se incluirán en los resultados de búsqueda de GitHub.com. + - El registor de npm del {% data variables.product.prodname_registry %} ya no regresa un valor de tiempo en las respuestas de metadatos. Esto se hizo para permitir mejoras de rendimiento sustanciales. Seguimos teniendo todos los datos necesarios para devolver un valor de tiempo como parte de la respuesta de metadatos y terminaremos de devolver este valor ene l futuro una vez que hayamos resuelto los problemas de rendimiento existentes. + - Los límites de recursos que son específicos para procesar ganchos de pre-recepción podrían ocasionar que fallen algunos ganchos de pre-recepción. + - Los servicios de las acciones necesitan reiniciarse después de restablecer un aplicativo de un respaldo que se llevó a un host diferente. diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-6/0.yml b/translations/es-ES/data/release-notes/enterprise-server/3-6/0.yml index 31eb9186e877..253a21cc89cc 100644 --- a/translations/es-ES/data/release-notes/enterprise-server/3-6/0.yml +++ b/translations/es-ES/data/release-notes/enterprise-server/3-6/0.yml @@ -25,7 +25,9 @@ sections: - "[Requerir políticas de administración de repositorios en tu empresa](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)" - "[Configurar las llaves de host para tu instancia](/admin/configuration/configuring-your-enterprise/configuring-host-keys-for-your-instance)" - | - You can require TLS encryption for incoming SMTP connections to your instance. For more information, see "[Configuring email for notifications](/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications)." + You can require TLS encryption for incoming SMTP connections to your instance. For more information, see "[Configuring email for notifications](/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications#enforcing-tls-for-smtp-connections)." + + - **Note**: This feature is unavailable in GitHub Enterprise Server 3.6.0. The feature will be available in an upcoming release. [Updated: 2022-08-26] - heading: Registros de auditoría notes: @@ -40,7 +42,7 @@ sections: heading: Administrator experience notes: - | - Enterprise owners can join organizations on the instance as a member or owner from the enterprise account's **Organizations** page. For more information, see "[Managing your role in an organization owned by your enterprise](/admin/user-management/managing-organizations-in-your-enterprise/managing-your-role-in-an-organization-owned-by-your-enterprise)." + Los propietarios de las empresas pueden unirse a las organizaciones en la instancia como miembro o propietario desde la página de **Organizaciones* de la cuenta empresarial. Para obtener más información, consulta la sección "[Administrar tu rol en una organización que le pertenece a tu empresa](/admin/user-management/managing-organizations-in-your-enterprise/managing-your-role-in-an-organization-owned-by-your-enterprise)". - | Enterprise owners can allow users to dismiss the configured global announcement banner. For more information, see "[Customizing user messages for your enterprise](/admin/user-management/managing-users-in-your-enterprise/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner)." - @@ -150,12 +152,12 @@ sections: - | Los usuarios pueden bloquear la creación de ramas que coincide con un patrón de nombre configurado con la regla de protección de rama **Restringir subidas que crean ramas coincidentes**. Por ejemplo, si la rama predeterminada de un repositorio cambia de `master` a `main`, un administrador de repositorio puede prevenir cualquier creación o subida subsecuente de la rama `master`. Para obtener más información, consulta la sección "[Acerca de las ramas protegidas](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#restrict-who-can-push-to-matching-branches)" y "[Administrar una regla de protección de rama](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule#creating-a-branch-protection-rule)". - | - Users can create a branch directly from a repository's **Branches** page by clicking the **New branch**. For more information, see "[Creating and deleting branches within your repository](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)." + Los usuarios pueden crear una rama directamente desde la página de **Ramas** de un repositorio haciendo clic en **Rama nueva**. Para obtener más información, consulta la sección "[Crear y borrar ramas dentro de tu repositorio](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)". - | Users can delete a branch that's associated with an open pull request. For more information, see "[Creating and deleting branches within your repository](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)." - | - Repositories with multiple licenses display all of the licenses in the "About" sidebar on the {% octicon "code" aria-label="The code icon" %} **Code** tab. For more information, see "[Licensing a repository](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." - - When a user renames or moves a file to a new directory, if at least half of the file's contents are identical, the commit history indicates that the file was renamed, similar to `git log --follow`. For more information, see the [GitHub Blog](https://github.blog/changelog/2022-06-06-view-commit-history-across-file-renames-and-moves/). + Los repositorios con licencias múltiples muestran todas las licencias en la barra lateral de "Acerca de" en la pestaña de **Código** {% octicon "code" aria-label="The code icon" %}. Para obtener más información, consulta la sección "[Autorizar un repositorio](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)". + - Cuando un usuario renombra o mueve un archivo a un directorio nuevo, si por lo menos la mitad del contenido del archivo es idéntico, el historial de confirmación indican que el archivo se renombró, similar a `git log --follow`. Para obtener más información, consulta el [Blog de GitHub](https://github.blog/changelog/2022-06-06-view-commit-history-across-file-renames-and-moves/). - | Los usuarios pueden requerir un despliegue exitoso de una rama antes de que cualquiera pueda fusionar la solicitud de cambios asociada con ella. Para obtener más información, consulta las secciones "[Acerca de las ramas protegidas](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-deployments-to-succeed-before-merging)" y "[Administrar una regla de protección de rama](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule)". - | @@ -181,7 +183,7 @@ sections: notes: - | When viewing the details for a particular release, users can see the creation date for each release asset. For more information, see "[Viewing your repository's releases and tags](/repositories/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags)." - - While creating a release with automatically generated release notes, users can see the tag identified as the previous release, then choose to select a different tag to specify as the previous release. For more information, see "[Automatically generated release notes](/repositories/releasing-projects-on-github/automatically-generated-release-notes)." + - Cuando creas un lanzamiento con notas de lanzamiento generadas automáticamente, los usuarios pueden ver la etiqueta identificada como el lanzamiento anterior y luego elegir seleccionar una etiqueta diferente para especificar como el lanzamiento anterior. Para obtener más información, consulta la sección "[Notas de lanzamiento generadas automáticamente](/repositories/releasing-projects-on-github/automatically-generated-release-notes)". - heading: Markdown notes: @@ -210,3 +212,4 @@ sections: - In a repository's settings, enabling the option to allow users with read access to create discussions does not enable this functionality. - In some cases, users cannot convert existing issues to discussions. - Los patrones personalizados para el escaneo de secretos utilizan `.*` como un delimitador final, específicamente en el campo "Después del secreto". Este delimitador ocasiona inconsistencias en los escaneos que buscan secretos en los repositorios y podrías notar brechas en el historial de un repositorio en donde no hay escaneos completados. Los escaneos en aumento también podrían verse impactados. Para prevenir los problemas con los escaneos, modifica el final del patrón para eliminar el delimitador `.*`. + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/es-ES/data/release-notes/enterprise-server/3-6/1.yml b/translations/es-ES/data/release-notes/enterprise-server/3-6/1.yml new file mode 100644 index 000000000000..1fd058621ecf --- /dev/null +++ b/translations/es-ES/data/release-notes/enterprise-server/3-6/1.yml @@ -0,0 +1,33 @@ +date: '2022-08-30' +sections: + bugs: + - After unlocking a repository for temporary access, a site administrator was unable to manage settings for security products in the repository. + - Duplicate administrative SSH keys could appear in both the Management Console and the `/home/admin/.ssh/authorized_keys` file. + - The site admin page for individual users at http(s)://HOSTNAME/stafftools/users/USERNAME/admin contained functionality not intended for GitHub Enterprise Server. + - In some cases, running `ghe-cluster-config-apply` could replicate an empty configuration to existing nodes in a cluster. + - In some cases, configuration runs started with `ghe-config-apply` did not complete, or returned a `Container count mismatch` error. + - After updating a self-signed TLS certificate on a GitHub Enterprise Server instance, UI elements on some pages in the web interface did not appear. + - In some cases, background tasks could stall due to a library that was used concurrently despite not being thread-safe. + - The site admin bar at the top of the web interface contained a broken link to the SHA for the currently running version of the application. + - Organization owners were unable to set the level of access required to create discussions. + - Discussions users were incorrectly directed to the community guidelines for GitHub.com. + - In some cases, users were incorrectly instructed to verify their email before creating a discussion. + - Alerts from secret scanning for GitHub Advanced Security customers were missing in the web UI and REST API if a site administrator did not upgrade directly to GitHub Enterprise Server 3.4. The alerts are now visible. + changes: + - Generation of support bundles is faster as a result of parallelized log sanitization. For more information about support bundles, see "[Providing data to GitHub Support](/support/contacting-github-support/providing-data-to-github-support)." + - APIs that contain the `organization` or `org` route now accept either the organization's slug or ID. Previously, the APIs only accepted slugs, which caused `Link` headers for GitHub Advanced Security endpoints to be inaccessible. For more information, see "[Organizations](https://docs.github.com/rest/orgs/orgs)" in the REST API documentation. + - 'La bitácora de auditoría ahora incluye más eventos generados por los usuarios, tal como `project.create`. La API de REST también devuelve eventos generados por el usuario, tal como `repo.create`. Para obtener más información, consulta las secciones "[Acceder a la bitácora de auditoría de tu empresa](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)" y "[Utilizar la API de bitácora de auditoría para tu empresa](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise#querying-the-audit-log-rest-api)".' + - In some cases, cache replicas could reject some Git operations on recently updated repositories. For more information about repository caching, see "[About repository caching](/admin/enterprise-management/caching-repositories/about-repository-caching)." + - 'You can now configure the global announcement banner to be dismissable using the REST API. For more information, see "[Customizing user messages for your enterprise](/admin/user-management/managing-users-in-your-enterprise/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner)."' + known_issues: + - En una instancia recién configurada de {% data variables.product.prodname_ghe_server %} sin ningún usuario, un atacante podría crear el primer usuario adminsitrador. + - Las reglas de cortafuegos personalizadas se eliminan durante el proceso de actualización. + - Los archivos rastreados del LFS de Git que se [cargaron mediante la interface web](https://github.com/blog/2105-upload-files-to-your-repositories) se agregaron incorrecta y directamente al repositorio. + - Las propuestas no pudieron cerrarse si contenían un permalink a un blob en el mismo repositorio en donde la ruta de archvio del blob era más grande a 255 caracteres. + - Cuando se habilita "Los usuarios pueden buscar en GitHub.com" con GitHub Connect, las propuestas en los repositorios privados e internos no se incluirán en los resultados de búsqueda de GitHub.com. + - El registor de npm del {% data variables.product.prodname_registry %} ya no regresa un valor de tiempo en las respuestas de metadatos. Esto se hizo para permitir mejoras de rendimiento sustanciales. Seguimos teniendo todos los datos necesarios para devolver un valor de tiempo como parte de la respuesta de metadatos y terminaremos de devolver este valor ene l futuro una vez que hayamos resuelto los problemas de rendimiento existentes. + - Los límites de recursos que son específicos para procesar ganchos de pre-recepción podrían ocasionar que fallen algunos ganchos de pre-recepción. + - Actions services need to be restarted after restoring an instance from a backup taken on a different host. + - In a repository's settings, enabling the option to allow users with read access to create discussions does not enable this functionality. + - In some cases, users cannot convert existing issues to discussions. + - Los patrones personalizados para el escaneo de secretos utilizan `.*` como un delimitador final, específicamente en el campo "Después del secreto". Este delimitador ocasiona inconsistencias en los escaneos que buscan secretos en los repositorios y podrías notar brechas en el historial de un repositorio en donde no hay escaneos completados. Los escaneos en aumento también podrían verse impactados. Para prevenir los problemas con los escaneos, modifica el final del patrón para eliminar el delimitador `.*`. diff --git a/translations/es-ES/data/reusables/actions/about-runner-groups.md b/translations/es-ES/data/reusables/actions/about-runner-groups.md new file mode 100644 index 000000000000..35545c801c70 --- /dev/null +++ b/translations/es-ES/data/reusables/actions/about-runner-groups.md @@ -0,0 +1,18 @@ +{% ifversion fpt %} +{% note %} + +**Note:** All organizations have a single default runner group. Only enterprise accounts and organizations owned by enterprise accounts can create and manage additional runner groups. + +{% endnote %} + +Runner groups are used to control access to runners. Los administradores de las organizaciones pueden configurar políticas de acceso que controlen qué repositorios en una organización tienen acceso al grupo de ejecutores. + +If you use {% data variables.product.prodname_ghe_cloud %}, you can create additional runner groups; enterprise admins can configure access policies that control which organizations in an enterprise have access to the runner group; and organization admins can assign additional granular repository access policies to the enterprise runner group. +{% endif -%} +{% ifversion ghec or ghes or ghae %} + +{% data reusables.actions.runner-group-enterprise-overview %} + +Cuando se crean nuevos ejecutores, se asignan automáticamente al grupo predeterminado. Los ejecutores solo pueden estar en un grupo a la vez. Puedes mover los ejecutores del grupo predeterminado a otro grupo. For more information, see "[Moving a runner to a group](#moving-a-runner-to-a-group)." + +{% endif %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/actions/actions-billing.md b/translations/es-ES/data/reusables/actions/actions-billing.md index c727e5908659..edfda614a459 100644 --- a/translations/es-ES/data/reusables/actions/actions-billing.md +++ b/translations/es-ES/data/reusables/actions/actions-billing.md @@ -1 +1 @@ -El uso de {% data variables.product.prodname_actions %} es gratuito tanto para los repositorios públicos como para los ejecutores auto-hospedados. Para los repositorios privados, cada cuenta de {% data variables.product.prodname_dotcom %} recibe una cantidad determinada de minutos y almacenamiento gratuitos dependiendo del producto que se utilice con la cuenta. Cualquier uso que no se contemple en las cantidades incluidas se controla con los límites de gasto. +{% data variables.product.prodname_actions %} usage is free for standard {% data variables.product.prodname_dotcom %}-hosted runners in public repositories, and for self-hosted runners. For private repositories, each {% data variables.product.prodname_dotcom %} account receives a certain amount of free minutes and storage for use with {% data variables.product.prodname_dotcom %}-hosted runners, depending on the product used with the account. Cualquier uso que no se contemple en las cantidades incluidas se controla con los límites de gasto. diff --git a/translations/es-ES/data/reusables/actions/add-hosted-runner-overview.md b/translations/es-ES/data/reusables/actions/add-hosted-runner-overview.md new file mode 100644 index 000000000000..bdd66230ca0a --- /dev/null +++ b/translations/es-ES/data/reusables/actions/add-hosted-runner-overview.md @@ -0,0 +1,3 @@ +You can choose an operating system and a hardware configuration from the list of available options. When new instances of this runner are deployed through autoscaling, they'll use the same operating system and hardware configuration you've defined here. + +You can also define the labels that identify the runner, which is how your workflows will be able to send jobs to the runners for processing (using `runs-on`). New runners are automatically assigned to the default group, or you can choose which group the runners must join during the runner creation process. In addition, you can modify the runner's group membership after you've registered the runner. For more information, see "[Controlling access to {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/controlling-access-to-larger-runners)." \ No newline at end of file diff --git a/translations/es-ES/data/reusables/actions/add-hosted-runner.md b/translations/es-ES/data/reusables/actions/add-hosted-runner.md new file mode 100644 index 000000000000..d533864a2e21 --- /dev/null +++ b/translations/es-ES/data/reusables/actions/add-hosted-runner.md @@ -0,0 +1,11 @@ +1. Click **New runner**, then click **{% octicon "mark-github" aria-label="New hosted runner" %} New Github-hosted runner**. +1. Complete the required details to configure your new runner: + + - **Name**: Enter a name for your new runner. For easier identification, this should indicate its hardware and operating configuration, such as `ubuntu-20.04-16core`. + - **Runner image**: Choose an operating system from the available options. Once you've selected an operating system, you will be able to choose a specific version. + - **Runner size**: Choose a hardware configuration from the drop-down list of available options. + - **Auto-scaling**: Choose the maximum number of runners that can be active at any time. + - **Runner group**: Choose the group that your runner will be a member of. This group will host multiple instances of your runner, as they scale up and down to suit demand. + - **Networking**: Only for {% data variables.product.prodname_ghe_cloud %}: Choose whether a static IP address range will be assigned to instances of the {% data variables.actions.hosted_runner %}. You can use up to 10 static IP addresses in total. + +1. Click **Create runner**. \ No newline at end of file diff --git a/translations/es-ES/data/reusables/actions/automatically-adding-a-runner-to-a-group.md b/translations/es-ES/data/reusables/actions/automatically-adding-a-runner-to-a-group.md new file mode 100644 index 000000000000..2a0ad86c2afb --- /dev/null +++ b/translations/es-ES/data/reusables/actions/automatically-adding-a-runner-to-a-group.md @@ -0,0 +1,11 @@ +You can use the configuration script to automatically add a new runner to a group. For example, this command registers a new runner and uses the `--runnergroup` parameter to add it to a group named `rg-runnergroup`. + +```sh +./config.sh --url $org_or_enterprise_url --token $token --runnergroup rg-runnergroup +``` + +El comando fallará si el grupo de ejecutores no existe: + +``` +Could not find any self-hosted runner group named "rg-runnergroup". +``` \ No newline at end of file diff --git a/translations/es-ES/data/reusables/actions/changing-the-access-policy-of-a-runner-group.md b/translations/es-ES/data/reusables/actions/changing-the-access-policy-of-a-runner-group.md new file mode 100644 index 000000000000..80bd92c91776 --- /dev/null +++ b/translations/es-ES/data/reusables/actions/changing-the-access-policy-of-a-runner-group.md @@ -0,0 +1,38 @@ +{% comment %} + +Always include a security admonition above this procedure. This is either one of the following, depending on whether the context is self-hosted runners or larger runners. + +{% data reusables.actions.self-hosted-runner-security-admonition %} +{% data reusables.actions.hosted-runner-security-admonition %} + +{% endcomment %} + +En el caso de los grupos de ejecutores en una empresa, puedes cambiar qué organizaciones dentro de ella pueden acceder a un grupo de ejecutores{% ifversion restrict-groups-to-workflows %} o restringir qué flujos de trabajo puede ejecutar un grupo de ejecutores{% endif %}. En el caso de los grupos de ejecutores en una organización, puedes cambiar qué repositorios en ella pueden acceder a un grupo de ejecutores{% ifversion restrict-groups-to-workflows %} o restringir qué flujos de trabajo puede ejecutar un grupo de ejecutores{% endif %}. + +### Cambiar qué organizaciones o repositorios pueden acceder a un grupo de ejecutores + +{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %} +{% data reusables.actions.runner-groups-navigate-to-repo-org-enterprise %} +{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %} +1. En el caso de los grupos de ejecutores en una empresa, debajo de **Acceso organizacional**, modifica qué organizaciones pueden acceder al grupo de ejecutores. En el caso de los grupos de ejecutores en una organización, debajo de **Acceso al repositorio**, modifica aquellos a los que puede acceder este grupo. + +{% elsif ghae or ghes < 3.4 %} +{% data reusables.actions.configure-runner-group-access %} +{% endif %} + +{% ifversion restrict-groups-to-workflows %} +### Cambiar los flujos de trabajo a los cuales puede acceder un grupo de ejecutores +You can configure a runner group to run either selected workflows or all workflows. For example, you might use this setting to protect secrets that are stored on runners or to standardize deployment workflows by restricting a runner group to run only a specific reusable workflow. Este ajuste no se puede anular si estás configurando un grupo de ejecutores de una organización que haya compartido una empresa. +{% data reusables.actions.runner-groups-navigate-to-repo-org-enterprise %} +{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %} +1. Debajo de **Acceso al flujo de trabajo**, selecciona el menú desplegable y haz clic en **Flujos de trabajo selectos**. +1. Da clic en {% octicon "gear" aria-label="the gear icon" %}. +1. Ingresa una lista separada por comas de los flujos de trabajo que pueden acceder al grupo de ejecutores. Utiliza la ruta completa, incluyendo el nombre y propietario del repositorio. Fija el flujo de trabajo a una rama, etiqueta o SHA completo. Por ejemplo: `octo-org/octo-repo/.github/workflows/build.yml@v2, octo-org/octo-repo/.github/workflows/deploy.yml@d6dc6c96df4f32fa27b039f2084f576ed2c5c2a5, monalisa/octo-test/.github/workflows/test.yml@main`. + + Solo los jobs que se definan directamente dentro de los flujos de trabajo seleccionados tendrán acceso al grupo de ejecutores. + + Los grupos de ejecutores que pertenecen a la organización no pueden acceder a los flujos de trabajo de otra organización de la empresa; en vez de esto, debes crear un grupo de ejecutores que pertenezca a la empresa. + +1. Haz clic en **Save ** (guardar). + +{% endif %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/actions/changing-the-name-of-a-runner-group.md b/translations/es-ES/data/reusables/actions/changing-the-name-of-a-runner-group.md new file mode 100644 index 000000000000..98675a00cf80 --- /dev/null +++ b/translations/es-ES/data/reusables/actions/changing-the-name-of-a-runner-group.md @@ -0,0 +1,9 @@ +{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %} +{% data reusables.actions.runner-groups-navigate-to-repo-org-enterprise %} +{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %} +1. Cambia el nombre del grupo de ejecutores. + +{% elsif ghae or ghes < 3.4 %} +{% data reusables.actions.configure-runner-group %} +1. Cambia el nombre del grupo de ejecutores. +{% endif %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/actions/self-hosted-runner-configure-runner-group-access.md b/translations/es-ES/data/reusables/actions/configure-runner-group-access.md similarity index 85% rename from translations/es-ES/data/reusables/actions/self-hosted-runner-configure-runner-group-access.md rename to translations/es-ES/data/reusables/actions/configure-runner-group-access.md index 95625acb8a98..3ee0e3151353 100644 --- a/translations/es-ES/data/reusables/actions/self-hosted-runner-configure-runner-group-access.md +++ b/translations/es-ES/data/reusables/actions/configure-runner-group-access.md @@ -1,4 +1,4 @@ -{% data reusables.actions.self-hosted-runner-configure-runner-group %} +{% data reusables.actions.configure-runner-group %} 1. Modifica las opciones de tu política. {% ifversion not ghae %} diff --git a/translations/es-ES/data/reusables/actions/self-hosted-runner-configure-runner-group.md b/translations/es-ES/data/reusables/actions/configure-runner-group.md similarity index 100% rename from translations/es-ES/data/reusables/actions/self-hosted-runner-configure-runner-group.md rename to translations/es-ES/data/reusables/actions/configure-runner-group.md diff --git a/translations/es-ES/data/reusables/actions/self-hosted-runner-create-group.md b/translations/es-ES/data/reusables/actions/create-runner-group.md similarity index 100% rename from translations/es-ES/data/reusables/actions/self-hosted-runner-create-group.md rename to translations/es-ES/data/reusables/actions/create-runner-group.md diff --git a/translations/es-ES/data/reusables/actions/creating-a-runner-group-for-an-enterprise.md b/translations/es-ES/data/reusables/actions/creating-a-runner-group-for-an-enterprise.md new file mode 100644 index 000000000000..95543bf6020b --- /dev/null +++ b/translations/es-ES/data/reusables/actions/creating-a-runner-group-for-an-enterprise.md @@ -0,0 +1,28 @@ +{% comment %} + +Always include a security admonition above this procedure. This is either one of the following, depending on whether the context is self-hosted runners or larger runners. + +{% data reusables.actions.self-hosted-runner-security-admonition %} +{% data reusables.actions.hosted-runner-security-admonition %} + +{% endcomment %} + +Enterprises can add their runners to groups for access management. Enterprises can create groups of runners that are accessible to specific organizations in the enterprise account{% ifversion restrict-groups-to-workflows %} or to specific workflows{% endif %}. Los propietarios de organizaciones pueden entonces asignar políticas de acceso adicionales y granulares para los repositorios{% ifversion restrict-groups-to-workflows %} o flujos de trabajo{% endif %} a los grupos de ejecutores empresariales. For information about how to create a runner group with the REST API, see the enterprise endpoints in the [{% data variables.product.prodname_actions %} REST API](/rest/reference/actions#self-hosted-runner-groups). + +Runners are automatically assigned to the default group when created, and can only be members of one group at a time. Puedes asignar el ejecutor a un grupo específico durante el proceso de registro o puedes moverlo después desde el grupo predeterminado a un grupo personalizado. + +Cuando creas un grupo, debes elegir la política que defina qué organizaciones tienen acceso al grupo de ejecutores. + +{% data reusables.actions.runner-groups-add-to-enterprise-first-steps %} +1. Para elegir una política para el acceso organizacional, selecciona el menú desplegable **Acceso organizacional** y haz clic en una política. Puedes configurar un grupo de ejecutores para que sea accesible a una lista de organizaciones específica o a todas las organizaciones en la empresa.{% ifversion ghes %} Predeterminadamente, solo los repositorios privados pueden acceder a los ejecutores en un grupo, pero esto se puede anular.{% endif %} + + {%- ifversion ghec or ghes %} + + ![Agregar opciones de un grupo de ejecutores](/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png) + {%- elsif ghae %} + + ![Agregar opciones de un grupo de ejecutores](/assets/images/help/settings/actions-enterprise-account-add-runner-group-options-ae.png) + {%- endif %} +{% data reusables.actions.runner-group-assign-policy-workflow %} +1. Da clic en **Guardar grupo** para crear el grupo y aplicar la política. + diff --git a/translations/es-ES/data/reusables/actions/creating-a-runner-group-for-an-organization.md b/translations/es-ES/data/reusables/actions/creating-a-runner-group-for-an-organization.md new file mode 100644 index 000000000000..c063f891a07e --- /dev/null +++ b/translations/es-ES/data/reusables/actions/creating-a-runner-group-for-an-organization.md @@ -0,0 +1,38 @@ +{% comment %} + +Always include a security admonition above this procedure. This is either one of the following, depending on whether the context is self-hosted runners or larger runners. + +{% data reusables.actions.self-hosted-runner-security-admonition %} +{% data reusables.actions.hosted-runner-security-admonition %} + +{% endcomment %} + +All organizations have a single default runner group. Organizations within an enterprise account can create additional groups. Los administradores de la organización pueden permitir el acceso de los repositorios individuales a un grupo de ejecutores. For information about how to create a runner group with the REST API, see "[Self-hosted runner groups](/rest/reference/actions#self-hosted-runner-groups)." + +Runners are automatically assigned to the default group when created, and can only be members of one group at a time. Puedes mover un ejecutor del grupo predeterminado a cualquier grupo que crees. + +Cuando creas un grupo, debes elegir la política que define qué reositorios{% ifversion restrict-groups-to-workflows %} y flujos de trabajo{% endif %} tienen acceso al grupo ejecutor. + +{% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %} +{% data reusables.organizations.navigate-to-org %} +{% data reusables.organizations.org_settings %} +{% data reusables.organizations.settings-sidebar-actions-runner-groups %} +1. En la sección de "Grupos de ejecutores", haz clic en **Grupo de ejecutores nuevo**. +1. Ingresa un nombre para tu grupo ejecutor. + {% data reusables.actions.runner-group-assign-policy-repo %} +{% data reusables.actions.runner-group-assign-policy-workflow %}{%- ifversion restrict-groups-to-workflows %}Los grupos ejecutores que pertenecen a las organizaciones no pueden acceder a los flujos de trabajo de una organización diferente en la empresa. En vez de esto, debes crear un grupo de ejecutores que pertenezca a la empresa.{% endif %} +{% data reusables.actions.create-runner-group %} +{% elsif ghae or ghes < 3.4 %} +{% data reusables.organizations.navigate-to-org %} +{% data reusables.organizations.org_settings %} +{% data reusables.organizations.settings-sidebar-actions-runner-groups %} +1. Debajo de {% ifversion ghes or ghae %}"Ejecutores"{% endif %}, haz clic en **Agregar nuevo** y luego en **Grupo nuevo**. + + ![Agregar un grupo de ejecutores](/assets/images/help/settings/actions-org-add-runner-group.png) +1. Ingresa un nombre para tu grupo de ejecutores y asigna una política para el acceso al repositorio. + + Puedes configurar un grupo de ejecutores para que una lista de repositorios específica o todos los repositorios de la organización puedan acceder a él.{% ifversion ghec or ghes %} Predeterminadamente solo los repositorios privados pueden acceder a los ejecutores de un grupo de ejecutores, pero esto se puede omitir. Esta configuración no puede anularse si se configura un grupo ejecutor de la organización que haya compartido una empresa.{% endif %} + + ![Agregar opciones de un grupo de ejecutores](/assets/images/help/settings/actions-org-add-runner-group-options.png) +1. Da clic en **Guardar grupo** para crear el grupo y aplicar la política. +{% endif %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/actions/hosted-runner-security-admonition.md b/translations/es-ES/data/reusables/actions/hosted-runner-security-admonition.md new file mode 100644 index 000000000000..f1b63416c0e1 --- /dev/null +++ b/translations/es-ES/data/reusables/actions/hosted-runner-security-admonition.md @@ -0,0 +1,5 @@ +{% warning %} + +**Advertencia**: {% data reusables.actions.hosted-runner-security %} + +{% endwarning %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/actions/hosted-runner-security.md b/translations/es-ES/data/reusables/actions/hosted-runner-security.md new file mode 100644 index 000000000000..ed12d189db73 --- /dev/null +++ b/translations/es-ES/data/reusables/actions/hosted-runner-security.md @@ -0,0 +1,3 @@ +We recommend that you only use {% data variables.actions.hosted_runner %}s with private repositories: +- Forks of your repository can potentially run dangerous code on your {% data variables.actions.hosted_runner %} by creating a pull request that executes the code in a workflow. +- You could incur unexpected costs if you allow forked repositories to run jobs on your {% data variables.actions.hosted_runner %}s. \ No newline at end of file diff --git a/translations/es-ES/data/reusables/actions/jobs/section-running-jobs-in-a-container.md b/translations/es-ES/data/reusables/actions/jobs/section-running-jobs-in-a-container.md index 7402626c76b2..592406a99579 100644 --- a/translations/es-ES/data/reusables/actions/jobs/section-running-jobs-in-a-container.md +++ b/translations/es-ES/data/reusables/actions/jobs/section-running-jobs-in-a-container.md @@ -2,6 +2,12 @@ Utiliza `jobs..container` para crear un contenedor para ejecutar cualqui Si no configuras un `container`, todos los pasos se ejecutan directamente en el host especificado por `runs-on` a menos que un paso se refiera a una acción configurada para ejecutarse en un contenedor. +{% note %} + +**Note:** The default shell for `run` steps inside a container is `sh` instead of `bash`. This can be overridden with [`jobs..defaults.run`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_iddefaultsrun) or [`jobs..steps[*].shell`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell). + +{% endnote %} + ### Ejemplo: Ejecutar un job dentro de un contenedor ```yaml{:copy} diff --git a/translations/es-ES/data/reusables/actions/macos-runner-preview.md b/translations/es-ES/data/reusables/actions/macos-runner-preview.md index c9b93aecbea8..b1bb2b899c94 100644 --- a/translations/es-ES/data/reusables/actions/macos-runner-preview.md +++ b/translations/es-ES/data/reusables/actions/macos-runner-preview.md @@ -1 +1 @@ -The macos-latest YAML workflow label currently uses the macOS 10.15 runner image. +La etiqueta de flujo de trabajo de YAML macos-latest utiliza actualmente la imagen de ejecutor de macOS 10.15. diff --git a/translations/es-ES/data/reusables/actions/moving-a-runner-to-a-group.md b/translations/es-ES/data/reusables/actions/moving-a-runner-to-a-group.md new file mode 100644 index 000000000000..04aea1e6a3e0 --- /dev/null +++ b/translations/es-ES/data/reusables/actions/moving-a-runner-to-a-group.md @@ -0,0 +1,12 @@ +If you don't specify a runner group during the registration process, your new runners are automatically assigned to the default group, and can then be moved to another group. + +{% data reusables.actions.self-hosted-runner-navigate-to-org-enterprise %} +{% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %} +1. En la lista de "Ejecutores", haz clic en aquél que quieras configurar. +2. Selecciona el menú desplegable de **Grupo de ejecutores**. +3. En "Mover el ejecutor al grupo", elige un grupo destino para el ejecutor. +{% elsif ghae or ghes < 3.4 %} +1. En la sección {% ifversion ghes or ghae %}"Grupos de ejecutores"{% endif %} de la página de ajustes, ubica el grupo actual del ejecutor que quieras mover y expande la lista de miembros del grupo. ![Ver los miembros de un grupo de ejecutores](/assets/images/help/settings/actions-org-runner-group-members.png) +2. Selecciona la casilla junto al ejecutor auto-hospedado y da clic en **Mover a grupo** para ver los destinos disponibles. ![Mover a un miembro de un grupo de ejecutores](/assets/images/help/settings/actions-org-runner-group-member-move.png) +3. Para mover el ejecutor, da clic en el grupo de destino. ![Mover a un miembro de un grupo de ejecutores](/assets/images/help/settings/actions-org-runner-group-member-move-destination.png) +{% endif %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/actions/pure-javascript.md b/translations/es-ES/data/reusables/actions/pure-javascript.md index cf574fb47a72..09e1e36ce51f 100644 --- a/translations/es-ES/data/reusables/actions/pure-javascript.md +++ b/translations/es-ES/data/reusables/actions/pure-javascript.md @@ -1 +1 @@ -Para garantizar que tus acciones de JavaScript son compatibles con todos los ejecutores hospedados en GitHub (Ubuntu, Windows, y macOS), el código empaquetado de JavaScript que escribas debe ser puramente JavaScript y no depender de otros binarios. JavaScript actions run directly on the runner and use binaries that already exist in the runner image. +Para garantizar que tus acciones de JavaScript son compatibles con todos los ejecutores hospedados en GitHub (Ubuntu, Windows, y macOS), el código empaquetado de JavaScript que escribas debe ser puramente JavaScript y no depender de otros binarios. Las acciones de JavaScript se ejecutan directamente en el ejecutor y utilizan binarios que ya existen en la imagen ejecutora. diff --git a/translations/es-ES/data/reusables/actions/removing-a-runner-group.md b/translations/es-ES/data/reusables/actions/removing-a-runner-group.md new file mode 100644 index 000000000000..11a2c8ffba84 --- /dev/null +++ b/translations/es-ES/data/reusables/actions/removing-a-runner-group.md @@ -0,0 +1,9 @@ +Runners are automatically returned to the default group when their group is removed. + +{% ifversion ghes or ghae or ghec %} +{% data reusables.actions.runner-groups-navigate-to-repo-org-enterprise %} +1. En la lista de grupos, a la derecha del grupo que quieras borrar, haz clic en {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}. +2. Para eliminar el grupo, da clic en **Eliminar grupo**. +3. Revisa el mensaje de confirmación y da clic en **Eliminar este grupo de ejecutores**. Any runners still in this group will be automatically moved to the default group, where they will inherit the access permissions assigned to that group. + +{% endif %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/actions/runner-group-enterprise-overview.md b/translations/es-ES/data/reusables/actions/runner-group-enterprise-overview.md new file mode 100644 index 000000000000..2ff508d5ea4f --- /dev/null +++ b/translations/es-ES/data/reusables/actions/runner-group-enterprise-overview.md @@ -0,0 +1,3 @@ +Runner groups are used to control access to runners at the organization and enterprise level. Enterprise owners can configure access policies that control which organizations {% ifversion restrict-groups-to-workflows %}and workflows {% endif %}in an enterprise have access to the runner group. Los propietarios de las organizaciones pueden configurar las políticas de acceso que controlan qué repositorios{% ifversion restrict-groups-to-workflows %} y flujos de trabajo{% endif %} en una organización tienen aceso al grupo de ejecutores. + +When an enterprise owner grants access to a runner group, organization owners can see the runner group listed in the organization's runner settings. Los propietarios organizacionales pueden entonces asignar políticas de acceso adicionales y granulares para los repositorios{% ifversion restrict-groups-to-workflows %} y flujos de trabajo{% endif %} al grupo ejecutor de la empresa. \ No newline at end of file diff --git a/translations/es-ES/data/reusables/actions/self-hosted-runner-groups-add-to-enterprise-first-steps.md b/translations/es-ES/data/reusables/actions/runner-groups-add-to-enterprise-first-steps.md similarity index 100% rename from translations/es-ES/data/reusables/actions/self-hosted-runner-groups-add-to-enterprise-first-steps.md rename to translations/es-ES/data/reusables/actions/runner-groups-add-to-enterprise-first-steps.md diff --git a/translations/es-ES/data/reusables/actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md b/translations/es-ES/data/reusables/actions/runner-groups-navigate-to-repo-org-enterprise.md similarity index 78% rename from translations/es-ES/data/reusables/actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md rename to translations/es-ES/data/reusables/actions/runner-groups-navigate-to-repo-org-enterprise.md index 61f5eda29840..6e56926609bb 100644 --- a/translations/es-ES/data/reusables/actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md +++ b/translations/es-ES/data/reusables/actions/runner-groups-navigate-to-repo-org-enterprise.md @@ -1,9 +1,9 @@ {% ifversion fpt %} -1. Navega a la página principal del repositorio u organización en donde se ubican tus grupos de ejecutores auto-hospedados. +1. Navigate to the main page of the repository or organization where your runner groups are located. 2. Haz clic en {% octicon "gear" aria-label="The Settings gear" %} **Ajustes**. {% data reusables.organizations.settings-sidebar-actions-runner-groups %} {% elsif ghec or ghes or ghae %} -1. Navega a donde se ubiquen tus grupos de ejecutores auto-hospedados: +1. Navigate to where your runner groups are located: * **En una organización**: navega a la página principal y da clic en {% octicon "gear" aria-label="The Settings gear" %} **Configuración**. * **Si utilizas un grupo a nivel de empresa**: @@ -12,7 +12,7 @@ * **En una organización**: {% indented_data_reference reusables.actions.settings-ui.settings-actions-runner-groups spaces=5 %} - * **Si estás utilizando un grupo a nivel de empresa**: + * **Si utilizas un grupo a nivel de empresa**: {% indented_data_reference reusables.enterprise-accounts.policies-tab spaces=5 %} {% indented_data_reference reusables.enterprise-accounts.actions-tab spaces=5 %} diff --git a/translations/es-ES/data/reusables/actions/self-hosted-runner-add-to-enterprise.md b/translations/es-ES/data/reusables/actions/self-hosted-runner-add-to-enterprise.md index 9d6c8982fa8c..99d17e99ef0c 100644 --- a/translations/es-ES/data/reusables/actions/self-hosted-runner-add-to-enterprise.md +++ b/translations/es-ES/data/reusables/actions/self-hosted-runner-add-to-enterprise.md @@ -3,7 +3,7 @@ {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} {% data reusables.enterprise-accounts.actions-runners-tab %} -1. Haz clic en **Ejecutor nuevo**. +{% ifversion actions-hosted-runners %}1. Click **New runner**, then click **New self-hosted runner**.{% else %}1. Click **New runner**.{% endif %} {% data reusables.actions.self-hosted-runner-configure %} {%- elsif ghae or ghes < 3.4 %} Para agregar un ejecutor auto-hospedado a una empresa, debes ser el propietario de la misma. diff --git a/translations/es-ES/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md b/translations/es-ES/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md index c20c6c6c033b..b9845777a007 100644 --- a/translations/es-ES/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md +++ b/translations/es-ES/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md @@ -3,7 +3,7 @@ 2. Haz clic en {% octicon "gear" aria-label="The Settings gear" %} **Ajustes**. {% data reusables.organizations.settings-sidebar-actions-runners %} {% elsif ghec or ghes or ghae %} -1. Navega a donde está registrado tu ejecutor auto-hospedado: +1. Navigate to where your runner is registered: * **En una organización**: navega a la página principal y da clic en {% octicon "gear" aria-label="The Settings gear" %} **Configuración**. * **Si utilizas un ejecutor a nivel de empresa**: diff --git a/translations/es-ES/data/reusables/actions/self-hosted-runner-navigate-to-repo-org-enterprise.md b/translations/es-ES/data/reusables/actions/self-hosted-runner-navigate-to-repo-org-enterprise.md index 7cc1905a0db5..bd56df8613af 100644 --- a/translations/es-ES/data/reusables/actions/self-hosted-runner-navigate-to-repo-org-enterprise.md +++ b/translations/es-ES/data/reusables/actions/self-hosted-runner-navigate-to-repo-org-enterprise.md @@ -3,7 +3,7 @@ 2. Haz clic en {% octicon "gear" aria-label="The Settings gear" %} **Ajustes**. {% data reusables.organizations.settings-sidebar-actions-runners %} {% elsif ghec or ghes or ghae %} -1. Navega a donde está registrado tu ejecutor auto-hospedado: +1. Navigate to where your runner is registered: * **En un repositorio organizacional**: navega a la página principal y da clic en {% octicon "gear" aria-label="The Settings gear" %} **Configuración**. * **Si utilizas un ejecutor a nivel de empresa**: diff --git a/translations/es-ES/data/reusables/actions/self-hosted-runner-security-admonition.md b/translations/es-ES/data/reusables/actions/self-hosted-runner-security-admonition.md new file mode 100644 index 000000000000..7e9c6569c97a --- /dev/null +++ b/translations/es-ES/data/reusables/actions/self-hosted-runner-security-admonition.md @@ -0,0 +1,7 @@ +{% warning %} + +**Advertencia**: {% data reusables.actions.self-hosted-runner-security %} + +Para obtener más información, consulta "[Acerca de los ejecutores autoalojados](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." + +{% endwarning %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/actions/self-hosted-runner-security.md b/translations/es-ES/data/reusables/actions/self-hosted-runner-security.md index 6fcaa4b256e4..f4f39430251b 100644 --- a/translations/es-ES/data/reusables/actions/self-hosted-runner-security.md +++ b/translations/es-ES/data/reusables/actions/self-hosted-runner-security.md @@ -1 +1 @@ -Te recomendamos que solo utilices los ejecutores auto-hospedados con los repositorios privados. Esto se debe a que tu repositorio podría ejecutar código peligroso en tu máquina de ejecutor auto-hospedado potencialmente al crear una solicitud de cambios que excluya el código en un flujo de trabajo. +Te recomendamos que solo utilices los ejecutores auto-hospedados con los repositorios privados. This is because forks of your public repository can potentially run dangerous code on your self-hosted runner machine by creating a pull request that executes the code in a workflow. \ No newline at end of file diff --git a/translations/es-ES/data/reusables/actions/supported-github-runners.md b/translations/es-ES/data/reusables/actions/supported-github-runners.md index 64c4a3ace373..c53db4b4e856 100644 --- a/translations/es-ES/data/reusables/actions/supported-github-runners.md +++ b/translations/es-ES/data/reusables/actions/supported-github-runners.md @@ -1,7 +1,7 @@ - + @@ -54,7 +54,7 @@ Ubuntu 18.04 [deprecated]ubuntu-18.04 @@ -92,7 +92,7 @@ Migra a macOS-11 o macOS-12. Para obtener más informa {% note %} -**Note:** The `-latest` runner images are the latest stable images that {% data variables.product.prodname_dotcom %} provides, and might not be the most recent version of the operating system available from the operating system vendor. +**Nota:** Las imágenes de ejecutor catalogadas como `-latest` son las imágenes más recientes que proporciona {% data variables.product.prodname_dotcom %} y podrían no ser la versión más reciente del sistema operativo disponible desde el proveedor de este. {% endnote %} diff --git a/translations/es-ES/data/reusables/advanced-security/secret-scanning-dry-run-select-enterprise-repos.md b/translations/es-ES/data/reusables/advanced-security/secret-scanning-dry-run-select-enterprise-repos.md index ae1e8e39ecb5..ed0d8a8dbc7d 100644 --- a/translations/es-ES/data/reusables/advanced-security/secret-scanning-dry-run-select-enterprise-repos.md +++ b/translations/es-ES/data/reusables/advanced-security/secret-scanning-dry-run-select-enterprise-repos.md @@ -1,7 +1,7 @@ {%- ifversion custom-pattern-dry-run-ga %} -1. Search for and select up to 10 repositories where you want to perform the dry run. ![Screenshot showing repositories selected for the dry run](/assets/images/help/repository/secret-scanning-dry-run-custom-pattern-select-repo-only.png) +1. Busca y selecciona hasta 10 repositorios en donde quieras realizar la simulación. ![Screenshot showing repositories selected for the dry run](/assets/images/help/repository/secret-scanning-dry-run-custom-pattern-select-repo-only.png) 1. When you're ready to test your new custom pattern, click **Run**. {%- else %} -1. Search for and select up to 10 repositories where you want to perform the dry run. ![Screenshot showing repositories selected for the dry run](/assets/images/help/repository/secret-scanning-dry-run-custom-pattern-select-repo.png) +1. Busca y selecciona hasta 10 repositorios en donde quieras realizar la simulación. ![Screenshot showing repositories selected for the dry run](/assets/images/help/repository/secret-scanning-dry-run-custom-pattern-select-repo.png) 1. Cuando estés listo para probar tu nuevo patrón personalizado, haz clic en **Simulacro**. {%- endif %} diff --git a/translations/es-ES/data/reusables/advanced-security/secret-scanning-push-protection-org.md b/translations/es-ES/data/reusables/advanced-security/secret-scanning-push-protection-org.md index 1ea6cc5ee7d8..0b25b4d0348d 100644 --- a/translations/es-ES/data/reusables/advanced-security/secret-scanning-push-protection-org.md +++ b/translations/es-ES/data/reusables/advanced-security/secret-scanning-push-protection-org.md @@ -1,6 +1,6 @@ 1. Debajo de "{% data variables.product.prodname_secret_scanning_caps %}" y debajo de "Protección contra subida", haz clic en **Habilitar todo**. ![Captura de pantalla que muestra cómo habilitar la protección de subida para el {% data variables.product.prodname_secret_scanning %} en una organización](/assets/images/help/organizations/secret-scanning-enable-push-protection.png) -1. Optionally, click "Automatically enable for private repositories added to {% data variables.product.prodname_secret_scanning %}."{% ifversion push-protection-custom-link-orgs %} -1. Optionally, to include a custom link in the message that members will see when they attempt to push a secret, select **Add a resource link in the CLI and web UI when a commit is blocked**, then type a URL, and click **Save link**. +1. Opcionalmente, haz clic en "Habilitar automáticamente los repositorios privados agregados al {% data variables.product.prodname_secret_scanning %}".{% ifversion push-protection-custom-link-orgs %} +1. Opcionalmente, para incluir un enlace personalizado en el mensaje, el cual verán los miembros cuando intenten subir un secreto, selecciona **Agregar un enlace de recurso en el CLI e IU web cuando se bloquee un comentario** y después escribe una URL y haz clic en **Guardar enlace**. {% ifversion push-protection-custom-link-orgs-beta %}{% indented_data_reference reusables.advanced-security.custom-link-beta spaces=3 %}{% endif %} - ![Screenshot showing checkbox and text field for enabling a custom link](/assets/images/help/organizations/secret-scanning-custom-link.png){% endif %} \ No newline at end of file + ![Captura de pantalla que muestra la casilla de verificación y campo de texto para habilitar un enlace personalizado](/assets/images/help/organizations/secret-scanning-custom-link.png){% endif %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/billing/billing-hosted-runners.md b/translations/es-ES/data/reusables/billing/billing-hosted-runners.md new file mode 100644 index 000000000000..288139688468 --- /dev/null +++ b/translations/es-ES/data/reusables/billing/billing-hosted-runners.md @@ -0,0 +1 @@ +| Linux | 4 | $0.016 | | Linux | 8 | $0.032 | | Linux | 16 | $0.064 | | Linux | 32 | $0.128 | | Linux | 64 | $0.256 | | Windows | 8 | $0.064 | | Windows | 16 | $0.128 | | Windows | 32 | $0.256 | | Windows | 64 | $0.512 | \ No newline at end of file diff --git a/translations/es-ES/data/reusables/billing/billing-standard-runners.md b/translations/es-ES/data/reusables/billing/billing-standard-runners.md new file mode 100644 index 000000000000..d15058c03257 --- /dev/null +++ b/translations/es-ES/data/reusables/billing/billing-standard-runners.md @@ -0,0 +1,5 @@ +| Sistema operativo | Cores | Tasa por minuto (USD) | +| ----------------- | ----- | --------------------- | +| Linux | 2 | $0.008 | +| macOS | 3 | $0.08 | +| Windows | 2 | $0.016 | diff --git a/translations/es-ES/data/reusables/classroom/reuse-assignment-link.md b/translations/es-ES/data/reusables/classroom/reuse-assignment-link.md index cad57fd14a03..94c4b743355e 100644 --- a/translations/es-ES/data/reusables/classroom/reuse-assignment-link.md +++ b/translations/es-ES/data/reusables/classroom/reuse-assignment-link.md @@ -1 +1 @@ -You can reuse existing assignments in any other classroom you have admin access to, including classrooms in a different organization. Para obtener más información, consulta la sección "[Reutilizar una tarea](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment)". +Puedes reutilizar las tareas existentes en cualquier otra aula en la que tengas acceso administrativo, incluyendo aquellas en una organización diferente. Para obtener más información, consulta la sección "[Reutilizar una tarea](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/reuse-an-assignment)". diff --git a/translations/es-ES/data/reusables/code-scanning/example-configuration-files.md b/translations/es-ES/data/reusables/code-scanning/example-configuration-files.md index 5ed73d4367d3..07349858d45f 100644 --- a/translations/es-ES/data/reusables/code-scanning/example-configuration-files.md +++ b/translations/es-ES/data/reusables/code-scanning/example-configuration-files.md @@ -30,3 +30,22 @@ paths-ignore: - src/node_modules - '**/*.test.js' ``` + +{% ifversion code-scanning-exclude-queries-from-analysis %} + +El siguiente archivo de configuración solo ejecuta consultas que generan alertas de errores de gravedad. La configuración selecciona primero todas las consultas predeterminadas, todas las consultas en `./my-queries` y la suite predeterminada en `codeql/java-queries` para luego excluir todas las consultas que generan advertencias o recomendaciones. + +``` yaml +queries: + - name: Use an in-repository QL pack (run queries in the my-queries directory) + uses: ./my-queries +packs: + - codeql/java-queries +query-filters: +- exclude: + problem.severity: + - warning + - recommendation +``` + +{% endif %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/code-scanning/run-additional-queries.md b/translations/es-ES/data/reusables/code-scanning/run-additional-queries.md index 3f25bd67d1b3..fddae57c6268 100644 --- a/translations/es-ES/data/reusables/code-scanning/run-additional-queries.md +++ b/translations/es-ES/data/reusables/code-scanning/run-additional-queries.md @@ -1,5 +1,13 @@ When you use {% data variables.product.prodname_codeql %} to scan code, the {% data variables.product.prodname_codeql %} analysis engine generates a database from the code and runs queries on it. {% data variables.product.prodname_codeql %} analysis uses a default set of queries, but you can specify more queries to run, in addition to the default queries. +{% ifversion code-scanning-exclude-queries-from-analysis %} +{% tip %} + +You can also specify the queries you want to exclude from analysis, or include in the analysis. This requires the use of a custom configuration file. For more information, see "[Using a custom configuration file](#using-a-custom-configuration-file)" and "[Excluding specific queries from analysis](#excluding-specific-queries-from-analysis) " below. + +{% endtip %} +{% endif %} + {% ifversion codeql-packs %} You can run extra queries if they are part of a {% data variables.product.prodname_codeql %} pack (beta) published to the {% data variables.product.company_short %} {% data variables.product.prodname_container_registry %} or a {% data variables.product.prodname_ql %} pack stored in a repository. For more information, see "[About {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql#about-codeql-queries)." diff --git a/translations/es-ES/data/reusables/codespaces/codespaces-disabling-org-billing.md b/translations/es-ES/data/reusables/codespaces/codespaces-disabling-org-billing.md index a3d7ca0c7a90..d3ed8cea212a 100644 --- a/translations/es-ES/data/reusables/codespaces/codespaces-disabling-org-billing.md +++ b/translations/es-ES/data/reusables/codespaces/codespaces-disabling-org-billing.md @@ -1,5 +1,5 @@ {% note %} -**Note**: If you disable billable codespaces use for your organization, anyone who can create codespaces as an individual user, and can clone a repository in your organization, will still be able to create a codespace for that repository. However, this will not incur any charge for your organization. For information about restricting access to a repository, see "[Managing teams and people with access to your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." +**Note**: If you disable billable codespaces use for your organization, anyone who can create codespaces as an individual user, and can clone a repository in your organization, will still be able to create a codespace for that repository. However, this will not incur any charge for your organization. Para obtener más información sobre cómo restringir el acceso a un repositorio, consulta la sección "[Administrar los equipos y personas con acceso a tu repositorio](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)". {% endnote %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/codespaces/codespaces-org-policies-note.md b/translations/es-ES/data/reusables/codespaces/codespaces-org-policies-note.md index 69e653079137..ca6be6fa7f50 100644 --- a/translations/es-ES/data/reusables/codespaces/codespaces-org-policies-note.md +++ b/translations/es-ES/data/reusables/codespaces/codespaces-org-policies-note.md @@ -1,5 +1,5 @@ {% note %} -**Note**: Organization policies you define for {% data variables.product.prodname_codespaces %} only apply to codespaces for which your organization will be billed. If an individual user creates a codespace for a repository in your organization, and the organization is not billed, then the codespace will not be bound by these policies. For information on how to choose who can create codespaces that are billed to your organization, see "[Enabling {% data variables.product.prodname_github_codespaces %} for your organization](https://docs-internal-29134-ad7bd8.preview.ghdocs.com/en/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization#choose-who-can-create-codespaces-that-are-billed-to-your-organization)." +**Note**: Organization policies you define for {% data variables.product.prodname_codespaces %} only apply to codespaces for which your organization will be billed. If an individual user creates a codespace for a repository in your organization, and the organization is not billed, then the codespace will not be bound by these policies. Para obtener más información sobre cómo elegir quién puede crear codespaces que se facturan a tu organización, consulta la sección "[Habilitar a los {% data variables.product.prodname_github_codespaces %} para tu organización](/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization#choose-who-can-create-codespaces-that-are-billed-to-your-organization)". {% endnote %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/codespaces/open-codespace-from-template-repo.md b/translations/es-ES/data/reusables/codespaces/open-codespace-from-template-repo.md new file mode 100644 index 000000000000..b9f18ee8fe2b --- /dev/null +++ b/translations/es-ES/data/reusables/codespaces/open-codespace-from-template-repo.md @@ -0,0 +1,8 @@ +1. Select an owner for the new repository, enter a repository name, select your preferred privacy setting, and click **Create repository from template**. +1. On the main page of the newly created repository, click the **{% octicon "code" aria-label="The code icon" %} Code** button and select the **Codespaces** tab. + + ![Botón de codespace nuevo](/assets/images/help/codespaces/new-codespace-button.png) + + If you don’t see this tab, {% data variables.product.prodname_github_codespaces %} isn't available for you. For more information about access to {% data variables.product.prodname_github_codespaces %}, see "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-github-codespaces)." + +1. On the **Codespaces** tab, click **Create codespace on main**. diff --git a/translations/es-ES/data/reusables/codespaces/rebuild-command.md b/translations/es-ES/data/reusables/codespaces/rebuild-command.md index 64aafc0323e1..96a0e1211178 100644 --- a/translations/es-ES/data/reusables/codespaces/rebuild-command.md +++ b/translations/es-ES/data/reusables/codespaces/rebuild-command.md @@ -1,5 +1,3 @@ -1. Accede a la {% data variables.product.prodname_vscode_command_palette %} (Shift + Command + P / Ctrl + Shift + P) y comienza a escribir "rebuild". Selecciona **Codespaces: Reconstruir contenedor**. +1. Access the {% data variables.product.prodname_vscode_command_palette_shortname %} (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)), then start typing "rebuild". Selecciona **Codespaces: Reconstruir contenedor**. ![Opción de recompilar contenedor](/assets/images/help/codespaces/codespaces-rebuild.png) - - diff --git a/translations/es-ES/data/reusables/codespaces/remote-explorer.md b/translations/es-ES/data/reusables/codespaces/remote-explorer.md index c46ed9b53925..545bdcf0c91d 100644 --- a/translations/es-ES/data/reusables/codespaces/remote-explorer.md +++ b/translations/es-ES/data/reusables/codespaces/remote-explorer.md @@ -2,7 +2,7 @@ **Note**: If the Remote Explorer is not displayed in the Activity Bar: -1. Access the command palette. For example, by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux). +1. Access the Command Palette. For example, by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux). 1. Type: `codespaces`. 1. Click **Codespaces: Details**. diff --git a/translations/es-ES/data/reusables/dependabot/dependabot-alerts-filters.md b/translations/es-ES/data/reusables/dependabot/dependabot-alerts-filters.md index ebaff3a36ff7..8b39c698dda0 100644 --- a/translations/es-ES/data/reusables/dependabot/dependabot-alerts-filters.md +++ b/translations/es-ES/data/reusables/dependabot/dependabot-alerts-filters.md @@ -2,7 +2,7 @@ You can sort and filter {% data variables.product.prodname_dependabot_alerts %} | Opción | Descripción | Ejemplo | |:------------ |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ecosistema` | Displays alerts for the selected ecosystem | Use `ecosystem:npm` to show {% data variables.product.prodname_dependabot_alerts %} for npm |{% ifversion fpt or ghec or ghes > 3.5 %} +| `ecosistema` | Displays alerts for the selected ecosystem | Use `ecosystem:npm` to show {% data variables.product.prodname_dependabot_alerts %} for npm |{% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-7891 %} | `has` | Displays alerts meeting the selected filter criteria | Use `has:patch` to show alerts related to advisories that have a patch{% ifversion dependabot-alerts-vulnerable-calls %}
Use `has:vulnerable-calls` to show alerts relating to calls to vulnerable functions{% endif %} {% endif %} | `is` | Displays alerts based on their state | Use `is:open` to show open alerts | diff --git a/translations/es-ES/data/reusables/discussions/about-organization-discussions.md b/translations/es-ES/data/reusables/discussions/about-organization-discussions.md index 08628cb1216e..ab5e854cb597 100644 --- a/translations/es-ES/data/reusables/discussions/about-organization-discussions.md +++ b/translations/es-ES/data/reusables/discussions/about-organization-discussions.md @@ -1,5 +1,5 @@ -When you enable organization discussions, you will choose a repository in the organization to be the source repository for your organization discussions. You can use an existing repository or create a repository specifically to hold your organization discussions. Discussions will appear both on the discussions page for the organization and on the discussion page for the source repository. +Cuando habilitas los debates de organización, elegirás un repositorio en la organización para que sea el repositorio fuente para sus debates. Puedes utilizar un repositorio existente o crear uno específicamente para que almacene tus debates de organización. Los debates se mostrarán tanto en la página de debates de la organización como en la página de debates del repositorio fuente. -Permission to participate in or manage discussions in your organization is based on permission in the source repository. For example, a user needs write permission to the source repository in order to delete an organization discussion. This is identical to how a user needs write permission in a repository in order to delete a repository discussion. +El permiso para participar o administrar los debates de tu organización se basa en los permisos del repositorio fuente. Por ejemplo, los usuarios necesitan permisos de escritura en el repositorio fuente para borrar un debate de organización. Esto es idéntico a cómo un usuario necesita permisos de escritura en un repositorio para poder borrar un debate en este. -You can change the source repository at any time. If you change the source repository, discussions are not transferred to the new source repository. +Puedes cambiar el repositorio fuente en cualquier momento. Si cambias el repositorio fuente, los debates no se transferirán al repositorio fuente nuevo. diff --git a/translations/es-ES/data/reusables/discussions/enabling-or-disabling-github-discussions-for-your-organization.md b/translations/es-ES/data/reusables/discussions/enabling-or-disabling-github-discussions-for-your-organization.md index 557169cb55d8..3a5fb0806d96 100644 --- a/translations/es-ES/data/reusables/discussions/enabling-or-disabling-github-discussions-for-your-organization.md +++ b/translations/es-ES/data/reusables/discussions/enabling-or-disabling-github-discussions-for-your-organization.md @@ -1,5 +1,5 @@ 1. En {% data variables.product.product_location %}, navega a la página principal de tu organización. -1. Under your organization name, click {% octicon "gear" aria-label="The gear icon" %} **Settings**. ![Botón de configuración de organización](/assets/images/help/discussions/org-settings.png) -1. Under "Discussions", select **Enable discussions for this organization**. -1. Select a repository to use as the source repository for your organization discussions. ![Settings to enable discussions for an organization](/assets/images/help/discussions/enable-org-discussions.png) +1. Debajo del nombre de tu organización, haz clic en {% octicon "gear" aria-label="The gear icon" %} **Ajustes**. ![Botón de configuración de organización](/assets/images/help/discussions/org-settings.png) +1. Debajo de "Debates", selecciona **Habilitar los debates para esta organización**. +1. Selecciona un repositorio para utilizarlo como el repositorio fuente para los debates de tu organización. ![Ajustes para habilitar los debates para una organización](/assets/images/help/discussions/enable-org-discussions.png) 1. Haz clic en **Save ** (guardar). diff --git a/translations/es-ES/data/reusables/discussions/navigate-to-repo-or-org.md b/translations/es-ES/data/reusables/discussions/navigate-to-repo-or-org.md index 92670f998bcb..03b3938d6482 100644 --- a/translations/es-ES/data/reusables/discussions/navigate-to-repo-or-org.md +++ b/translations/es-ES/data/reusables/discussions/navigate-to-repo-or-org.md @@ -1 +1 @@ -1. On {% data variables.product.product_location %}, navigate to the main page of the repository or organization. +1. En {% data variables.product.product_location %}, navega a la página principal del repositorio u organización. diff --git a/translations/es-ES/data/reusables/discussions/starting-a-poll.md b/translations/es-ES/data/reusables/discussions/starting-a-poll.md index d4a5bd89a313..0771bfcc26bf 100644 --- a/translations/es-ES/data/reusables/discussions/starting-a-poll.md +++ b/translations/es-ES/data/reusables/discussions/starting-a-poll.md @@ -1,9 +1,9 @@ {% data reusables.repositories.navigate-to-repo %} {% data reusables.discussions.discussions-tab %} -1. In the list of categories, click **Polls**. ![Screenshot showing "Poll" category](/assets/images/help/discussions/poll-category.png) -1. On the right, click **Start poll**. ![Captura de pantalla que muestra el botón "Iniciar encuesta"](/assets/images/help/discussions/start-poll-button.png) -1. Type a title and optional body for your poll. ![Screenshot showing text fields for title and body](/assets/images/help/discussions/new-poll-title-and-body-fields.png) -1. Type a question for your poll. ![Screenshot showing text fields for the poll's question](/assets/images/help/discussions/new-poll-question.png) -1. Type at least two options for your poll. ![Screenshot showing text fields for the poll's options](/assets/images/help/discussions/new-poll-options.png) -1. Optionally, to add an extra poll option, click **Add an option**. ![Screenshot showing "Add an option" button](/assets/images/help/discussions/new-poll-add-option.png) -1. Click **Start poll**. ![Captura de pantalla que muestra el botón "Iniciar encuesta"](/assets/images/help/discussions/new-poll-start-poll-button.png) +1. En la lista de categorías, haz clic en **Encuestas**. ![Captura de pantalla que muestra la categoría de "Encuesta"](/assets/images/help/discussions/poll-category.png) +1. A la derecha, haz clic en **Iniciar encuesta**. ![Captura de pantalla que muestra el botón "Iniciar encuesta"](/assets/images/help/discussions/start-poll-button.png) +1. Escribe un título y un cuerpo opcional para tu encuesta. ![Captura de pantalla que muestra los campos de texto para el título y el cuerpo](/assets/images/help/discussions/new-poll-title-and-body-fields.png) +1. Escribe una pregunta para tu encuesta. ![Captura de pantalla que muestra los campos de texto para la pregunta de la encuesta](/assets/images/help/discussions/new-poll-question.png) +1. Escribe por lo menos dos opciones para tu encuesta. ![Captura de pantalla que muestra los campos de texto para las opciones de la encuesta](/assets/images/help/discussions/new-poll-options.png) +1. Opcionalmente, para agregar una opción de encuesta adicional, haz clic en **Agregar una opción**. ![Captura de pantalla que muestra el botón "Agregar una opción"](/assets/images/help/discussions/new-poll-add-option.png) +1. Haz clic en **Iniciar encuesta**. ![Captura de pantalla que muestra el botón "Iniciar encuesta"](/assets/images/help/discussions/new-poll-start-poll-button.png) diff --git a/translations/es-ES/data/reusables/education/access-github-community-exchange.md b/translations/es-ES/data/reusables/education/access-github-community-exchange.md index 315f709fbeda..bea8e637fc00 100644 --- a/translations/es-ES/data/reusables/education/access-github-community-exchange.md +++ b/translations/es-ES/data/reusables/education/access-github-community-exchange.md @@ -4,4 +4,4 @@ If you're a student or faculty member at an accredited educational institution, - If you’re a student and you haven't joined {% data variables.product.prodname_education %} yet, apply using the [student application form](https://education.github.com/discount_requests/student_application). For more information, see "[About {% data variables.product.prodname_global_campus %} for students](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students)." -- If you’re an educator and you haven't joined {% data variables.product.prodname_education %} yet, apply using the [teacher application form](https://education.github.com/discount_requests/teacher_application). For more information, see "[Apply to {% data variables.product.prodname_global_campus %} as a teacher](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)." +- If you’re an educator and you haven't joined {% data variables.product.prodname_education %} yet, apply using the [teacher application form](https://education.github.com/discount_requests/teacher_application). Para obtener más información, consulta la sección "[Solicitar ingresar al {% data variables.product.prodname_global_campus %} como docente](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)". diff --git a/translations/es-ES/data/reusables/education/apply-for-team.md b/translations/es-ES/data/reusables/education/apply-for-team.md index 46384e288621..f34afbc02a15 100644 --- a/translations/es-ES/data/reusables/education/apply-for-team.md +++ b/translations/es-ES/data/reusables/education/apply-for-team.md @@ -1 +1 @@ -- Solicita gratis [{% data variables.product.prodname_team %}](/articles/github-s-products), que permite tener ilimitados usuarios y repositorios privados. For more information, see "[Apply to {% data variables.product.prodname_global_campus %} as a teacher](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)." +- Solicita gratis [{% data variables.product.prodname_team %}](/articles/github-s-products), que permite tener ilimitados usuarios y repositorios privados. Para obtener más información, consulta la sección "[Solicitar ingresar al {% data variables.product.prodname_global_campus %} como docente](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)". diff --git a/translations/es-ES/data/reusables/enterprise-accounts/emu-cap-validates.md b/translations/es-ES/data/reusables/enterprise-accounts/emu-cap-validates.md index 0f5e2fb0f4e0..bc24aa3b1e19 100644 --- a/translations/es-ES/data/reusables/enterprise-accounts/emu-cap-validates.md +++ b/translations/es-ES/data/reusables/enterprise-accounts/emu-cap-validates.md @@ -1 +1 @@ -When your enterprise uses OIDC SSO, {% data variables.product.prodname_dotcom %} will automatically use your IdP's conditional access policy (CAP) IP conditions to validate user interactions with {% data variables.product.prodname_dotcom %}, when members change IP addresses, and each time a personal access token or SSH key is used. +Cuando tu empresa utiliza el SSO de OIDC, {% data variables.product.prodname_dotcom %} utilizará automáticamente las condiciones de IP de la política de acceso condicional (CAP) de tu IdP para validar las interacciones de los usuarios con {% data variables.product.prodname_dotcom %}, cuando los miembros cambien sus direcciones IP y cada que se utilice un token de acceso personal o llave SSH. diff --git a/translations/es-ES/data/reusables/enterprise/about-github-for-enterprises.md b/translations/es-ES/data/reusables/enterprise/about-github-for-enterprises.md index eec503fbd5a2..611ea65ab9ab 100644 --- a/translations/es-ES/data/reusables/enterprise/about-github-for-enterprises.md +++ b/translations/es-ES/data/reusables/enterprise/about-github-for-enterprises.md @@ -1 +1 @@ -For more information about how businesses can use {% data variables.product.company_short %}'s products to support their software development lifecycle, see "[About {% data variables.product.prodname_dotcom %} for enterprises](/admin/overview/about-github-for-enterprises)." \ No newline at end of file +Para obtener más información sobre cómo nuestros negocios pueden utilizar los productos de {% data variables.product.company_short %} para apoyar su ciclo de desarrollo de software, consulta la sección "[Acerca de {% data variables.product.prodname_dotcom %} para empresas](/admin/overview/about-github-for-enterprises)". \ No newline at end of file diff --git a/translations/es-ES/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md b/translations/es-ES/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md index c5d610006352..d9e308eee95d 100644 --- a/translations/es-ES/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md +++ b/translations/es-ES/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md @@ -1,4 +1,4 @@ -1. Define the key as a environment variable for {% data variables.product.product_name %}, replacing `` with the GPG key ID. +1. Define the key as an environment variable for {% data variables.product.product_name %}, replacing `` with the GPG key ID. ```bash{:copy} ghe-config "secrets.gpgverify.web-signing-key" "$(gpg --export-secret-keys -a | awk '{printf "%s\\n", $0}')" diff --git a/translations/es-ES/data/reusables/gated-features/codespaces-classroom-articles.md b/translations/es-ES/data/reusables/gated-features/codespaces-classroom-articles.md index 924aac0d15d9..fb0f2fcb072f 100644 --- a/translations/es-ES/data/reusables/gated-features/codespaces-classroom-articles.md +++ b/translations/es-ES/data/reusables/gated-features/codespaces-classroom-articles.md @@ -1 +1 @@ -Codespaces is available to use with {% data variables.product.prodname_classroom %} for organizations that use {% data variables.product.prodname_team %}. To find out if you qualify for a free upgrade to {% data variables.product.prodname_team %}, see "[Apply to {% data variables.product.prodname_global_campus %} as a teacher](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)." +Codespaces is available to use with {% data variables.product.prodname_classroom %} for organizations that use {% data variables.product.prodname_team %}. Para saber si calificas para una mejora a {% data variables.product.prodname_team %}, consulta la secciòn "[Solicitar entrar al {% data variables.product.prodname_global_campus %} como docente](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)". diff --git a/translations/es-ES/data/reusables/gated-features/hosted-runners.md b/translations/es-ES/data/reusables/gated-features/hosted-runners.md new file mode 100644 index 000000000000..4f1e2137bbfb --- /dev/null +++ b/translations/es-ES/data/reusables/gated-features/hosted-runners.md @@ -0,0 +1 @@ +The {% data variables.actions.hosted_runner %}s feature is currently in beta for organizations and enterprises using the {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %} plans, and is subject to change. \ No newline at end of file diff --git a/translations/es-ES/data/reusables/getting-started/bearer-vs-token.md b/translations/es-ES/data/reusables/getting-started/bearer-vs-token.md new file mode 100644 index 000000000000..9dd0b62adaba --- /dev/null +++ b/translations/es-ES/data/reusables/getting-started/bearer-vs-token.md @@ -0,0 +1 @@ +In most cases, you can use `Authorization: Bearer` or `Authorization: token` to pass a token. However, if you are passing a JSON web token (JWT), you must use `Authorization: Bearer`. \ No newline at end of file diff --git a/translations/es-ES/data/reusables/gpg/copy-gpg-key-id.md b/translations/es-ES/data/reusables/gpg/copy-gpg-key-id.md index e075c5dd1a57..b10e58d80c43 100644 --- a/translations/es-ES/data/reusables/gpg/copy-gpg-key-id.md +++ b/translations/es-ES/data/reusables/gpg/copy-gpg-key-id.md @@ -1,9 +1,9 @@ 1. Desde la lista de llaves GPG, compia la forma larga de la ID de la llave GPG que quieres utilizar. En este ejemplo, el ID de la llave GPG es `3AA5C34371567BD2`: - ```shell + ```shell{:copy} $ gpg --list-secret-keys --keyid-format=long /Users/hubot/.gnupg/secring.gpg ------------------------------------ sec 4096R/3AA5C34371567BD2 2016-03-10 [expires: 2017-03-10] uid Hubot ssb 4096R/42B317FD4BA89E7A 2016-03-10 - ``` + ``` diff --git a/translations/es-ES/data/reusables/gpg/list-keys-with-note.md b/translations/es-ES/data/reusables/gpg/list-keys-with-note.md index 9e243ce57263..64b0a703f979 100644 --- a/translations/es-ES/data/reusables/gpg/list-keys-with-note.md +++ b/translations/es-ES/data/reusables/gpg/list-keys-with-note.md @@ -1,10 +1,11 @@ - 1. Utiliza el comando `gpg --list-secret-keys --keyid-format=long` para enumerar la forma larga de las llaves GPG para las cuales tienes tanto una llave pública como una privada. Se requiere una llave privada para registrar confirmaciones o etiquetas. - ```shell - $ gpg --list-secret-keys --keyid-format=long -``` - {% note %} - **Nota:** Algunas instalaciones GPG en Linux pueden requerir que uses `gpg2 --list-keys --keyid-format LONG` para visualizar una lista de tus llaves existentes en su lugar. En este caso también deberás configurar Git para que use `gpg2` by running `git config --global gpg.program gpg2`. + ```shell{:copy} + $ gpg --list-secret-keys --keyid-format=long + ``` + + {% note %} + + **Nota:** Algunas instalaciones GPG en Linux pueden requerir que uses `gpg2 --list-keys --keyid-format LONG` para visualizar una lista de tus llaves existentes en su lugar. En este caso también deberás configurar Git para que use `gpg2` by running `git config --global gpg.program gpg2`. - {% endnote %} + {% endnote %} diff --git a/translations/es-ES/data/reusables/identity-and-permissions/ipv6-allow-lists.md b/translations/es-ES/data/reusables/identity-and-permissions/ipv6-allow-lists.md new file mode 100644 index 000000000000..3c26491fe2fb --- /dev/null +++ b/translations/es-ES/data/reusables/identity-and-permissions/ipv6-allow-lists.md @@ -0,0 +1,7 @@ +{% ifversion fpt or ghec %} +{% note %} + +**Note:** {% data variables.product.company_short %} is gradually rolling out support for IPv6. As {% data variables.product.prodname_dotcom %} services continue to add IPv6 support, we will start recognizing IPv6 addresses of {% data variables.product.prodname_dotcom %} users. To prevent possible access interruptions, please ensure you have added any necessary IPv6 addresses to your IP allow list. + +{% endnote %} +{% endif %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/organizations/about-following-organizations.md b/translations/es-ES/data/reusables/organizations/about-following-organizations.md new file mode 100644 index 000000000000..52e52467fbf5 --- /dev/null +++ b/translations/es-ES/data/reusables/organizations/about-following-organizations.md @@ -0,0 +1 @@ +When you follow organizations on {% data variables.product.product_name %}, you'll see their {% ifversion fpt or ghec %}public{% endif %} activity on your personal dashboard. This activity includes new discussions, sponsorships, and repositories. \ No newline at end of file diff --git a/translations/es-ES/data/reusables/organizations/follow-organizations-beta.md b/translations/es-ES/data/reusables/organizations/follow-organizations-beta.md new file mode 100644 index 000000000000..8d9ef03cd11f --- /dev/null +++ b/translations/es-ES/data/reusables/organizations/follow-organizations-beta.md @@ -0,0 +1,5 @@ +{% note %} + +**Nota:** La capacidad de seguir organizaciones se encuentra actualmente en beta público y está sujeta a cambios. + +{% endnote %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/package_registry/authenticate-packages.md b/translations/es-ES/data/reusables/package_registry/authenticate-packages.md index a766f6e96d9f..5ca4e91584b2 100644 --- a/translations/es-ES/data/reusables/package_registry/authenticate-packages.md +++ b/translations/es-ES/data/reusables/package_registry/authenticate-packages.md @@ -4,4 +4,4 @@ You can use a personal access token (PAT) to authenticate to {% data variables.p To authenticate to a {% data variables.product.prodname_registry %} registry within a {% data variables.product.prodname_actions %} workflow, you can use: - `GITHUB_TOKEN` to publish packages associated with the workflow repository. -- a PAT to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). +- a PAT with at least `packages:read` scope to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). diff --git a/translations/es-ES/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md b/translations/es-ES/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md deleted file mode 100644 index 710a154d365e..000000000000 --- a/translations/es-ES/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md +++ /dev/null @@ -1,11 +0,0 @@ -{% ifversion fpt or ghec or ghes > 3.4 %} - -Para autenticarse en el {% data variables.product.prodname_container_registry %} dentro de un flujo de trabajo de {% data variables.product.prodname_actions %}, utiliza el `GITHUB_TOKEN` para tener la mejor experiencia en seguridad. Si tu flujo de trabajo utiliza un token de acceso personal (PAT) para autenticarse en `{% data reusables.package_registry.container-registry-hostname %}`, entonces te recomendamos ampliamente que lo actualices para que utilice el `GITHUB_TOKEN`. - -{% ifversion fpt or ghec %}Para obtener orientación sobre cómo actualizar tus flujos de trabajo que se autentican con `{% data reusables.package_registry.container-registry-hostname %}` con un token de acceso personal, consulta la sección "[Actualizar un flujo de trab ajo que accede a `ghcr.io`](/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions#upgrading-a-workflow-that-accesses-ghcrio)".{% endif %} - -Para obtener más información sobre el `GITHUB_TOKEN`, consulta la sección "[Autenticación en un flujo de trabajo](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)". - -Si estás utilizando el {% data variables.product.prodname_container_registry %} en las acciones, sigue nuestras mejores prácticas de seguridad en "[Fortalecimiento de seguridad para las Acciones de GitHub](/actions/getting-started-with-github-actions/security-hardening-for-github-actions#considering-cross-repository-access)". - -{% endif %} diff --git a/translations/es-ES/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md b/translations/es-ES/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md new file mode 100644 index 000000000000..520a91c938ac --- /dev/null +++ b/translations/es-ES/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md @@ -0,0 +1,7 @@ +If your workflow is using a personal access token (PAT) to authenticate to a registry, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. + +{% ifversion fpt or ghec %}For guidance on updating your workflows that authenticate to a registry with a personal access token, see "[Upgrading a workflow that accesses a registry using a PAT](/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions#upgrading-a-workflow-that-accesses-a-registry-using-a-pat)."{% endif %} + +Para obtener más información sobre el `GITHUB_TOKEN`, consulta la sección "[Autenticación en un flujo de trabajo](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)". + +For more information about the best practises when using a registry in actions, see "[Security hardening for GitHub Actions](/actions/getting-started-with-github-actions/security-hardening-for-github-actions#considering-cross-repository-access)." diff --git a/translations/es-ES/data/reusables/package_registry/container-registry-migration-namespaces.md b/translations/es-ES/data/reusables/package_registry/container-registry-migration-namespaces.md index 9d7d0dc5e03e..ecb450e5a1c1 100644 --- a/translations/es-ES/data/reusables/package_registry/container-registry-migration-namespaces.md +++ b/translations/es-ES/data/reusables/package_registry/container-registry-migration-namespaces.md @@ -1 +1 @@ -Any scripts or {% data variables.product.prodname_actions %} workflows that use the namespace for the Docker registry, {% data variables.product.prodname_docker_registry_namespace %}, will continue to work after migration to the {% data variables.product.prodname_container_registry %} at {% data variables.product.prodname_container_registry_namespace %}. +Cualquier script o flujo de trabajo de {% data variables.product.prodname_actions %} que utilice un designador de nombre para el registro de Docker, {% data variables.product.prodname_docker_registry_namespace %}, seguirá funcionando después de su migración al {% data variables.product.prodname_container_registry %} en {% data variables.product.prodname_container_registry_namespace %}. diff --git a/translations/es-ES/data/reusables/package_registry/no-graphql-to-delete-packages.md b/translations/es-ES/data/reusables/package_registry/no-graphql-to-delete-packages.md new file mode 100644 index 000000000000..cbab609f2b0e --- /dev/null +++ b/translations/es-ES/data/reusables/package_registry/no-graphql-to-delete-packages.md @@ -0,0 +1 @@ +{% ifversion fpt or ghec %} The {% data variables.product.prodname_registry %} GraphQL API does not support containers or Docker images that use the package namespace `https://ghcr.io/OWNER/PACKAGE-NAME`, or npm images that use the package namespace `https://npm.pkg.github.com/OWNER/PACKAGE-NAME`.{% endif %} \ No newline at end of file diff --git a/translations/es-ES/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md b/translations/es-ES/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md index ae12fb49076e..55805f43225d 100644 --- a/translations/es-ES/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md +++ b/translations/es-ES/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md @@ -1,16 +1,16 @@ -{% ifversion ghes > 3.1 or ghes < 3.5 %} +{% ifversion ghes < 3.5 %} -In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server 3.5 or later may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 when you upgrade from an earlier release to 3.5 or later. A fix for 3.5 and later will be available in an upcoming patch release. +In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server 3.5 or later may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 when you upgrade from an earlier release to 3.5 or later. A fix is available in the [3.5.5](/enterprise-server@3.5/admin/release-notes#3.5.5) and [3.6.1](/enterprise-server@3.6/admin/release-notes#3.6.1) patch releases. -To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). [Updated: 2022-08-16] +To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). [Updated: 2022-09-01] -{% elsif ghes > 3.4 or ghes < 3.7 %} +{% elsif ghes = 3.5 or ghes = 3.6 %} -In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server {{ currentVersion }} may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 as you upgrade to the latest release. To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). +In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server {{ allVersions[currentVersion].currentRelease }} may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 as you upgrade to the latest release. To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). - To display the missing alerts for all repositories owned by an organization, organization owners can navigate to the organization's **Code security and analysis** settings, then click **Enable all** for secret scanning. Para obtener más información, consulta la sección "[Administrar la configuración de análisis y seguridad para tu organización](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-existing-repositories)". - To display the missing alerts for an individual repository, people with admin access to the repository can disable then enable secret scanning for the repository. Para obtener más información, consulta la sección "[Administrar la configuración de seguridad y análisis para tu repositorio](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)". -A fix will be available in an upcoming patch release. [Updated: 2022-08-16] +A fix is available in the {% ifversion ghes = 3.5 %}[3.5.5](/admin/release-notes#3.5.5){% elsif ghes = 3.6 %}[3.6.1](/admin/release-notes#3.6.1){% endif %} patch release. [Updated: 2022-09-01] {% endif %} diff --git a/translations/es-ES/data/reusables/repositories/anyone-can-view-anonymized-url.md b/translations/es-ES/data/reusables/repositories/anyone-can-view-anonymized-url.md index 1609e74415fe..6f8739557f21 100644 --- a/translations/es-ES/data/reusables/repositories/anyone-can-view-anonymized-url.md +++ b/translations/es-ES/data/reusables/repositories/anyone-can-view-anonymized-url.md @@ -1,5 +1,5 @@ {% warning %} -**Warning:** If you attach a file to a pull request, issue comment, or ticket in the {% data variables.contact.support_portal %}, anyone can view the anonymized URL without authentication, even if the pull request is in a private repository{% ifversion ghes %}, or if private mode is enabled{% endif %}. Para mantener privados archivos de medios sensibles, estos se deben servir desde una red o servidor privados que requieran autenticación. {% ifversion fpt or ghec %}Para obtener más información sobre las URL anonimizadas, consulta la sección "[Acerca de las URL anonimizadas](/github/authenticating-to-github/about-anonymized-urls)".{% endif %} +**Advertencia:** Si adjuntas un archivo a una solicitud de cambios, comentario de propuesta o ticket en el {% data variables.contact.support_portal %}, cualquiera podrá ver la URL anonimizada sin autenticación, incluso si la solicitud de cambios se encuentra en un repositorio privado{% ifversion ghes %} o si se habilita el modo privado{% endif %}. Para mantener privados archivos de medios sensibles, estos se deben servir desde una red o servidor privados que requieran autenticación. {% ifversion fpt or ghec %}Para obtener más información sobre las URL anonimizadas, consulta la sección "[Acerca de las URL anonimizadas](/github/authenticating-to-github/about-anonymized-urls)".{% endif %} {% endwarning %} diff --git a/translations/es-ES/data/reusables/secret-scanning/secret-list-private-push-protection.md b/translations/es-ES/data/reusables/secret-scanning/secret-list-private-push-protection.md index ddb0eac1f8b2..c143ad8609f9 100644 --- a/translations/es-ES/data/reusables/secret-scanning/secret-list-private-push-protection.md +++ b/translations/es-ES/data/reusables/secret-scanning/secret-list-private-push-protection.md @@ -21,6 +21,6 @@ ReadMe | Llave de Acceso de la API de ReadMe API | readmeio_api_access_token{% e {%- ifversion fpt or ghec or ghes > 3.5 or ghae-issue-7375 %} redirect.pizza | Token de la API de redirect.pizza | redirect_pizza_api_token{% endif %} Samsara | Token de la API de Samsara | samsara_api_token Samsara | Token de Acceso OAuth a Samsara | samsara_oauth_access_token SendGrid | Llave de la API de SendGrid | sendgrid_api_key Sendinblue | Llave de la API de Sendinblue | sendinblue_api_key Sendinblue | Llave SMTP de Sendinblue | sendinblue_smtp_key Shippo | Token de la API en Vivo de Shippo | shippo_live_api_token Shopify | Secreto Compartido de la Aplicación de Shopify | shopify_app_shared_secret Shopify | Token de Acceso a Shopify | shopify_access_token Slack | Token de la API de Slack | slack_api_token Stripe | Llave Secreta de la API en Vivo de Stripe | stripe_api_key Tencent Cloud | ID Secreta de la Nube de Tencent | tencent_cloud_secret_id Typeform | Token de Acceso Personal a Typeform | typeform_personal_access_token {%- ifversion fpt or ghec or ghes > 3.6 or ghae-issue-7456 %} -Uniwise | WISEflow API Key | wiseflow_api_key{% endif %} WorkOS | WorkOS Production API Key | workos_production_api_key +Uniwise | Llave de la API de WISEflow | wiseflow_api_key{% endif %} WorkOS | Llave de la API de Producción de WorkOS | workos_production_api_key {%- ifversion fpt or ghec or ghes > 3.6 or ghae-issue-7456 %} Zuplo | Llave de la API de Consumidor de Zuplo | zuplo_consumer_api_key{% endif %} diff --git a/translations/es-ES/data/variables/actions.yml b/translations/es-ES/data/variables/actions.yml index 4fa066176384..f8f4dda96f1a 100644 --- a/translations/es-ES/data/variables/actions.yml +++ b/translations/es-ES/data/variables/actions.yml @@ -1,2 +1,3 @@ --- azure_portal: 'Portal de Azure' +hosted_runner: 'larger runner' diff --git a/translations/es-ES/data/variables/product.yml b/translations/es-ES/data/variables/product.yml index 7b77bbbe9dc8..6f536b54b165 100644 --- a/translations/es-ES/data/variables/product.yml +++ b/translations/es-ES/data/variables/product.yml @@ -112,6 +112,10 @@ prodname_registry: 'Registro del paquete de GitHub' prodname_container_registry: 'Registro de contenedores' prodname_docker_registry_namespace: '{% ifversion fpt or ghec %}`docker.pkg.github.com`{% elsif ghes or ghae %}docker.HOSTNAME{% endif %}' prodname_container_registry_namespace: '{% ifversion fpt or ghec %}`ghcr.io`{% elsif ghes or ghae %}containers.HOSTNAME{% endif %}' +prodname_npm_registry: 'Registro de npm' +prodname_ghcr_and_npm_registry: '{% data variables.product.prodname_container_registry %}{% ifversion packages-npm-v2 %} y {% data variables.product.prodname_npm_registry %}{% endif %}' +prodname_ghcr_or_npm_registry: '{% data variables.product.prodname_container_registry %}{% ifversion packages-npm-v2 %} o {% data variables.product.prodname_npm_registry %}{% endif %}' +prodname_ghcr_and_npm_registry_full: '{% data variables.product.prodname_container_registry %} (`ghcr.io`){% ifversion packages-npm-v2 %} y {% data variables.product.prodname_npm_registry %} (`npm.pkg.github.com`){% endif %}' #GitHub Insights prodname_insights: 'GitHub Insights' #GitHub Sponsors diff --git a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md index c38de0412414..d178f3f0f770 100644 --- a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md +++ b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md @@ -25,6 +25,7 @@ children: - /managing-the-default-branch-name-for-your-repositories - /managing-security-and-analysis-settings-for-your-personal-account - /managing-access-to-your-personal-accounts-project-boards + - /managing-your-cookie-preferences-for-githubs-enterprise-marketing-pages - /integrating-jira-with-your-personal-projects - /what-does-the-available-for-hire-checkbox-do shortTitle: Personal account settings diff --git a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-cookie-preferences-for-githubs-enterprise-marketing-pages.md b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-cookie-preferences-for-githubs-enterprise-marketing-pages.md new file mode 100644 index 000000000000..fe7d98bd6de5 --- /dev/null +++ b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-cookie-preferences-for-githubs-enterprise-marketing-pages.md @@ -0,0 +1,33 @@ +--- +title: Managing your cookie preferences for GitHub's enterprise marketing pages +intro: 'You can control how {% data variables.product.company_short %} uses information from non-essential tracking cookies for enterprise marketing pages.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - Accounts +shortTitle: Manage cookie preferences +--- + +## About cookie preferences on enterprise marketing pages + +{% data variables.product.company_short %} may use non-essential cookies on some enterprise marketing pages. You can customize how these cookies behave. For more information about how {% data variables.product.company_short %} uses cookies, see "[{% data variables.product.company_short %} Privacy Statement](/free-pro-team@latest/site-policy/privacy-policies/github-privacy-statement)." + +## Changing your cookie preferences + +You can customize how non-essential cookies behave on any {% data variables.product.company_short %} enterprise marketing page. + +1. Navigate to the {% data variables.product.company_short %} enterprise marketing page where you'd like to change your cookie preferences. For example, navigate to [{% data variables.product.company_short %} Resources](https://resources.github.com/). +1. Scroll to the bottom of the page, then click **Manage Cookies**. + + ![Screenshot of button to manage cookie settings.](/assets/images/help/settings/cookie-settings-manage.png) + +1. Under "Manage cookie preferences," to accept or reject each non-essential cookie, click **Accept** or **Reject**. + + ![Screenshot of radio buttons to choose "Accept" or "Reject" for non-essential cookies.](/assets/images/help/settings/cookie-settings-accept-or-reject.png) + +1. [**Save changes**] をクリックします。 + + ![Screenshot of button to save changes.](/assets/images/help/settings/cookie-settings-save.png) diff --git a/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md b/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md index e0ac8e26b227..965e09780e4d 100644 --- a/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md +++ b/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md @@ -147,11 +147,11 @@ With OIDC, a {% data variables.product.prodname_actions %} workflow requires a t Audience and Subject claims are typically used in combination while setting conditions on the cloud role/resources to scope its access to the GitHub workflows. - **Audience**: By default, this value uses the URL of the organization or repository owner. This can be used to set a condition that only the workflows in the specific organization can access the cloud role. -- **Subject**: Has a predefined format and is a concatenation of some of the key metadata about the workflow, such as the {% data variables.product.prodname_dotcom %} organization, repository, branch, or associated [`job`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idenvironment) environment. See "[Example subject claims](#example-subject-claims)" to see how the subject claim is assembled from concatenated metadata. +- **Subject**: By default, has a predefined format and is a concatenation of some of the key metadata about the workflow, such as the {% data variables.product.prodname_dotcom %} organization, repository, branch, or associated [`job`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idenvironment) environment. See "[Example subject claims](#example-subject-claims)" to see how the subject claim is assembled from concatenated metadata. -There are also many additional claims supported in the OIDC token that can also be used for setting these conditions. +If you need more granular trust conditions, you can customize the issuer (`iss`) and subject (`sub`) claims that are included with the JWT. For more information, see "[Customizing the token claims](#customizing-the-token-claims)". -In addition, your cloud provider could allow you to assign a role to the access tokens, letting you specify even more granular permissions. +There are also many additional claims supported in the OIDC token that can be used for setting these conditions. In addition, your cloud provider could allow you to assign a role to the access tokens, letting you specify even more granular permissions. {% note %} @@ -245,9 +245,13 @@ curl -H "Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" "$ACTIONS_ID_TOK {% ifversion actions-oidc-hardening-config %} ## Customizing the token claims -You can security harden your OIDC configuration by customizing the claims that are included with the JWT. This allows your cloud provider to apply more granular trust conditions when determining whether to grant access to its resources. For example, {% ifversion ghec %}you can customize the issuer (`iss`) claim to only allow access from a specific enterprise URL, and {% endif %}you can customize the subject (`sub`) value to require that requests originate from a specific repository, reusable workflow, or other source. +You can security harden your OIDC configuration by customizing the claims that are included with the JWT. These customisations allow you to define more granular trust conditions on your cloud roles when allowing your workflows to access resources hosted in the cloud: -To configure the claim conditions on {% data variables.product.prodname_dotcom %}, you can use the REST API endpoints described in the following sections. +{% ifversion ghec %} - For an additional layer of security, you can append the `issuer` url with your enterprise slug. This lets you set conditions on the issuer (`iss`) claim, configuring it to only accept JWT tokens from a unique `issuer` URL that must include your enterprise slug.{% endif %} +- You can standardize your OIDC configuration by setting conditions on the subject (`sub`) claim that require JWT tokens to originate from a specific repository, reusable workflow, or other source. +- You can define granular OIDC policies by using additional OIDC token claims, such as `repository_id` and `repo_visibility`. For more information, see "[Understanding the OIDC token](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#understanding-the-oidc-token)". + +To customize these claim formats, organization and repository admins can use the REST API endpoints described in the following sections. {% ifversion ghec %} @@ -282,19 +286,21 @@ After this setting is applied, the JWT will contain the updated `iss` value. In To configure organization-wide security, compliance, and standardization, you can customize the standard claims to suit your required access conditions. If your cloud provider supports conditions on subject claims, you can create a condition that checks whether the `sub` value matches the path of the reusable workflow, such as `"job_workflow_ref: "octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main""`. The exact format will vary depending on your cloud provider's OIDC configuration. To configure the matching condition on {% data variables.product.prodname_dotcom %}, you can can use the REST API to require that the `sub` claim must always include a specific custom claim, such as `job_workflow_ref`. For more information, see "[Set the customization template for an OIDC subject claim for an organization](/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization)." +Customizing the claims results in a new format for the entire `sub` claim, which replaces the default predefined `sub` format in the token described in "[Example subject claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims)." + The following example templates demonstrate various ways to customize the subject claim. To configure these settings on {% data variables.product.prodname_dotcom %}, organization admins use the REST API to specify a list of claims that must be included in the subject (`sub`) claim. {% data reusables.actions.use-request-body-api %} -To customize your subject claims, you should first create a matching condition in your cloud provider's OIDC configuration, before adding the configuration using the REST API. Once the configuration is completed, each time a new job runs, the OIDC token generated during that job will follow the new customization template. If the matching condition doesn't exist in the cloud provider's OIDC configuration before the job runs, the generated token might not be accepted by the cloud provider, since the cloud conditions may not be synchronized. +To customize your subject claims, you should first create a matching condition in your cloud provider's OIDC configuration, before customizing the configuration using the REST API. Once the configuration is completed, each time a new job runs, the OIDC token generated during that job will follow the new customization template. If the matching condition doesn't exist in the cloud provider's OIDC configuration before the job runs, the generated token might not be accepted by the cloud provider, since the cloud conditions may not be synchronized. {% note %} -**Note**: When the organization template is applied, it will not affect any existing repositories that already use OIDC. For new repositories that are created after the template has been applied, the repository owner will need to opt-in to receive this configuration. For more information, see "[Set the opt-in flag of an OIDC subject claim customization for a repository](/rest/actions/oidc#set-the-opt-in-flag-of-an-oidc-subject-claim-customization-for-a-repository)." +**Note**: When the organization template is applied, it will not affect any existing repositories that already use OIDC. For existing repositories, as well as any new repositories that are created after the template has been applied, the repository owner will need to opt-in to receive this configuration. For more information, see "[Set the opt-in flag of an OIDC subject claim customization for a repository](/rest/actions/oidc#set-the-opt-in-flag-of-an-oidc-subject-claim-customization-for-a-repository)." {% endnote %} #### Example: Allowing repository based on visibility and owner -This example template enables cloud access based on repository visibility and owner, letting you restrict cloud role access to only private repositories within an organization or enterprise. {% data reusables.actions.use-request-body-api %} +This example template allows the `sub` claim to have a new format, using `repository_owner` and `repository_visibility`: ```json { @@ -305,11 +311,11 @@ This example template enables cloud access based on repository visibility and ow } ``` -In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include specific values for `repository_owner` and `repository_visibility`. For example: `"repository_owner: "monalisa":repository_visibility:private"`. +In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include specific values for `repository_owner` and `repository_visibility`. For example: `"repository_owner: "monalisa":repository_visibility:private"`. The approach lets you restrict cloud role access to only private repositories within an organization or enterprise. #### Example: Allowing access to all repositories with a specific owner -This example template grants access to all repositories with a specified `repository_owner`. {% data reusables.actions.use-request-body-api %} +This example template enables the `sub` claim to have a new format with only the value of `repository_owner`. {% data reusables.actions.use-request-body-api %} ```json { @@ -324,7 +330,9 @@ In your cloud provider's OIDC configuration, configure the `sub` condition to re #### Example: Requiring a reusable workflow -This example template requires a specific reusable workflow in a claim, letting an enterprise enforce consistent deployments across its enterprise, organizations, and repositories. {% data reusables.actions.use-request-body-api %} +This example template allows the `sub` claim to have a new format that contains the value of the `job_workflow_ref` claim. This enables an enterprise to use [reusable workflows](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims) to enforce consistent deployments across its organizations and repositories. + +{% data reusables.actions.use-request-body-api %} ```json { @@ -338,7 +346,9 @@ In your cloud provider's OIDC configuration, configure the `sub` condition to re #### Example: Requiring a reusable workflow and other claims -This example template combines the requirement of a specific reusable workflow with additional claims. {% data reusables.actions.use-request-body-api %} +The following example template combines the requirement of a specific reusable workflow with additional claims. {% data reusables.actions.use-request-body-api %} + +This example also demonstrates how to use `"context"` to define your conditions. This is the part that follows the repository in the [default `sub` format](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims). For example, when the job references an environment, the context contains: `environment:`. ```json { @@ -352,6 +362,8 @@ This example template combines the requirement of a specific reusable workflow w In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include specific values for `repo`, `context`, and `job_workflow_ref`. +This customization template requires that the `sub` uses the following format: `repo::environment::job_workflow_ref:`. For example: `"sub": "repo:octo-org/octo-repo:environment:prod:job_workflow_ref:octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main"` + #### Example: Granting access to a specific repository This example template lets you grant cloud access to all the workflows in a specific repository, across all branches/tags and environments. To help improve security, combine this template with the custom issuer URL described in "[Customizing the token URL for an enterprise](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-url-for-an-enterprise)." diff --git a/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md b/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md index b481d6a0a57c..e7837358461f 100644 --- a/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md +++ b/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md @@ -23,11 +23,18 @@ topics: Rather than copying and pasting deployment jobs from one workflow to another, you can create a reusable workflow that performs the deployment steps. A reusable workflow can be used by another workflow if it meets one of the access requirements described in "[Reusing workflows](/actions/learn-github-actions/reusing-workflows#access-to-reusable-workflows)." -When combined with OpenID Connect (OIDC), reusable workflows let you enforce consistent deployments across your repository, organization, or enterprise. You can do this by defining trust conditions on cloud roles based on reusable workflows. +You should be familiar with the concepts described in "\[Reusing workflows\](/actions/learn-github-actions/reusing-workflows" and "[About security hardening with OpenID Connect](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)." -In order to create trust conditions based on reusable workflows, your cloud provider must support custom claims for `job_workflow_ref`. This allows your cloud provider to identify which repository the job originally came from. If your cloud provider only supports the standard claims (_audience_ and _subject_), it will not be able to determine that the job originated from the reusable workflow repository. Cloud providers that support `job_workflow_ref` include Google Cloud Platform and HashiCorp Vault. +## Defining the trust conditions -Before proceeding, you should be familiar with the concepts of [reusable workflows](/actions/learn-github-actions/reusing-workflows) and [OpenID Connect](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect). +When combined with OpenID Connect (OIDC), reusable workflows let you enforce consistent deployments across your repository, organization, or enterprise. You can do this by defining trust conditions on cloud roles based on reusable workflows. The available options will vary depending on your cloud provider: + +- **Using `job_workflow_ref`**: + - To create trust conditions based on reusable workflows, your cloud provider must support custom claims for `job_workflow_ref`. This allows your cloud provider to identify which repository the job originally came from. + - For clouds that only support the standard claims (audience (`aud`) and subject (`sub`)), you can use the API to customize the `sub` claim to include `job_workflow_ref`. For more information, see "[Customizing the token claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-claims)". Support for custom claims is currently available for Google Cloud Platform and HashiCorp Vault. + +- **Customizing the token claims**: + - You can configure more granular trust conditions by customizing the issuer (`iss`) and subject (`sub`) claims included with the JWT. For more information, see "[Customizing the token claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-claims)". ## How the token works with reusable workflows diff --git a/translations/ja-JP/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md b/translations/ja-JP/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md index e12049abca64..7c7e5c863a1c 100644 --- a/translations/ja-JP/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md +++ b/translations/ja-JP/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md @@ -72,7 +72,7 @@ You can set up automation to scale the number of self-hosted runners. For more i {% data reusables.organizations.navigate-to-org %} {% data reusables.organizations.org_settings %} {% data reusables.organizations.settings-sidebar-actions-runners %} -1. [**New runner**]をクリックしてください。 +{% ifversion actions-hosted-runners %}1. Click **New runner**, then click **New self-hosted runner**.{% else %}1. Click **New runner**.{% endif %} {% data reusables.actions.self-hosted-runner-configure %} {% elsif ghae or ghes < 3.4 %} {% data reusables.organizations.navigate-to-org %} diff --git a/translations/ja-JP/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md b/translations/ja-JP/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md index 2a31a921b594..d3cdb214af4f 100644 --- a/translations/ja-JP/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md +++ b/translations/ja-JP/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md @@ -18,15 +18,23 @@ shortTitle: Run runner app on startup {% capture service_first_step %}1. セルフホストランナー アプリケーションが現在実行中の場合は、そのアプリケーションを停止します。{% endcapture %} {% capture service_non_windows_intro_shell %}ランナー マシンで、セルフホストランナー アプリケーションをインストールしたディレクトリでシェルを開きます。 以下のコマンドを使って、セルフホストランナーサービスをインストール及び管理します。{% endcapture %} -{% capture service_nonwindows_intro %}セルフホストランナーアプリケーションをサービスとして設定する前に、ランナーを{% data variables.product.product_name %}に追加しなければなりません。 詳しい情報については「[セルフホストランナーの追加](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)」を参照してください。{% endcapture %} -{% capture service_win_name %}actions.runner.*{% endcapture %} +{% capture service_nonwindows_intro %} + +{% note %} + +**Note:** You must add a runner to {% data variables.product.product_name %} before you can configure the self-hosted runner application as a service. 詳しい情報については「[セルフホストランナーの追加](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)」を参照してください。 + +{% endnote %} +{% endcapture %} + +{% capture service_win_name %}actions.runner.*{% endcapture %} {% linux %} {{ service_nonwindows_intro }} -`systemd`を利用するLinuxのシステムでは、セルフホストランナーアプリケーションと共に配布されている`svc.sh`スクリプトを使い、セルフホストランナーアプリケーションをサービスとしてインストール及び管理できます。 +For Linux systems that use `systemd`, you can use the `svc.sh` script that is created after successfully adding the runner to install and manage using the application as a service. {{ service_non_windows_intro_shell }} diff --git a/translations/ja-JP/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md b/translations/ja-JP/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md index a685829c5f31..da56f8ee5307 100644 --- a/translations/ja-JP/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md +++ b/translations/ja-JP/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md @@ -9,215 +9,65 @@ versions: ghae: '*' ghec: '*' type: tutorial -shortTitle: Manage access to runners +shortTitle: Using runner groups --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} -## セルフホストランナーのグループについて +## About runner groups -{% ifversion fpt %} -{% note %} - -**注釈:** すべての Organization には、単一のデフォルトのセルフホストランナーグループがあります。 Only enterprise accounts and organizations owned by enterprise accounts can create and manage additional self-hosted runner groups. - -{% endnote %} - -Self-hosted runner groups are used to control access to self-hosted runners. Organization の管理者は、Organization 内のどのリポジトリがランナーグループにアクセスできるかを制御するアクセスポリシーを設定できます。 -ー - -{% data variables.product.prodname_ghe_cloud %}, you can create additional runner groups; enterprise admins can configure access policies that control which organizations in an enterprise have access to the runner group; and organization admins can assign additional granular repository access policies to the enterprise runner group. 詳しい情報については[{% data variables.product.prodname_ghe_cloud %}のドキュメンテーション](/enterprise-cloud@latest/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups)を参照してください。 -{% endif %} +{% data reusables.actions.about-runner-groups %} {% ifversion fpt %}For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups).{% endif %} {% ifversion ghec or ghes or ghae %} -セルフホストランナーグループは、Organization レベルおよび Enterprise レベルでセルフホストランナーへのアクセスを制御するために使用されます。 Enterprise owners can configure access policies that control which organizations -{% ifversion restrict-groups-to-workflows %}and workflows {% endif %}in an enterprise have access to the runner group. Organization owners can configure access policies that control which repositories{% ifversion restrict-groups-to-workflows %} and workflows{% endif %} in an organization have access to the runner group. - -When an enterprise owner grants an organization access to a runner group, organization owners can see the runner group listed in the organization's self-hosted runner settings. The organization owners can then assign additional granular repository{% ifversion restrict-groups-to-workflows %} and workflow{% endif %} access policies to the enterprise runner group. - -新しいランナーが作成されると、それらは自動的にデフォルトグループに割り当てられます。 ランナーは一度に1つのグループにのみ参加できます。 ランナーはデフォルトグループから別のグループに移動できます。 詳しい情報については、「[セルフホストランナーをグループに移動する](#moving-a-self-hosted-runner-to-a-group)」を参照してください。 ## Organization のセルフホストランナーグループを作成する -すべての Organization には、単一のデフォルトのセルフホストランナーグループがあります。 Enterprise アカウント内の Organization は、追加のセルフホストグループを作成できます。 Organization の管理者は、個々のリポジトリにランナーグループへのアクセスを許可できます。 For information about how to create a self-hosted runner group with the REST API, see "[Self-hosted runner groups](/rest/reference/actions#self-hosted-runner-groups)." - -セルフホストランナーは、作成時にデフォルトグループに自動的に割り当てられ、一度に 1 つのグループのメンバーになることができます。 ランナーはデフォルトグループから作成した任意のグループに移動できます。 - -When creating a group, you must choose a policy that defines which repositories{% ifversion restrict-groups-to-workflows %} and workflows{% endif %} have access to the runner group. - -{% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %} -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.org_settings %} -{% data reusables.organizations.settings-sidebar-actions-runner-groups %} -1. In the "Runner groups" section, click **New runner group**. -1. Enter a name for your runner group. - {% data reusables.actions.runner-group-assign-policy-repo %} - - {% warning %} - - **Warning**: {% indented_data_reference reusables.actions.self-hosted-runner-security spaces=3 %} +{%- ifversion ghec or ghes %} - 詳しい情報については「[セルフホストランナーについて](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)」を参照してください。 +{% data reusables.actions.self-hosted-runner-security-admonition %} - {% endwarning %} -{% data reusables.actions.runner-group-assign-policy-workflow %}{%- ifversion restrict-groups-to-workflows %} Organization-owned runner groups cannot access workflows from a different organization in the enterprise; instead, you must create an enterprise-owned runner group.{% endif %} -{% data reusables.actions.self-hosted-runner-create-group %} -{% elsif ghae or ghes < 3.4 %} -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.org_settings %} -{% data reusables.organizations.settings-sidebar-actions-runner-groups %} -1. Under {% ifversion ghes or ghae %}"Runners"{% endif %}, click **Add new**, and then **New group**. +{%- endif %} - ![新しいランナーを追加](/assets/images/help/settings/actions-org-add-runner-group.png) -1. ランナーグループの名前を入力し、リポジトリアクセスのポリシーを割り当てます。 - - ランナーグループを、特定のリポジトリのリスト、もしくはEnterprise内のすべてのリポジトリからアクセスできるように設定できます。{% ifversion ghec or ghes %}デフォルトでは、プライベートリポジトリのみがランナーグループ内のランナーにアクセスできますが、これは上書きできます。 この設定は、Enterpriseによって共有されているOrganizationのランナーグループを設定している場合には上書きできません。{% endif %} - - {%- ifversion ghes %} - {% warning %} - - **Warning**: - - {% indented_data_reference reusables.actions.self-hosted-runner-security spaces=3 %} - - 詳しい情報については「[セルフホストランナーについて](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)」を参照してください。 - - {% endwarning %} - {%- endif %} - - ![ランナーグループのオプションを追加](/assets/images/help/settings/actions-org-add-runner-group-options.png) -1. [**Save group**] をクリックしてグループを作成し、ポリシーを適用します。 -{% endif %} +{% data reusables.actions.creating-a-runner-group-for-an-organization %} ## Enterprise のセルフホストランナーグループを作成する -Enterprise は、セルフホストランナーをグループに追加して、アクセス管理を行うことができます。 Enterprises can create groups of self-hosted runners that are accessible to specific organizations in the enterprise account{% ifversion restrict-groups-to-workflows %} or to specific workflows{% endif %}. Organization owners can then assign additional granular repository{% ifversion restrict-groups-to-workflows %} or workflow{% endif %} access policies to the enterprise runner groups. For information about how to create a self-hosted runner group with the REST API, see the enterprise endpoints in the [{% data variables.product.prodname_actions %} REST API](/rest/reference/actions#self-hosted-runner-groups). - -セルフホストランナーは、作成時にデフォルトグループに自動的に割り当てられ、一度に 1 つのグループのメンバーになることができます。 登録処理中にランナーを特定のグループに割り当てることも、後でランナーをデフォルトグループからカスタムグループに移動することもできます。 - -グループを作成するときは、ランナーグループにアクセスできる Organization を定義するポリシーを選択する必要があります。 - -{% data reusables.actions.self-hosted-runner-groups-add-to-enterprise-first-steps %} -1. To choose a policy for organization access, select the **Organization access** drop-down, and click a policy. You can configure a runner group to be accessible to a specific list of organizations, or all organizations in the enterprise.{% ifversion ghes %} By default, only private repositories can access runners in a runner group, but you can override this.{% endif %} + {%- ifversion ghec or ghes %} - {%- ifversion ghec or ghes %} - {% warning %} +{% data reusables.actions.self-hosted-runner-security-admonition %} - **Warning**: +{%- endif %} - {% indented_data_reference reusables.actions.self-hosted-runner-security spaces=3 %} - - 詳しい情報については「[セルフホストランナーについて](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)」を参照してください。 - - {% endwarning %} - {%- endif %} - {%- ifversion ghec or ghes %} - - ![ランナーグループのオプションを追加](/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png) - {%- elsif ghae %} - - ![ランナーグループのオプションを追加](/assets/images/help/settings/actions-enterprise-account-add-runner-group-options-ae.png) - {%- endif %} -{% data reusables.actions.runner-group-assign-policy-workflow %} -1. [**Save group**] をクリックしてグループを作成し、ポリシーを適用します。 +{% data reusables.actions.creating-a-runner-group-for-an-enterprise %} {% endif %} ## セルフホストランナーグループのアクセスポリシーを変更する -For runner groups in an enterprise, you can change what organizations in the enterprise can access a runner group{% ifversion restrict-groups-to-workflows %} or restrict what workflows a runner group can run{% endif %}. For runner groups in an organization, you can change what repositories in the organization can access a runner group{% ifversion restrict-groups-to-workflows %} or restrict what workflows a runner group can run{% endif %}. - -### Changing what organizations or repositories can access a runner group - -{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %} -{% data reusables.actions.self-hosted-runner-groups-navigate-to-repo-org-enterprise %} -{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %} -1. For runner groups in an enterprise, under **Organization access**, modify what organizations can access the runner group. For runner groups in an organization, under **Repository access**, modify what repositories can access the runner group. - - {%- ifversion fpt or ghec or ghes %} - {% warning %} - - **Warning**: - - {% indented_data_reference reusables.actions.self-hosted-runner-security spaces=3 %} - - 詳しい情報については「[セルフホストランナーについて](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)」を参照してください。 - - {% endwarning %} - {%- endif %} -{% elsif ghae or ghes < 3.4 %} -{% data reusables.actions.self-hosted-runner-configure-runner-group-access %} -{% endif %} +{%- ifversion fpt or ghec or ghes %} -{% ifversion restrict-groups-to-workflows %} -### Changing what workflows can access a runner group -You can configure a self-hosted runner group to run either selected workflows or all workflows. For example, you might use this setting to protect secrets that are stored on self-hosted runners or to standardize deployment workflows by restricting a runner group to run only a specific reusable workflow. This setting cannot be overridden if you are configuring an organization's runner group that was shared by an enterprise. -{% data reusables.actions.self-hosted-runner-groups-navigate-to-repo-org-enterprise %} -{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %} -1. Under **Workflow access**, select the dropdown menu and click **Selected workflows**. -1. {% octicon "gear" aria-label="the gear icon" %} をクリックします。 -1. Enter a comma separated list of the workflows that can access the runner group. Use the full path, including the repository name and owner. Pin the workflow to a branch, tag, or full SHA. 例: `octo-org/octo-repo/.github/workflows/build.yml@v2, octo-org/octo-repo/.github/workflows/deploy.yml@d6dc6c96df4f32fa27b039f2084f576ed2c5c2a5, monalisa/octo-test/.github/workflows/test.yml@main` +{% data reusables.actions.self-hosted-runner-security-admonition %} - Only jobs directly defined within the selected workflows will have access to the runner group. +{%- endif %} - Organization-owned runner groups cannot access workflows from a different organization in the enterprise; instead, you must create an enterprise-owned runner group. - -1. [**Save**] をクリックします。 - -{% endif %} +{% data reusables.actions.changing-the-access-policy-of-a-runner-group %} ## Changing the name of a runner group -{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %} -{% data reusables.actions.self-hosted-runner-groups-navigate-to-repo-org-enterprise %} -{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %} -1. Change the runner group name. - -{% elsif ghae or ghes < 3.4 %} -{% data reusables.actions.self-hosted-runner-configure-runner-group %} -1. Change the runner group name. -{% endif %} +{% data reusables.actions.changing-the-name-of-a-runner-group %} {% ifversion ghec or ghes or ghae %} ## Automatically adding a self-hosted runner to a group -You can use the configuration script to automatically add a new self-hosted runner to a group. For example, this command registers a new self-hosted runner and uses the `--runnergroup` parameter to add it to a group named `rg-runnergroup`. - -```sh -./config.sh --url $org_or_enterprise_url --token $token --runnergroup rg-runnergroup -``` - -The command will fail if the runner group doesn't exist: - -``` -Could not find any self-hosted runner group named "rg-runnergroup". -``` +{% data reusables.actions.automatically-adding-a-runner-to-a-group %} ## セルフホストランナーをグループに移動する -If you don't specify a runner group during the registration process, your new self-hosted runners are automatically assigned to the default group, and can then be moved to another group. - -{% data reusables.actions.self-hosted-runner-navigate-to-org-enterprise %} -{% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %} -1. In the "Runners" list, click the runner that you want to configure. -2. Select the **Runner group** drop-down. -3. In "Move runner to group", choose a destination group for the runner. -{% elsif ghae or ghes < 3.4 %} -1. In the {% ifversion ghes or ghae %}"Runner groups"{% endif %} section of the settings page, locate the current group of the runner you want to move and expand the list of group members. ![ランナーグループのメンバーを表示](/assets/images/help/settings/actions-org-runner-group-members.png) -2. セルフホストランナーの横にあるチェックボックスを選択し、[**Move to group**] をクリックして、利用可能な移動先を確認します。 ![ランナーグループのメンバーを移動](/assets/images/help/settings/actions-org-runner-group-member-move.png) -3. 移動先のグループをクリックして、ランナーを移動します。 ![ランナーグループのメンバーを移動](/assets/images/help/settings/actions-org-runner-group-member-move-destination.png) -{% endif %} +{% data reusables.actions.moving-a-runner-to-a-group %} ## セルフホストランナーグループを削除する -セルフホストランナーは、グループが削除されると自動的にデフォルトグループに戻ります。 +{% data reusables.actions.removing-a-runner-group %} -{% ifversion ghes or ghae or ghec %} -{% data reusables.actions.self-hosted-runner-groups-navigate-to-repo-org-enterprise %} -1. In the list of groups, to the right of the group you want to delete, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}. -2. グループを削除するには、[**Remove group**] をクリックします。 -3. 確認プロンプトを確認し、[**Remove this runner group**] をクリックします。 - -{% endif %} {% endif %} diff --git a/translations/ja-JP/content/actions/learn-github-actions/contexts.md b/translations/ja-JP/content/actions/learn-github-actions/contexts.md index 3aeaf1b552a8..a2f95f52c605 100644 --- a/translations/ja-JP/content/actions/learn-github-actions/contexts.md +++ b/translations/ja-JP/content/actions/learn-github-actions/contexts.md @@ -570,7 +570,7 @@ jobs: ## `secrets` context -The `secrets` context contains the names and values of secrets that are available to a workflow run. The `secrets` context is not available for composite actions. For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." +The `secrets` context contains the names and values of secrets that are available to a workflow run. The `secrets` context is not available for composite actions. シークレットに関する詳しい情報については「[暗号化されたシークレット](/actions/security-guides/encrypted-secrets)」を参照してください。 `GITHUB_TOKEN` is a secret that is automatically created for every workflow run, and is always included in the `secrets` context. 詳しい情報については「[自動トークン認証](/actions/security-guides/automatic-token-authentication)」を参照してください。 diff --git a/translations/ja-JP/content/actions/learn-github-actions/understanding-github-actions.md b/translations/ja-JP/content/actions/learn-github-actions/understanding-github-actions.md index 151fdbe6ccc5..4974c373f9b0 100644 --- a/translations/ja-JP/content/actions/learn-github-actions/understanding-github-actions.md +++ b/translations/ja-JP/content/actions/learn-github-actions/understanding-github-actions.md @@ -2,6 +2,7 @@ title: Understanding GitHub Actions shortTitle: Understanding GitHub Actions intro: 'Learn the basics of {% data variables.product.prodname_actions %}, including core concepts and essential terminology.' +miniTocMaxHeadingLevel: 3 redirect_from: - /github/automating-your-workflow-with-github-actions/core-concepts-for-github-actions - /actions/automating-your-workflow-with-github-actions/core-concepts-for-github-actions @@ -82,7 +83,7 @@ You can write your own actions, or you can find actions to use in your workflows ### ランナー -{% data reusables.actions.about-runners %} Each runner can run a single job at a time. {% ifversion ghes or ghae %} You must host your own runners for {% data variables.product.product_name %}. {% elsif fpt or ghec %}{% data variables.product.company_short %} provides Ubuntu Linux, Microsoft Windows, and macOS runners to run your workflows; each workflow run executes in a fresh, newly-provisioned virtual machine. If you need a different operating system or require a specific hardware configuration, you can host your own runners.{% endif %} For more information{% ifversion fpt or ghec %} about self-hosted runners{% endif %}, see "[Hosting your own runners](/actions/hosting-your-own-runners)." +{% data reusables.actions.about-runners %} Each runner can run a single job at a time. {% ifversion ghes or ghae %} You must host your own runners for {% data variables.product.product_name %}. {% elsif fpt or ghec %}{% data variables.product.company_short %} provides Ubuntu Linux, Microsoft Windows, and macOS runners to run your workflows; each workflow run executes in a fresh, newly-provisioned virtual machine. {% ifversion actions-hosted-runners %} {% data variables.product.prodname_dotcom %} also offers {% data variables.actions.hosted_runner %}s, which are available in larger configurations. For more information, see "[Using {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/using-larger-runners)." {% endif %}If you need a different operating system or require a specific hardware configuration, you can host your own runners.{% endif %} For more information{% ifversion fpt or ghec %} about self-hosted runners{% endif %}, see "[Hosting your own runners](/actions/hosting-your-own-runners)." {% data reusables.actions.workflow-basic-example-and-explanation %} diff --git a/translations/ja-JP/content/actions/publishing-packages/publishing-nodejs-packages.md b/translations/ja-JP/content/actions/publishing-packages/publishing-nodejs-packages.md index 57bb6f28eb43..5a26f04f4350 100644 --- a/translations/ja-JP/content/actions/publishing-packages/publishing-nodejs-packages.md +++ b/translations/ja-JP/content/actions/publishing-packages/publishing-nodejs-packages.md @@ -98,9 +98,9 @@ Please note that you need to set the `registry-url` to `https://registry.npmjs.o ### 宛先リポジトリの設定 -*package.json* ファイルで `repository` キーを指定しない場合、{% data variables.product.prodname_registry %} は *package.json* ファイルの `name` フィールドで指定した {% data variables.product.prodname_dotcom %} リポジトリにパッケージを公開します。 たとえば、`@my-org/test` という名前のパッケージは、`my-org/test` {% data variables.product.prodname_dotcom %} というリポジトリに公開されます。 +Linking your package to {% data variables.product.prodname_registry %} using the `repository` key is optional. If you choose not to provide the `repository` key in your *package.json* file, then {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the `name` field of the *package.json* file. たとえば、`@my-org/test` という名前のパッケージは、`my-org/test` {% data variables.product.prodname_dotcom %} というリポジトリに公開されます。 If the `url` specified in the `repository` key is invalid, your package may still be published however it won't be linked to the repository source as intended. -ただし、`repository` キーを指定すると、そのキーのリポジトリが {% data variables.product.prodname_registry %} の宛先 npm レジストリとして使用されます。 たとえば、以下の *package.json* を公開すると、`my-amazing-package` という名前のパッケージが `octocat/my-other-repo` {% data variables.product.prodname_dotcom %} リポジトリに公開されます。 +If you do provide the `repository` key in your *package.json* file, then the repository in that key is used as the destination npm registry for {% data variables.product.prodname_registry %}. たとえば、以下の *package.json* を公開すると、`my-amazing-package` という名前のパッケージが `octocat/my-other-repo` {% data variables.product.prodname_dotcom %} リポジトリに公開されます。 Once published, only the repository source is updated, and the package doesn't inherit any permissions from the destination repository. ```json { diff --git a/translations/ja-JP/content/actions/using-github-hosted-runners/about-github-hosted-runners.md b/translations/ja-JP/content/actions/using-github-hosted-runners/about-github-hosted-runners.md index 169c4fc6f2f1..4bdc3f28623e 100644 --- a/translations/ja-JP/content/actions/using-github-hosted-runners/about-github-hosted-runners.md +++ b/translations/ja-JP/content/actions/using-github-hosted-runners/about-github-hosted-runners.md @@ -86,6 +86,15 @@ While the job runs, the logs and output can be viewed in the {% data variables.p ## サポートされているランナーとハードウェアリソース +{% ifversion actions-hosted-runners %} + +{% note %} + +**Note**: {% data variables.product.prodname_dotcom %} also offers {% data variables.actions.hosted_runner %}s, which are available in larger configurations. For more information, see "[Using {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/using-larger-runners)." + +{% endnote %} +{% endif %} + Windows および Linux 仮想マシンのハードウェア仕様: - 2-core CPU (x86_64) - 7 GB of RAM diff --git a/translations/ja-JP/content/actions/using-github-hosted-runners/controlling-access-to-larger-runners.md b/translations/ja-JP/content/actions/using-github-hosted-runners/controlling-access-to-larger-runners.md new file mode 100644 index 000000000000..b805b43c2669 --- /dev/null +++ b/translations/ja-JP/content/actions/using-github-hosted-runners/controlling-access-to-larger-runners.md @@ -0,0 +1,50 @@ +--- +title: Controlling access to larger runners +intro: 'You can use policies to limit access to {% data variables.actions.hosted_runner %}s that have been added to an organization or enterprise.' +product: '{% data reusables.gated-features.hosted-runners %}' +versions: + feature: actions-hosted-runners +type: tutorial +shortTitle: 'Controlling access to {% data variables.actions.hosted_runner %}s' +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + +## About runner groups + +{% data reusables.actions.about-runner-groups %} {% ifversion fpt %}For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/actions/using-github-hosted-runners/controlling-access-to-larger-runners).{% endif %} + +{% ifversion ghec or ghes or ghae %} + +## Creating a runner group for an organization + +{% data reusables.actions.hosted-runner-security-admonition %} +{% data reusables.actions.creating-a-runner-group-for-an-organization %} + +## Creating a runner group for an enterprise + +{% data reusables.actions.hosted-runner-security-admonition %} +{% data reusables.actions.creating-a-runner-group-for-an-enterprise %} + +{% endif %} + +## Changing the access policy of a runner group + +{% data reusables.actions.hosted-runner-security-admonition %} +{% data reusables.actions.changing-the-access-policy-of-a-runner-group %} + +## Changing the name of a runner group + +{% data reusables.actions.changing-the-name-of-a-runner-group %} + +{% ifversion ghec or ghes or ghae %} +## Moving a runner to a group + +{% data reusables.actions.moving-a-runner-to-a-group %} + +## Removing a runner group + +{% data reusables.actions.removing-a-runner-group %} + +{% endif %} diff --git a/translations/ja-JP/content/actions/using-github-hosted-runners/index.md b/translations/ja-JP/content/actions/using-github-hosted-runners/index.md index 2c05480126cb..89da172b2b9d 100644 --- a/translations/ja-JP/content/actions/using-github-hosted-runners/index.md +++ b/translations/ja-JP/content/actions/using-github-hosted-runners/index.md @@ -7,6 +7,8 @@ versions: ghes: '*' children: - /about-github-hosted-runners + - /using-larger-runners + - /controlling-access-to-larger-runners - /monitoring-your-current-jobs - /customizing-github-hosted-runners - /connecting-to-a-private-network diff --git a/translations/ja-JP/content/actions/using-github-hosted-runners/using-larger-runners.md b/translations/ja-JP/content/actions/using-github-hosted-runners/using-larger-runners.md new file mode 100644 index 000000000000..0e9d992dce33 --- /dev/null +++ b/translations/ja-JP/content/actions/using-github-hosted-runners/using-larger-runners.md @@ -0,0 +1,135 @@ +--- +title: Using larger runners +intro: '{% data variables.product.prodname_dotcom %} offers larger runners with more RAM and CPU.' +miniTocMaxHeadingLevel: 3 +product: '{% data reusables.gated-features.hosted-runners %}' +versions: + feature: actions-hosted-runners +shortTitle: 'Using {% data variables.actions.hosted_runner %}s' +--- + +## Overview of {% data variables.actions.hosted_runner %}s + +In addition to the [standard {% data variables.product.prodname_dotcom %}-hosted runners](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources), {% data variables.product.prodname_dotcom %} also offers customers on {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %} plans a range of {% data variables.actions.hosted_runner %}s with more RAM and CPU. These runners are hosted by {% data variables.product.prodname_dotcom %} and have the runner application and other tools preinstalled. + +When you add a {% data variables.actions.hosted_runner %} to an organization, you are defining a type of machine from a selection of available hardware specifications and operating system images. {% data variables.product.prodname_dotcom %} will then create multiple instances of this runner that scale up and down to match the job demands of your organization, based on the autoscaling limits you define. + +## Architectural overview of {% data variables.actions.hosted_runner %}s + +The {% data variables.actions.hosted_runner %}s are managed at the organization level, where they are arranged into groups that can contain multiple instances of the runner. They can also be created at the enterprise level and shared with organizations in the hierarchy. Once you've created a group, you can then add a runner to the group and update your workflows to target the label assigned to the {% data variables.actions.hosted_runner %}. You can also control which repositories are permitted to send jobs to the group for processing. For more information about groups, see "[Controlling access to {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/controlling-access-to-larger-runners)." + +In the following diagram, a class of hosted runner named `ubuntu-20.04-16core` has been defined with customized hardware and operating system configuration. + +![Diagram explaining {% data variables.actions.hosted_runner %}](/assets/images/hosted-runner.png) + +1. Instances of this runner are automatically created and added to a group called `ubuntu-20.04-16core`. +2. The runners have been assigned the label `ubuntu-20.04-16core`. +3. Workflow jobs use the `ubuntu-20.04-16core` label in their `runs-on` key to indicate the type of runner they need to execute the job. +4. {% data variables.product.prodname_actions %} checks the runner group to see if your repository is authorized to send jobs to the runner. +5. The job runs on the next available instance of the `ubuntu-20.04-16core` runner. + +## Autoscaling {% data variables.actions.hosted_runner %}s + +Your {% data variables.actions.hosted_runner %}s can be configured to automatically scale to suit your needs. When jobs are submitted for processing, more machines can be automatically provisioned to run the jobs, until reaching a pre-defined maximum limit. Each machine only handles one job at a time, so these settings effectively determine the number of jobs that can be run concurrently. + +During the runner deployment process, you can configure the _Max_ option, which allows you to control your costs by setting the maximum parallel number of machines that are created in this set. A higher value here can help avoid workflows being blocked due to parallelism. + +## Networking for {% data variables.actions.hosted_runner %}s + +By default, {% data variables.actions.hosted_runner %}s receive a dynamic IP address that changes for each job run. Optionally, {% data variables.product.prodname_ghe_cloud %} customers can configure their {% data variables.actions.hosted_runner %}s to receive a static IP address from {% data variables.product.prodname_dotcom %}'s IP address pool. When enabled, instances of the {% data variables.actions.hosted_runner %} will receive an address from a range that is unique to the runner, allowing you to use this range to configure a firewall allowlist. You can use up to 10 static IP address ranges in total across all your {% data variables.actions.hosted_runner %}s. + +{% note %} + +**Note**: If runners are unused for more than 30 days, their IP address ranges are automatically removed and cannot be recovered. + +{% endnote %} + +## Planning for {% data variables.actions.hosted_runner %}s + +### Create a runner group + +Runner groups are used to collect sets of virtual machines and create a security boundary around them. You can then decide which organizations or repositories are permitted to run jobs on those sets of machines. During the {% data variables.actions.hosted_runner %} deployment process, the runner can be added to an existing group, or otherwise it will join a default group. You can create a group by following the steps in "[Controlling access to {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/controlling-access-to-larger-runners)." + +### Understanding billing + +Compared to standard {% data variables.product.prodname_dotcom %}-hosted runners, {% data variables.actions.hosted_runner %}s are billed differently. For more information, see "[Per-minute rates](/billing/managing-billing-for-github-actions/about-billing-for-github-actions#per-minute-rates)". + +## Adding a {% data variables.actions.hosted_runner %} to an enterprise + +You can add {% data variables.actions.hosted_runner %}s to an enterprise, where they can be assigned to multiple organizations. The organization admins can then control which repositories can use the runners. To add a {% data variables.actions.hosted_runner %} to an enterprise, you must be an enterprise owner. + +{% data reusables.actions.add-hosted-runner-overview %} + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.policies-tab %} +{% data reusables.enterprise-accounts.actions-tab %} +{% data reusables.enterprise-accounts.actions-runners-tab %} +{% data reusables.actions.add-hosted-runner %} +1. To allow organizations to access your {% data variables.actions.hosted_runner %}s, you specify the list of organizations that can use it. For more information, see "[Managing access to your runners](#managing-access-to-your-runners)." + +## Adding a {% data variables.actions.hosted_runner %} to an organization + +You can add a {% data variables.actions.hosted_runner %} to an organization, where the organization admins can control which repositories can use it. + +{% data reusables.actions.add-hosted-runner-overview %} + +{% data reusables.organizations.navigate-to-org %} +{% data reusables.organizations.org_settings %} +{% data reusables.organizations.settings-sidebar-actions-runners %} +{% data reusables.actions.add-hosted-runner %} +1. To allow repositories to access your {% data variables.actions.hosted_runner %}s, add them to the list of repositories that can use it. For more information, see "[Managing access to your runners](#managing-access-to-your-runners)." + +## Running jobs on your runner + +Once your runner type has been been defined, you can update your workflows to send jobs to the runner instances for processing. In this example, a runner group is populated with Ubuntu 16-core runners, which have been assigned the label `ubuntu-20.04-16core`. If you have a runner matching this label, the `check-bats-version` job then uses the `runs-on` key to target that runner whenever the job is run: + +```yaml +name: learn-github-actions +on: [push] +jobs: + check-bats-version: + runs-on: ubuntu-20.04-16core + steps: + - uses: {% data reusables.actions.action-checkout %} + - uses:{% data reusables.actions.action-setup-node %} + with: + node-version: '14' + - run: npm install -g bats + - run: bats -v +``` + +## Managing access to your runners + +{% note %} + +**Note**: Before your workflows can send jobs to {% data variables.actions.hosted_runner %}s, you must first configure permissions for the runner group. See the following sections for more information. + +{% endnote %} + +Runner groups are used to control which repositories can run jobs on your {% data variables.actions.hosted_runner %}s. You must grant access to the group from each level of the management hierarchy, depending on where you've defined the {% data variables.actions.hosted_runner %}: + +- **Runners at the enterprise level**: Configure the runner group to grant access to all the required organizations. In addition, for each organization, you must configure the group to specify which repositories are allowed access. +- **Runners at the organization level**: Configure the runner group by specifying which repositories are allowed access. + +For example, the following diagram has a runner group named `grp-ubuntu-20.04-16core` at the enterprise level. Before the repository named `octo-repo` can use the runners in the group, you must first configure the group at the enterprise level to allow access from the `octo-org` organization; you must then configure the group at the organization level to allow access from `octo-repo`: + +![Diagram explaining {% data variables.actions.hosted_runner %} groups](/assets/images/hosted-runner-mgmt.png) + +### Allowing repositories to access a runner group + +This procedure demonstrates how to configure group permissions at the enterprise and organization levels: + +{% data reusables.actions.runner-groups-navigate-to-repo-org-enterprise %} +{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %} + - For runner groups in an enterprise: under **Organization access**, modify which organizations can access the runner group. + - For runner groups in an organization: under **Repository access**, modify which repositories can access the runner group. + +{% warning %} + +**Warning**: + +{% data reusables.actions.hosted-runner-security %} + +For more information, see "[Controlling access to {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/controlling-access-to-larger-runners)." + +{% endwarning %} diff --git a/translations/ja-JP/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md b/translations/ja-JP/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md index a4078416ffe4..bb214de90b97 100644 --- a/translations/ja-JP/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md +++ b/translations/ja-JP/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md @@ -51,7 +51,7 @@ For more information on workflow run artifacts, see "[Persisting workflow data u ワークフローは、現在のブランチ、ベースブランチ(フォークされたリポジトリのベースブランチを含む)、またはデフォルトブランチ(通常は `main`)で作成されたキャッシュにアクセスして復元できます。 たとえば、デフォルトブランチで作成されたキャッシュは、どのPull Requestからもアクセスできます。 また、`feature-b` ブランチに `feature-a` ベースブランチがある場合、`feature-b` でトリガーされたワークフローは、デフォルトのブランチ(`main`)、`feature-a`、および `feature-b` で作成されたキャッシュにアクセスできます。 -Access restrictions provide cache isolation and security by creating a logical boundary between different branches. For example, a cache created for the branch `feature-a` (with the base `main`) would not be accessible to a pull request for the branch `feature-c` (with the base `main`). +Access restrictions provide cache isolation and security by creating a logical boundary between different branches or tags. For example, a cache created for the branch `feature-a` (with the base `main`) would not be accessible to a pull request for the branch `feature-c` (with the base `main`). On similar lines, a cache created for the tag `release-a` (from the base `main`) would not be accessible to a workflow triggered for the tag `release-b` (with the base `main`). Multiple workflows within a repository share cache entries. A cache created for a branch within a workflow can be accessed and restored from another workflow for the same repository and branch. diff --git a/translations/ja-JP/content/actions/using-workflows/reusing-workflows.md b/translations/ja-JP/content/actions/using-workflows/reusing-workflows.md index a26e315cd38e..8f5b79470ed3 100644 --- a/translations/ja-JP/content/actions/using-workflows/reusing-workflows.md +++ b/translations/ja-JP/content/actions/using-workflows/reusing-workflows.md @@ -23,7 +23,7 @@ topics: Rather than copying and pasting from one workflow to another, you can make workflows reusable. You and anyone with access to the reusable workflow can then call the reusable workflow from another workflow. -Reusing workflows avoids duplication. This makes workflows easier to maintain and allows you to create new workflows more quickly by building on the work of others, just as you do with actions. Workflow reuse also promotes best practice by helping you to use workflows that are well designed, have already been tested, and have been proved to be effective. Your organization can build up a library of reusable workflows that can be centrally maintained. +Reusing workflows avoids duplication. This makes workflows easier to maintain and allows you to create new workflows more quickly by building on the work of others, just as you do with actions. Workflow reuse also promotes best practice by helping you to use workflows that are well designed, have already been tested, and have been proven to be effective. Your organization can build up a library of reusable workflows that can be centrally maintained. The diagram below shows three build jobs on the left of the diagram. After each of these jobs completes successfully a dependent job called "Deploy" runs. This job calls a reusable workflow that contains three jobs: "Staging", "Review", and "Production." The "Production" deployment job only runs after the "Staging" job has completed successfully. Using a reusable workflow to run deployment jobs allows you to run those jobs for each build without duplicating code in workflows. @@ -127,7 +127,7 @@ You can define inputs and secrets, which can be passed from the caller workflow runs-on: ubuntu-latest environment: production steps: - - uses: ./.github/workflows/my-action + - uses: octo-org/my-action@v1 with: username: ${{ inputs.username }} token: ${{ secrets.envPAT }} @@ -168,12 +168,13 @@ jobs: name: Pass input and secrets to my-action runs-on: ubuntu-latest steps: - - uses: ./.github/workflows/my-action + - uses: octo-org/my-action@v1 with: username: ${{ inputs.username }} token: ${{ secrets.token }} ``` {% endraw %} + {% ifversion actions-reusable-workflow-matrix %} ## Using a matrix strategy with a reusable workflow diff --git a/translations/ja-JP/content/actions/using-workflows/workflow-commands-for-github-actions.md b/translations/ja-JP/content/actions/using-workflows/workflow-commands-for-github-actions.md index 61391dcc7d23..8ea745b5561f 100644 --- a/translations/ja-JP/content/actions/using-workflows/workflow-commands-for-github-actions.md +++ b/translations/ja-JP/content/actions/using-workflows/workflow-commands-for-github-actions.md @@ -329,9 +329,15 @@ Write-Output "::add-mask::Mona The Octocat" {% endpowershell %} +{% warning %} + +**Warning:** Make sure you register the secret with 'add-mask' before outputting it in the build logs or using it in any other workflow commands. + +{% endwarning %} + ### Example: Masking an environment variable -変数 `MY_NAME` または値 `"Mona The Octocat"` をログに出力すると。`"Mona The Octocat"` の代わりに `"***"` が表示されます。 +変数 `MY_NAME` または値 `"Mona The Octocat"` をログに出力すると、`"Mona The Octocat"` の代わりに `"***"` が表示されます。 {% bash %} diff --git a/translations/ja-JP/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-dependency-review-for-your-appliance.md b/translations/ja-JP/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-dependency-review-for-your-appliance.md new file mode 100644 index 000000000000..bd29f0a56c92 --- /dev/null +++ b/translations/ja-JP/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-dependency-review-for-your-appliance.md @@ -0,0 +1,52 @@ +--- +title: Configuring dependency review for your appliance +shortTitle: 依存関係レビューの設定 +intro: 'To helps users understand dependency changes when reviewing pull requests, you can enable, configure, and disable dependency review for {% data variables.product.product_location %}.' +product: '{% data reusables.gated-features.dependency-review %}' +miniTocMaxHeadingLevel: 3 +versions: + feature: dependency-review-action-ghes +type: how_to +topics: + - Advanced Security + - Enterprise + - Dependency review + - Security +--- + +{% data reusables.dependency-review.beta %} + +## 依存関係のレビューについて + +{% data reusables.dependency-review.feature-overview %} + +Some additional features, such as license checks, blocking of pull requests, and CI/CD integration, are available with the [dependency review action](https://github.com/actions/dependency-review-action). + +## Checking whether your license includes {% data variables.product.prodname_GH_advanced_security %} + +{% data reusables.advanced-security.check-for-ghas-license %} + +## Prerequisites for dependency review + +- A license for {% data variables.product.prodname_GH_advanced_security %}{% ifversion ghes %} (see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)").{% endif %} + +- The dependency graph enabled for the instance. Site administrators can enable the dependency graph via the management console or the administrative shell (see "[Enabling the dependency graph for your enterprise](/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise)"). + +- {% data variables.product.prodname_github_connect %} enabled to download and synchronize vulnerabilities from the {% data variables.product.prodname_advisory_database %}. This is usually configured as part of setting up {% data variables.product.prodname_dependabot %} (see "[Enabling Dependabot for your enterprise](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)"). + +## Enabling and disabling dependency review + +To enable or disable dependency review, you need to enable or disable the dependency graph for your instance. + +詳しい情報については「[Enterpriseでの依存関係グラフの有効化](/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise)」を参照してください。 + +## Running dependency review using {% data variables.product.prodname_actions %} + +{% data reusables.dependency-review.dependency-review-action-beta-note %} + +The dependency review action is included in your installation of {% data variables.product.prodname_ghe_server %}. It is available for all repositories that have {% data variables.product.prodname_GH_advanced_security %} and dependency graph enabled. + +{% data reusables.dependency-review.dependency-review-action-overview %} + +Users run the dependency review action using a {% data variables.product.prodname_actions %} workflow. If you have not already set up runners for {% data variables.product.prodname_actions %}, you must do this to enable users to run workflows. セルフホストランナーは、リポジトリ、Organization、または Enterprise アカウントレベルでプロビジョニングできます。 For information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)" and "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)." + diff --git a/translations/ja-JP/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/index.md b/translations/ja-JP/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/index.md index f3ee2561000c..dcd835e93d2f 100644 --- a/translations/ja-JP/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/index.md +++ b/translations/ja-JP/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/index.md @@ -14,6 +14,7 @@ topics: children: - /enabling-github-advanced-security-for-your-enterprise - /configuring-code-scanning-for-your-appliance + - /configuring-dependency-review-for-your-appliance - /configuring-secret-scanning-for-your-appliance --- diff --git a/translations/ja-JP/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise.md b/translations/ja-JP/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise.md index 856e05066619..25eca80421f8 100644 --- a/translations/ja-JP/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise.md +++ b/translations/ja-JP/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise.md @@ -23,7 +23,7 @@ You can enable the dependency graph via the {% data variables.enterprise.managem ## Enabling the dependency graph via the {% data variables.enterprise.management_console %} -If your {% data variables.product.product_location %} uses clustering, you cannot enable the dependency graph with the {% data variables.enterprise.management_console %} and must use the administrative shell instead. For more information, see "[Enabling the dependency graph via the administrative shell](#enabling-the-dependency-graph-via-the-administrative-shell)." +If {% data variables.product.product_location %} uses clustering, you cannot enable the dependency graph with the {% data variables.enterprise.management_console %} and must use the administrative shell instead. For more information, see "[Enabling the dependency graph via the administrative shell](#enabling-the-dependency-graph-via-the-administrative-shell)." {% data reusables.enterprise_site_admin_settings.sign-in %} {% data reusables.enterprise_site_admin_settings.access-settings %} diff --git a/translations/ja-JP/content/admin/configuration/configuring-network-settings/configuring-a-hostname.md b/translations/ja-JP/content/admin/configuration/configuring-network-settings/configuring-a-hostname.md index 223e405fceae..cbebea07ba2f 100644 --- a/translations/ja-JP/content/admin/configuration/configuring-network-settings/configuring-a-hostname.md +++ b/translations/ja-JP/content/admin/configuration/configuring-network-settings/configuring-a-hostname.md @@ -19,6 +19,8 @@ topics: {% data variables.enterprise.management_console %} のホスト名の設定は、適切な完全修飾ドメイン名 (FQDN) に設定して、インターネット上または内部ネットワーク内で解決できるようにしてください。 For example, your hostname setting could be `github.companyname.com.` Web and API requests will automatically redirect to the hostname configured in the {% data variables.enterprise.management_console %}. Note that `localhost` is not a valid hostname setting. +Hostnames must be less than 63 characters in length per [Section 2.3.4 of the Domain Names Specification RFC](https://datatracker.ietf.org/doc/html/rfc1035#section-2.3.4). + After you configure a hostname, you can enable subdomain isolation to further increase the security of {% data variables.product.product_location %}. 詳しい情報については"[Subdomain Isolationの有効化](/enterprise/admin/guides/installation/enabling-subdomain-isolation/)"を参照してください。 For more information on the supported hostname types, see [Section 2.1 of the HTTP RFC](https://tools.ietf.org/html/rfc1123#section-2). diff --git a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md index 4c539b1e05e0..42195ffedd1e 100644 --- a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md +++ b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md @@ -78,6 +78,14 @@ Enterprise オーナーは、通知用のメールを設定できます。 You can enforce TLS encryption for all incoming SMTP connections, which can help satisfy an ISO-27017 certification requirement. +{%- ifversion ghes = 3.6 %} +{% note %} + +**Note**: Enforcement of TLS for SMTP connections is unavailable in {% data variables.product.product_name %} 3.6.0. The feature will be available in an upcoming release. + +{% endnote %} +{%- endif %} + {% data reusables.enterprise_site_admin_settings.email-settings %} 1. Under "Authentication," select **Enforce TLS auth (recommended)**. diff --git a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md index e074b64fd8d5..5bd322dcae97 100644 --- a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md +++ b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md @@ -131,46 +131,49 @@ Key | Description {% ifversion ghes %} ## Indexing -GitHub's [code search][] features are powered by [ElasticSearch][]. This section of the site admin dashboard shows you the current status of your ElasticSearch cluster and provides you with several tools to control the behavior of searching and indexing. These tools are split into the following three categories. +GitHub's search features are powered by Elasticsearch. This section of the site admin dashboard shows you the current status of your Elasticsearch cluster and provides you with several tools to control search and index behavior. - [Code Search]: https://github.com/blog/1381-a-whole-new-code-search - [ElasticSearch]: http://www.elasticsearch.org/ +For more information about code search, see "[Searching for information on {% data variables.product.prodname_dotcom %}](/search-github)." For more information about Elasticsearch, see the [Elasticsearch website](https://elastic.co). -### Code search +{% note %} -This allows you to enable or disable both search and index operations on source code. +**Note**: In normal use, site administrators do not need to create new indices or schedule repair jobs. For troubleshooting or other support purposes, {% data variables.contact.github_support %} may instruct you to run a repair job. -### Code search index repair +{% endnote %} -This controls how the code search index is repaired. You can +### Index management -- enable or disable index repair jobs -- start a new index repair job -- reset all index repair state +{% data variables.product.product_name %} reconciles the state of the search index with data on the instance automatically and regularly. -{% data variables.product.prodname_enterprise %} uses repair jobs to reconcile the state of the search index with data stored in a database (issues, pull requests, repositories, and users) and data stored in Git repositories (source code). This happens when +- Issues, pull requests, repositories, and users in the database +- Git repositories (source code) on disk -- a new search index is created; -- missing data needs to be backfilled; or -- old search data needs to be updated. +Your instance uses repair jobs to reconcile the data, and schedules a repair job in the background when the following events occur. -In other words, repair jobs are started as needed and run in the background—they are not scheduled by site admins in any way. +- A new search index is created. +- Missing data needs to be backfilled. +- Old search data needs to be updated. -Furthermore, repair jobs use a "repair offset" for parallelization. This is an offset into the database table for the record being reconciled. Multiple background jobs can synchronize work based on this offset. +You can create a new index, or you can click on an existing index in the list to manage the index. You can perform the following operations on an index. -A progress bar shows the current status of a repair job across all of its background workers. It is the percentage difference of the repair offset with the highest record ID in the database. Don't worry about the value shown in the progress bar after a repair job has completed: because it shows the difference between the repair offset and the highest record ID in the database, it will decrease as more repositories are added to {% data variables.product.product_location %} even though those repositories are actually indexed. +- Make the index searchable. +- Make the index writable. +- Update the index. +- Delete the index +- Reset the index repair state. +- Start a new index repair job. +- Enable or disable index repair jobs. -You can start a new code-search index repair job at any time. It will use a single CPU as it reconciles the search index with database and Git repository data. To minimize the effects this will have on I/O performance and reduce the chances of operations timing out, try to run a repair job during off-peak hours first. Monitor your system's load averages and CPU usage with a utility like `top`; if you don't notice any significant changes, it should be safe to run an index repair job during peak hours, as well. +A progress bar shows the current status of a repair job across background workers. The bar is the percentage difference of the repair offset with the highest record ID in the database. You can ignore the value shown in the progress bar after a repair job has completed. The progress bar shows the difference between the repair offset and the highest record ID in the database, and will decrease as more repositories are added to {% data variables.product.product_location %} even though those repositories are actually indexed. -### Issues index repair +To minimize the effects on I/O performance and reduce the chances of operations timing out, run the repair job during off-peak hours. As the job reconciles the search index with database and Git repository data, one CPU will be used. Monitor your system's load averages and CPU usage with a utility like `top`. If you don't notice any significant increase in resource consumption, it should also be safe to run an index repair job during peak hours. -This controls how the [Issues][] index is repaired. You can +Repair jobs use a "repair offset" for parallelization. This is an offset into the database table for the record being reconciled. Multiple background jobs can synchronize work based on this offset. - [Issues]: https://github.com/blog/831-issues-2-0-the-next-generation +### Code search + +This allows you to enable or disable both search and index operations on source code. -- enable or disable index repair jobs -- start a new index repair job -- reset all index repair state {% endif %} ## Reserved logins diff --git a/translations/ja-JP/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md b/translations/ja-JP/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md index bd057690ded2..26c77b37b92c 100644 --- a/translations/ja-JP/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md +++ b/translations/ja-JP/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md @@ -15,7 +15,7 @@ topics: shortTitle: Initiate failover to appliance --- -フェイルオーバーに必要な時間は、レプリカを手動で昇格させてトラフィックをリダイレクトするのにかかる時間によって異なります。 平均的な時間は 2 分から 10 分です。 +フェイルオーバーに必要な時間は、レプリカを手動で昇格させてトラフィックをリダイレクトするのにかかる時間によって異なります。 平均的な時間は 20 分から 30 分です。 {% data reusables.enterprise_installation.promoting-a-replica %} diff --git a/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md b/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md index 2dab1e7ae763..3d2f8d9e296b 100644 --- a/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md +++ b/translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md @@ -83,7 +83,7 @@ You can create a runner group to manage access to the runner that you added to y {% data variables.product.product_name %} adds all new runners to a group. Runners can be in one group at a time. By default, {% data variables.product.product_name %} adds new runners to the "Default" group. -{% data reusables.actions.self-hosted-runner-groups-add-to-enterprise-first-steps %} +{% data reusables.actions.runner-groups-add-to-enterprise-first-steps %} 1. To choose a policy for organization access, under "Organization access", select the **Organization access** drop-down, and click **Selected organizations**. 1. To the right of the drop-down with the organization access policy, click {% octicon "gear" aria-label="The Gear icon" %}. 1. Select the organizations you'd like to grant access to the runner group. @@ -100,7 +100,7 @@ You can create a runner group to manage access to the runner that you added to y {% endwarning %} {%- endif %} -{% data reusables.actions.self-hosted-runner-create-group %} +{% data reusables.actions.create-runner-group %} {%- ifversion ghec or ghes > 3.3 or ghae-issue-5091 %} 1. Click the "Runners" tab. 1. In the list of runners, click the runner that you deployed in the previous section. diff --git a/translations/ja-JP/content/admin/guides.md b/translations/ja-JP/content/admin/guides.md index 7c7bd4d10c46..ce248970b6bf 100644 --- a/translations/ja-JP/content/admin/guides.md +++ b/translations/ja-JP/content/admin/guides.md @@ -45,6 +45,7 @@ includeGuides: - /admin/configuration/configuring-built-in-firewall-rules - /admin/configuration/configuring-code-scanning-for-your-appliance - /admin/configuration/configuring-data-encryption-for-your-enterprise + - /admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-dependency-review-for-your-appliance - /admin/configuration/configuring-dns-nameservers - /admin/configuration/configuring-rate-limits - /admin/configuration/configuring-secret-scanning-for-your-appliance diff --git a/translations/ja-JP/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md b/translations/ja-JP/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md index 82ae28f7a58b..f548ac98b4ac 100644 --- a/translations/ja-JP/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md +++ b/translations/ja-JP/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md @@ -44,7 +44,8 @@ You set up the audit log stream on {% data variables.product.product_name %} by - [Amazon S3](#setting-up-streaming-to-amazon-s3) - [Azure Blob Storage](#setting-up-streaming-to-azure-blob-storage) -- [Azure Event Hubs](#setting-up-streaming-to-azure-event-hubs) +- [Azure Event Hubs](#setting-up-streaming-to-azure-event-hubs){% ifversion streaming-datadog %} +- [Datadog](#setting-up-streaming-to-datadog){% endif %} - [Google Cloud Storage](#setting-up-streaming-to-google-cloud-storage) - [Splunk](#setting-up-streaming-to-splunk) @@ -60,7 +61,7 @@ You can set up streaming to S3 with access keys or, to avoid storing long-lived #### Setting up streaming to S3 with access keys {% endif %} -To stream audit logs to Amazon's S3 endpoint, you must have a bucket and access keys. For more information, see [Creating, configuring, and working with Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) in the the AWS documentation. Make sure to block public access to the bucket to protect your audit log information. +To stream audit logs to Amazon's S3 endpoint, you must have a bucket and access keys. For more information, see [Creating, configuring, and working with Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) in the AWS documentation. Make sure to block public access to the bucket to protect your audit log information. To set up audit log streaming from {% data variables.product.prodname_dotcom %} you will need: * The name of your Amazon S3 bucket @@ -231,6 +232,32 @@ You need two pieces of information about your event hub: its instance name and t {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} +{% ifversion streaming-datadog %} +### Setting up streaming to Datadog + +To set up streaming to Datadog, you must create a client token or an API key in Datadog, then configure audit log streaming in {% data variables.product.product_name %} using the token for authentication. You do not need to create a bucket or other storage container in Datadog. + +After you set up streaming to Datadog, you can see your audit log data by filtering by "github.audit.streaming." For more information, see [Log Management](https://docs.datadoghq.com/logs/). + +1. If you don't already have a Datadog account, create one. +1. In Datadog, generate a client token or an API key, then click **Copy key**. For more information, see [API and Application Keys](https://docs.datadoghq.com/account_management/api-app-keys/) in Datadog Docs. +{% data reusables.enterprise.navigate-to-log-streaming-tab %} +1. Select the **Configure stream** dropdown menu and click **Datadog**. + + ![Screenshot of the "Configure stream" dropdown menu with "Datadog" highlighted](/assets/images/help/enterprises/audit-stream-choice-datadog.png) +1. Under "Token", paste the token you copied earlier. + + ![Screenshot of the "Token" field](/assets/images/help/enterprises/audit-stream-datadog-token.png) +1. Select the "Site" dropdown menu and click your Datadog site. To determine your Datadog site, compare your Datadog URL to the table in [Datadog sites](https://docs.datadoghq.com/getting_started/site/) in Datadog Docs. + + ![Screenshot of the "Site" dropdown menu](/assets/images/help/enterprises/audit-stream-datadog-site.png) +1. To verify that {% data variables.product.prodname_dotcom %} can connect and write to the Datadog endpoint, click **Check endpoint**. + + ![エンドポイントのチェック](/assets/images/help/enterprises/audit-stream-check.png) +{% data reusables.enterprise.verify-audit-log-streaming-endpoint %} +1. After a few minutes, confirm that audit log data is appearing on the **Logs** tab in Datadog. If audit log data is not appearing, confirm that your token and site are correct in {% data variables.product.prodname_dotcom %}. +{% endif %} + ### Setting up streaming to Google Cloud Storage To set up streaming to Google Cloud Storage, you must create a service account in Google Cloud with the appropriate credentials and permissions, then configure audit log streaming in {% data variables.product.product_name %} using the service account's credentials for authentication. @@ -291,6 +318,10 @@ To stream audit logs to Splunk's HTTP Event Collector (HEC) endpoint you must ma Pausing the stream allows you to perform maintenance on the receiving application without losing audit data. Audit logs are stored for up to seven days on {% data variables.product.product_location %} and are then exported when you unpause the stream. +{% ifversion streaming-datadog %} +Datadog only accepts logs from up to 18 hours in the past. If you pause a stream to a Datadog endpoint for more than 18 hours, you risk losing logs that Datadog won't accept after you resume streaming. +{% endif %} + {% data reusables.enterprise.navigate-to-log-streaming-tab %} 1. Click **Pause stream**. diff --git a/translations/ja-JP/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md b/translations/ja-JP/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md index 969d9ecc64a5..2930524ca1ca 100644 --- a/translations/ja-JP/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md +++ b/translations/ja-JP/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md @@ -121,7 +121,7 @@ For more information about the audit log REST API, see "[Enterprise administrati The query below searches for audit log events created on Jan 1st, 2022 in the `avocado-corp` enterprise, and return the first page with a maximum of 100 items per page using [REST API pagination](/rest/overview/resources-in-the-rest-api#pagination): ```shell -curl -H "Authorization: token TOKEN" \ +curl -H "Authorization: Bearer TOKEN" \ --request GET \ "https://api.github.com/enterprises/avocado-corp/audit-log?phrase=created:2022-01-01&page=1&per_page=100" ``` @@ -133,7 +133,7 @@ You can specify multiple search phrases, such as `created` and `actor`, by separ The query below searches for audit log events for pull requests, where the event occurred on or after Jan 1st, 2022 in the `avocado-corp` enterprise, and the action was performed by the `octocat` user: ```shell -curl -H "Authorization: token TOKEN" \ +curl -H "Authorization: Bearer TOKEN" \ --request GET \ "https://api.github.com/enterprises/avocado-corp/audit-log?phrase=action:pull_request+created:>=2022-01-01+actor:octocat" ``` diff --git a/translations/ja-JP/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md b/translations/ja-JP/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md index fb5ca5e1463a..c6c439114938 100644 --- a/translations/ja-JP/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md +++ b/translations/ja-JP/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md @@ -79,6 +79,8 @@ Enterprise owners can restrict access to private assets owned by organizations i {% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %} +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} diff --git a/translations/ja-JP/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md b/translations/ja-JP/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md index 77c7fffea004..d3757186dbe4 100644 --- a/translations/ja-JP/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md +++ b/translations/ja-JP/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md @@ -44,7 +44,7 @@ The Migrations API is currently in a preview period, which means that the endpoi * Your access token for authentication. * A [list of the repositories](/free-pro-team@latest/rest/repos#list-organization-repositories) you want to migrate: ```shell - curl -H "Authorization: token GITHUB_ACCESS_TOKEN" \ + curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" \ -X POST \ -H "Accept: application/vnd.github+json" \ -d'{"lock_repositories":true,"repositories":["orgname/reponame", "orgname/reponame"]}' \ @@ -59,7 +59,7 @@ The Migrations API is currently in a preview period, which means that the endpoi * Your access token for authentication. * The unique `id` of the migration: ```shell - curl -H "Authorization: token GITHUB_ACCESS_TOKEN" \ + curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" \ -H "Accept: application/vnd.github+json" \ https://api.github.com/orgs/orgname/migrations/id ``` @@ -74,7 +74,7 @@ The Migrations API is currently in a preview period, which means that the endpoi * Your access token for authentication. * The unique `id` of the migration: ```shell - curl -H "Authorization: token GITHUB_ACCESS_TOKEN" \ + curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" \ -H "Accept: application/vnd.github+json" \ -L -o migration_archive.tar.gz \ https://api.github.com/orgs/orgname/migrations/id/archive @@ -84,7 +84,7 @@ The Migrations API is currently in a preview period, which means that the endpoi * Your access token for authentication. * The unique `id` of the migration: ```shell - curl -H "Authorization: token GITHUB_ACCESS_TOKEN" \ + curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" \ -X DELETE \ -H "Accept: application/vnd.github+json" \ https://api.github.com/orgs/orgname/migrations/id/archive diff --git a/translations/ja-JP/content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md b/translations/ja-JP/content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md index 7d9124d0ebb3..b8a38edae44a 100644 --- a/translations/ja-JP/content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md +++ b/translations/ja-JP/content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md @@ -134,7 +134,7 @@ $ ghe-migrator audit -s failed_import,failed_map,failed_rename,failed_merge -g < * 移行のユニーク`id` * アンロックするリポジトリの名前 ```shell -curl -H "Authorization: token GITHUB_ACCESS_TOKEN" -X DELETE \ +curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" -X DELETE \ -H "Accept: application/vnd.github.wyandotte-preview+json" \ https://api.github.com/orgs/orgname/migrations/id/repos/repo_name/lock ``` @@ -143,7 +143,7 @@ curl -H "Authorization: token GITHUB_ACCESS_TOKEN" -X DELETE \ {% data variables.product.prodname_dotcom_the_website %} Organization のリポジトリをロック解除した後、[リポジトリ削除エンドポイント](/rest/repos/#delete-a-repository)を使用して以前に移行したすべてのリポジトリを削除する必要があります。 認証のためのアクセストークンが必要になります。 ```shell -curl -H "Authorization: token GITHUB_ACCESS_TOKEN" -X DELETE \ +curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" -X DELETE \ https://api.github.com/repos/orgname/repo_name ``` diff --git a/translations/ja-JP/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md b/translations/ja-JP/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md index ca5cd18d907f..a51f2ff18b19 100644 --- a/translations/ja-JP/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md +++ b/translations/ja-JP/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md @@ -29,11 +29,11 @@ topics: {% data reusables.command_line.open_the_multi_os_terminal %} 3. GPG キーペアを生成します。 GPG には複数のバージョンがあるため、関連する [_man ページ_](https://en.wikipedia.org/wiki/Man_page)を参考にして適切なキーの生成コマンドを見つける必要があります。 キーには RSA を使用する必要があります。 - バージョン 2.1.17 以降の場合は、以下のテキストを貼り付けて GPG キーペアを生成します。 - ```shell + ```shell{:copy} $ gpg --full-generate-key ``` - バージョン 2.1.17 およびそれ以降でない場合は、 `gpg --full-generate-key` コマンドが使えません。 以下のテキストを貼り付けてステップ 6 に進んでください。 - ```shell + ```shell{:copy} $ gpg --default-new-key-algo rsa4096 --gen-key ``` 4. At the prompt, specify the kind of key you want, or press `Enter` to accept the default. @@ -52,10 +52,10 @@ topics: {% data reusables.gpg.list-keys-with-note %} {% data reusables.gpg.copy-gpg-key-id %} 10. 以下のテキストを貼り付けます。GPG キー ID は実際に使用するものを入力してください。 この例では、GPG キー ID は `3AA5C34371567BD2` です。 - ```shell - $ gpg --armor --export 3AA5C34371567BD2 - # ASCII armor 形式で GPG キーを出力する - ``` + ```shell{:copy} + $ gpg --armor --export 3AA5C34371567BD2 + # Prints the GPG key ID, in ASCII armor format + ``` 11. `-----BEGIN PGP PUBLIC KEY BLOCK-----` で始まり、`-----END PGP PUBLIC KEY BLOCK-----` で終わる GPG キーをコピーします。 12. [GPG キーを GitHub アカウントに追加](/articles/adding-a-gpg-key-to-your-github-account)します。 diff --git a/translations/ja-JP/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md b/translations/ja-JP/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md index 2d5feaab0af3..1388e420aab7 100644 --- a/translations/ja-JP/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md +++ b/translations/ja-JP/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md @@ -1,6 +1,7 @@ --- title: GitHub Actionsの支払いについて intro: 'アカウントに含まれるストレージや利用時間 (分) を超えて{% data variables.product.prodname_actions %}を使用したい場合は、追加の使用分が請求されます。' +miniTocMaxHeadingLevel: 3 redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions/about-billing-for-github-actions @@ -28,6 +29,13 @@ Microsoft Enterprise Agreement を通じて {% data variables.product.prodname_e ### 含まれるストレージと分 +{% ifversion actions-hosted-runners %} +{% note %} + +**ノート**: 利用権のある分は、2コア以上のWindows及びUbuntuランナーには使用できません。 これらのランナーは、パブリックリポジトリを含め、常に課金されます。 詳しい情報については「[ランナーの分ごとのレート](/billing/managing-billing-for-github-actions/about-billing-for-github-actions#per-minute-rates)」を参照してください。 + +{% endnote %} +{% endif %} | 製品 | ストレージ | 分 (月あたり) | | ---------------------------------------------------------------- | ------ | -------- | | {% data variables.product.prodname_free_user %} | 500 MB | 2,000 | @@ -58,15 +66,15 @@ Microsoft Enterprise Agreement を通じて {% data variables.product.prodname_e ### 分あたりの料金 -| オペレーティングシステム | 分あたりの料金(米ドル) | -| ------------ | ------------ | -| Linux | $0.008 | -| macOS | $0.08 | -| Windows | $0.016 | - -アカウントもしくはOrganization内のすべてのリポジトリにわたって同時に実行できるジョブ数は、あなたのGitHubのプランによります。 詳細については、{% data variables.product.prodname_dotcom %} ホストランナーの「[使用制限と支払い](/actions/reference/usage-limits-billing-and-administration)」、およびセルフホストランナーの使用制限については「[セルフホストランナーについて](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)」を参照してください。 +{% data reusables.billing.billing-standard-runners %} +{% ifversion actions-hosted-runners %}{% data reusables.billing.billing-hosted-runners %}{% endif %} -{% data reusables.user-settings.context_switcher %} +- アカウントもしくはOrganization内のすべてのリポジトリにわたって同時に実行できるジョブ数は、あなたのGitHubのプランによります。 詳細については、{% data variables.product.prodname_dotcom %} ホストランナーの「[使用制限と支払い](/actions/reference/usage-limits-billing-and-administration)」、およびセルフホストランナーの使用制限については「[セルフホストランナーについて](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)」を参照してください。 +- {% data reusables.user-settings.context_switcher %} +{% ifversion actions-hosted-runners %} +- {% data variables.actions.hosted_runner %}については、{% data variables.actions.hosted_runner %}へパブリックの静的なIPアドレスを割り当てる設定について追加のコストはありません。 {% data variables.actions.hosted_runner %}に関する詳しい情報については「[{% data variables.actions.hosted_runner %}の利用](/actions/using-github-hosted-runners/using-larger-runners)」を参照してください。 +- 利用権のある分は{% data variables.actions.hosted_runner %}には使えません。 +{% endif %} ## 利用時間 (分) とストレージ消費量の計算 diff --git a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md index 89a7a591d444..693aff8c64ec 100644 --- a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md +++ b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md @@ -359,7 +359,7 @@ In the following example, the `+` symbol ensures that the specified additional { ## Using a custom configuration file -A custom configuration file is an alternative way to specify additional {% ifversion codeql-packs %}packs and {% endif %}queries to run. You can also use the file to disable the default queries and to specify which directories to scan during analysis. +A custom configuration file is an alternative way to specify additional {% ifversion codeql-packs %}packs and {% endif %}queries to run. You can also use the file to disable the default queries{% ifversion code-scanning-exclude-queries-from-analysis %}, exclude or include specific queries,{% endif %} and to specify which directories to scan during analysis. In the workflow file, use the `config-file` parameter of the `init` action to specify the path to the configuration file you want to use. This example loads the configuration file _./.github/codeql/codeql-config.yml_. @@ -442,6 +442,41 @@ Optionally, you can give each array element a name, as shown in the example conf If you only want to run custom queries, you can disable the default security queries by using `disable-default-queries: true`. +{% ifversion code-scanning-exclude-queries-from-analysis %} +### Excluding specific queries from analysis + +You can add `exclude` and `include` filters to your custom configuration file, to specify the queries you want to exclude or include in the analysis. + +This is useful if you want to exclude, for example: +- Specific queries from the default suites (`security`, `security-extended` and `security-and-quality`). +- Specific queries whose results do not interest you. +- All the queries that generate warnings and recommendations. + +You can use `exclude` filters similar to those in the configuration file below to exclude queries that you want to remove from the default analysis. In the example of configuration file below, both the `js/redundant-assignment` and the `js/useless-assignment-to-local` queries are excluded from analysis. + +```yaml +query-filters: + - exclude: + id: js/redundant-assignment + - exclude: + id: js/useless-assignment-to-local +``` +To find the id of a query, you can click the alert in the list of alerts in the Security tab. This opens the alert details page. The `Rule ID` field contains the query id. For more information about the alert details page, see "[About {% data variables.product.prodname_code_scanning %} alerts](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts#about-alert-details)." + +{% tip %} + +**Tips:** +- The order of the filters is important. The first filter instruction that appears after the instructions about the queries and query packs determines whether the queries are included or excluded by default. +- Subsequent instructions are executed in order and the instructions that appear later in the file take precedence over the earlier instructions. + +{% endtip %} + +You can find another example illustrating the use of these filters in the "[Example configuration files](#example-configuration-files)" section. + +For more information about using `exclude` and `include` filters in your custom configuration file, see "[Creating {% data variables.product.prodname_codeql %} query suites](https://codeql.github.com/docs/codeql-cli/creating-codeql-query-suites/#filtering-the-queries-in-a-query-suite)." For information on the query metadata you can filter on, see "[Metadata for CodeQL queries](https://codeql.github.com/docs/writing-codeql-queries/metadata-for-codeql-queries/)." + +{% endif %} + ### Specifying directories to scan For the interpreted languages that {% data variables.product.prodname_codeql %} supports (Python{% ifversion fpt or ghes > 3.3 or ghae-issue-5017 %}, Ruby{% endif %} and JavaScript/TypeScript), you can restrict {% data variables.product.prodname_code_scanning %} to files in specific directories by adding a `paths` array to the configuration file. You can exclude the files in specific directories from analysis by adding a `paths-ignore` array. diff --git a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md index a5948aba46cb..23e20a25a332 100644 --- a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md +++ b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md @@ -43,8 +43,8 @@ By default, the code scanning alerts page is filtered to show alerts for the def ![Summary of alerts](/assets/images/help/repository/code-scanning-click-alert.png) {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %} - {% data reusables.code-scanning.alert-default-branch %} - ![The "Affected branches" section in an alert](/assets/images/help/repository/code-scanning-affected-branches.png){% endif %} + {% data reusables.code-scanning.alert-default-branch %} + ![The "Affected branches" section in an alert](/assets/images/help/repository/code-scanning-affected-branches.png){% endif %} 1. Optionally, if the alert highlights a problem with data flow, click **Show paths** to display the path from the data source to the sink where it's used. {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %} ![The "Show paths" link on an alert](/assets/images/help/repository/code-scanning-show-paths.png) diff --git a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md index 52e0b98fd34f..32cea9db26fa 100644 --- a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md +++ b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md @@ -151,25 +151,29 @@ The names of the {% data variables.product.prodname_code_scanning %} analysis ch ![{% data variables.product.prodname_code_scanning %} pull request checks](/assets/images/help/repository/code-scanning-pr-checks.png) -When the {% data variables.product.prodname_code_scanning %} jobs complete, {% data variables.product.prodname_dotcom %} works out whether any alerts were added by the pull request and adds the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" entry to the list of checks. After {% data variables.product.prodname_code_scanning %} has been performed at least once, you can click **Details** to view the results of the analysis. If you used a pull request to add {% data variables.product.prodname_code_scanning %} to the repository, you will initially see {% ifversion fpt or ghes > 3.2 or ghae or ghec %}an "Analysis not found"{% else %}a "Missing analysis"{% endif %} message when you click **Details** on the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" check. +When the {% data variables.product.prodname_code_scanning %} jobs complete, {% data variables.product.prodname_dotcom %} works out whether any alerts were added by the pull request and adds the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" entry to the list of checks. After {% data variables.product.prodname_code_scanning %} has been performed at least once, you can click **Details** to view the results of the analysis. -{% ifversion fpt or ghes > 3.2 or ghae or ghec %} - ![Analysis not found for commit message](/assets/images/help/repository/code-scanning-analysis-not-found.png) +{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-7095 %} + +{% elsif ghes < 3.5 or ghae %} +If you used a pull request to add {% data variables.product.prodname_code_scanning %} to the repository, you will initially see {% ifversion ghes > 3.2 or ghae %}an "Analysis not found"{% elsif ghes = 3.2 %}a "Missing analysis"{% endif %} message when you click **Details** on the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" check. + +{% ifversion ghes > 3.2 or ghae %} + ![Analysis not found for commit message](/assets/images/enterprise/3.4/repository/code-scanning-analysis-not-found.png) The table lists one or more categories. Each category relates to specific analyses, for the same tool and commit, performed on a different language or a different part of the code. For each category, the table shows the two analyses that {% data variables.product.prodname_code_scanning %} attempted to compare to determine which alerts were introduced or fixed in the pull request. For example, in the screenshot above, {% data variables.product.prodname_code_scanning %} found an analysis for the merge commit of the pull request, but no analysis for the head of the main branch. -{% else %} - ![Missing analysis for commit message](/assets/images/enterprise/3.2/repository/code-scanning-missing-analysis.png) -{% endif %} -{% ifversion fpt or ghes > 3.2 or ghae or ghec %} ### Reasons for the "Analysis not found" message -{% else %} + +{% elsif ghes = 3.2 %} + ![Missing analysis for commit message](/assets/images/enterprise/3.2/repository/code-scanning-missing-analysis.png) + ### Reasons for the "Missing analysis" message {% endif %} -After {% data variables.product.prodname_code_scanning %} has analyzed the code in a pull request, it needs to compare the analysis of the topic branch (the branch you used to create the pull request) with the analysis of the base branch (the branch into which you want to merge the pull request). This allows {% data variables.product.prodname_code_scanning %} to compute which alerts are newly introduced by the pull request, which alerts were already present in the base branch, and whether any existing alerts are fixed by the changes in the pull request. Initially, if you use a pull request to add {% data variables.product.prodname_code_scanning %} to a repository, the base branch has not yet been analyzed, so it's not possible to compute these details. In this case, when you click through from the results check on the pull request you will see the {% ifversion fpt or ghes > 3.2 or ghae or ghec %}"Analysis not found"{% else %}"Missing analysis for base commit SHA-HASH"{% endif %} message. +After {% data variables.product.prodname_code_scanning %} has analyzed the code in a pull request, it needs to compare the analysis of the topic branch (the branch you used to create the pull request) with the analysis of the base branch (the branch into which you want to merge the pull request). This allows {% data variables.product.prodname_code_scanning %} to compute which alerts are newly introduced by the pull request, which alerts were already present in the base branch, and whether any existing alerts are fixed by the changes in the pull request. Initially, if you use a pull request to add {% data variables.product.prodname_code_scanning %} to a repository, the base branch has not yet been analyzed, so it's not possible to compute these details. In this case, when you click through from the results check on the pull request you will see the {% ifversion ghes > 3.2 or ghae %}"Analysis not found"{% elsif ghes = 3.2 %}"Missing analysis for base commit SHA-HASH"{% endif %} message. There are other situations where there may be no analysis for the latest commit to the base branch for a pull request. These include: @@ -177,7 +181,7 @@ There are other situations where there may be no analysis for the latest commit To check whether a branch has been scanned, go to the {% data variables.product.prodname_code_scanning_capc %} page, click the **Branch** drop-down and select the relevant branch. -![Choose a branch from the Branch drop-down menu](/assets/images/help/repository/code-scanning-branch-dropdown.png) + ![Choose a branch from the Branch drop-down menu](/assets/images/help/repository/code-scanning-branch-dropdown.png) The solution in this situation is to add the name of the base branch to the `on:push` and `on:pull_request` specification in the {% data variables.product.prodname_code_scanning %} workflow on that branch and then make a change that updates the open pull request that you want to scan. @@ -189,6 +193,8 @@ There are other situations where there may be no analysis for the latest commit Merge a trivial change into the base branch to trigger {% data variables.product.prodname_code_scanning %} on this latest commit, then push a change to the pull request to retrigger {% data variables.product.prodname_code_scanning %}. +{% endif %} + ## Next steps After setting up {% data variables.product.prodname_code_scanning %}, and allowing its actions to complete, you can: diff --git a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md index c983e246ac18..5cad113a821a 100644 --- a/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md +++ b/translations/ja-JP/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md @@ -33,8 +33,6 @@ In repositories where {% data variables.product.prodname_code_scanning %} is con - The **Conversation** tab of the pull request, as part of a pull request review {% endif %} - The **Files changed** tab of the pull request -{% ifversion code-scanning-pr-conversations-tab %} {% endif %} - If you have write permission for the repository, you can see any existing {% data variables.product.prodname_code_scanning %} alerts on the **Security** tab. For information about repository alerts, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)." {% ifversion fpt or ghes > 3.2 or ghae or ghec %} diff --git a/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md b/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md index daeb17e4833c..74df7049d25c 100644 --- a/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md +++ b/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md @@ -45,9 +45,15 @@ If you upload a second SARIF file for a commit with the same category and from t If you're new to SARIF and want to learn more, see Microsoft's [`SARIF tutorials`](https://github.com/microsoft/sarif-tutorials) repository. -## Preventing duplicate alerts using fingerprints +## Providing data to track {% data variables.product.prodname_code_scanning %} alerts across runs -Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the right line of code when files are edited. +Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the correct line of code when files are edited. The `ruleID` for a result has to be the same across analysis. + +### Reporting consistent filepaths + +The filepath has to be consistent across the runs to enable a computation of a stable fingerprint. If the filepaths differ for the same result, each time there is a new analysis a new alert will be created, and the old one will be closed. This will cause having multiple alerts for the same result. + +### Including data for fingerprint generation {% data variables.product.prodname_dotcom %} uses the `partialFingerprints` property in the OASIS standard to detect when two results are logically identical. For more information, see the "[partialFingerprints property](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012611)" entry in the OASIS documentation. @@ -77,6 +83,12 @@ You can check a SARIF file is compatible with {% data variables.product.prodname If you use a code analysis engine other than {% data variables.product.prodname_codeql %}, you can review the supported SARIF properties to optimize how your analysis results will appear on {% data variables.product.prodname_dotcom %}. +{% note %} + +**Note:** You must supply an explicit value for any property marked as "required". The empty string is not supported for required properties. + +{% endnote %} + Any valid SARIF 2.1.0 output file can be uploaded, however, {% data variables.product.prodname_code_scanning %} will only use the following supported properties. ### `sarifLog` object @@ -138,7 +150,7 @@ Each `result` object contains details for one alert in the codebase. Within the | `level`| **Optional.** The severity of the result. This level overrides the default severity defined by the rule. {% data variables.product.prodname_code_scanning_capc %} uses the level to filter results by severity on {% data variables.product.prodname_dotcom %}. | `message.text`| **Required.** A message that describes the result. {% data variables.product.prodname_code_scanning_capc %} displays the message text as the title of the result. Only the first sentence of the message will be displayed when visible space is limited. | `locations[]`| **Required.** The set of locations where the result was detected up to a maximum of 10. Only one location should be included unless the problem can only be corrected by making a change at every specified location. **Note:** At least one location is required for {% data variables.product.prodname_code_scanning %} to display a result. {% data variables.product.prodname_code_scanning_capc %} will use this property to decide which file to annotate with the result. Only the first value of this array is used. All other values are ignored. -| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Preventing duplicate alerts using fingerprints](#preventing-duplicate-alerts-using-fingerprints)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. +| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Providing data to track code scanning alerts across runs](#providing-data-to-track-code-scanning-alerts-across-runs)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. | `codeFlows[].threadFlows[].locations[]`| **Optional.** An array of `location` objects for a `threadFlow` object, which describes the progress of a program through a thread of execution. A `codeFlow` object describes a pattern of code execution used to detect a result. If code flows are provided, {% data variables.product.prodname_code_scanning %} will expand code flows on {% data variables.product.prodname_dotcom %} for the relevant result. For more information, see the [`location` object](#location-object). | `relatedLocations[]`| A set of locations relevant to this result. {% data variables.product.prodname_code_scanning_capc %} will link to related locations when they are embedded in the result message. For more information, see the [`location` object](#location-object). @@ -204,7 +216,7 @@ These example SARIF output files show supported properties and example values. ### Example with minimum required properties -This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties or don't include values, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. +This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties, omit values, or use an empty string, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. ```json { diff --git a/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md b/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md index 1e03a239f38e..193ee54f5aa9 100644 --- a/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md +++ b/translations/ja-JP/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md @@ -58,7 +58,7 @@ For more information see the [`upload-sarif` action](https://github.com/github/c The `upload-sarif` action can be configured to run when the `push` and `scheduled` event occur. For more information about {% data variables.product.prodname_actions %} events, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." -If your SARIF file doesn't include `partialFingerprints`, the `upload-sarif` action will calculate the `partialFingerprints` field for you and attempt to prevent duplicate alerts. {% data variables.product.prodname_dotcom %} can only create `partialFingerprints` when the repository contains both the SARIF file and the source code used in the static analysis. For more information about preventing duplicate alerts, see "[About SARIF support for code scanning](/code-security/secure-coding/sarif-support-for-code-scanning#preventing-duplicate-alerts-using-fingerprints)." +If your SARIF file doesn't include `partialFingerprints`, the `upload-sarif` action will calculate the `partialFingerprints` field for you and attempt to prevent duplicate alerts. {% data variables.product.prodname_dotcom %} can only create `partialFingerprints` when the repository contains both the SARIF file and the source code used in the static analysis. For more information about preventing duplicate alerts, see "[About SARIF support for code scanning](/code-security/secure-coding/sarif-support-for-code-scanning#providing-data-to-track-code-scanning-alerts-across-runs)." {% data reusables.code-scanning.upload-sarif-alert-limit %} diff --git a/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md b/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md index 54ca86d3afa0..a9c8d47e23ff 100644 --- a/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md +++ b/translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md @@ -78,7 +78,8 @@ You can display the command-line help for any command using the `--help``--command` | | Recommended. Use to specify the build command or script that invokes the build process for the codebase. Commands are run from the current folder or, where it is defined, from `--source-root`. Not needed for Python and JavaScript/TypeScript analysis. | | `--db-cluster` | | Optional. Use in multi-language codebases to generate one database for each language specified by `--language`. | `--no-run-unnecessary-builds` | | Recommended. Use to suppress the build command for languages where the {% data variables.product.prodname_codeql_cli %} does not need to monitor the build (for example, Python and JavaScript/TypeScript). -| `--source-root` | | Optional. Use if you run the CLI outside the checkout root of the repository. By default, the `database create` command assumes that the current directory is the root directory for the source files, use this option to specify a different location. | +| `--source-root` | | Optional. Use if you run the CLI outside the checkout root of the repository. By default, the `database create` command assumes that the current directory is the root directory for the source files, use this option to specify a different location. |{% ifversion fpt or ghec or ghes > 3.2 or ghae %} +| `--codescanning-config` | | Optional (Advanced). Use if you have a configuration file that specifies how to create the {% data variables.product.prodname_codeql %} databases and what queries to run in later steps. For more information, see "[Using a custom configuration file](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-a-custom-configuration-file)" and "[database create](https://codeql.github.com/docs/codeql-cli/manual/database-create/#cmdoption-codeql-database-create-codescanning-config)." |{% endif %} For more information, see [Creating {% data variables.product.prodname_codeql %} databases](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/) in the documentation for the {% data variables.product.prodname_codeql_cli %}. diff --git a/translations/ja-JP/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md b/translations/ja-JP/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md index aafa359dad80..25efa92f844b 100644 --- a/translations/ja-JP/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md +++ b/translations/ja-JP/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md @@ -415,7 +415,7 @@ updates: ### `open-pull-requests-limit` -デフォルトでは、{% data variables.product.prodname_dependabot %} は、バージョン更新に対して最大 5 つのプルリクエストをオープンします。 5 つのプルリクエストがオープンになると、オープンになっているリクエストの一部をマージまたはクローズするまで、新しいリクエストはブロックされます。オープンになっているリクエストの一部をマージまたはクローズしたら、その後の更新で新しいプルリクエストを開くことができます。 この制限を変更するには、`open-pull-requests-limit` を使用します。 これは、パッケージマネージャーのバージョン更新を一時的に無効にする簡単な方法としても使用できます。 +デフォルトでは、{% data variables.product.prodname_dependabot %} は、バージョン更新に対して最大 5 つのプルリクエストをオープンします。 {% data variables.product.prodname_dependabot %}からのオープンなPull Requestが5つあると、それらのオープンなリクエストからマージもしくはクローズされたものが出てくるまでは、{% data variables.product.prodname_dependabot %}は新しいリクエストをオープンしません。 この制限を変更するには、`open-pull-requests-limit` を使用します。 これは、パッケージマネージャーのバージョン更新を一時的に無効にする簡単な方法としても使用できます。 このオプションはセキュリティアップデートに影響を与えません。セキュリティアップデートには、10 件のオープンプルリクエストの内部制限があります。 diff --git a/translations/ja-JP/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review.md b/translations/ja-JP/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review.md index 8cd2a8c8bd30..fc7c3c8b88a6 100644 --- a/translations/ja-JP/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review.md +++ b/translations/ja-JP/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review.md @@ -72,7 +72,7 @@ topics: {% endtip %} {% endif %} -この{% data variables.product.prodname_dependency_review_action %}のサンプルファイルは、これらの設定オプションの使い方を示しています。 +この{% data variables.product.prodname_dependency_review_action %}のサンプルファイルは、これらの設定オプションの使い方を示しています。 Notice that the example uses short version number for the action (`v2`) instead of a semver release number (for example, `v2.0.8`). This ensures that you use the most recent minor version of the action. ```yaml{:copy} name: 'Dependency Review' diff --git a/translations/ja-JP/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md b/translations/ja-JP/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md index 7f94a835ea07..f71712faf008 100644 --- a/translations/ja-JP/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md +++ b/translations/ja-JP/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md @@ -12,25 +12,25 @@ shortTitle: プライベートイメージレジストリ ## About private image registries and {% data variables.product.prodname_github_codespaces %} -A registry is a secure space for storing, managing, and fetching private container images. You may use one to store one or more images. There are many examples of registries, such as {% data variables.product.prodname_dotcom %} Container Registry, Azure Container Registry, or DockerHub. +A registry is a secure space for storing, managing, and fetching private container images. You may use one to store one or more images. There are many examples of registries, such as {% data variables.product.prodname_container_registry %}, {% data variables.product.prodname_npm_registry %}, Azure Container Registry, or DockerHub. -{% data variables.product.prodname_dotcom %} Container Registry can be configured to pull container images seamlessly, without having to provide any authentication credentials to {% data variables.product.prodname_github_codespaces %}. For other image registries, you must create secrets in {% data variables.product.prodname_dotcom %} to store the access details, which will allow {% data variables.product.prodname_codespaces %} to access images stored in that registry. +{% data variables.product.prodname_ghcr_and_npm_registry %} can be configured to allow container images to be pulled seamlessly into {% data variables.product.prodname_github_codespaces %} during codespace creation, without having to provide any authentication credentials. For other image registries, you must create secrets in {% data variables.product.prodname_dotcom %} to store the access details, which will allow {% data variables.product.prodname_codespaces %} to access images stored in that registry. -## Accessing images stored in {% data variables.product.prodname_dotcom %} Container Registry +## Accessing images stored in {% data variables.product.prodname_ghcr_and_npm_registry %} -{% data variables.product.prodname_dotcom %} Container Registry is the easiest way for {% data variables.product.prodname_codespaces %} to consume devcontainer container images. +{% data variables.product.prodname_ghcr_and_npm_registry %} provide the easiest way for {% data variables.product.prodname_codespaces %} to consume dev container images. -For more information, see "[Working with the Container registry](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)". +For more information, see "[Working with the Container registry](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)" and "[Working with the npm registry](/packages/working-with-a-github-packages-registry/working-with-the-npm-registry)". ### Accessing an image published to the same repository as the codespace -If you publish a container image to {% data variables.product.prodname_dotcom %} Container Registry in the same repository that the codespace is being launched in, you will automatically be able to fetch that image on codespace creation. You won't have to provide any additional credentials, unless the **Inherit access from repo** option was unselected when the container image was published. +If you publish a container image to {% data variables.product.prodname_ghcr_or_npm_registry %} in the same repository that the codespace is being launched in, you will automatically be able to fetch that image on codespace creation. You won't have to provide any additional credentials, unless the **Inherit access from repo** option was unselected when the container image was published. #### Inheriting access from the repository from which an image was published -By default, when you publish a container image to {% data variables.product.prodname_dotcom %} Container Registry, the image inherits the access setting of the repository from which the image was published. For example, if the repository is public, the image is also public. If the repository is private, the image is also private, but is accessible from the repository. +By default, when you publish a container image to {% data variables.product.prodname_ghcr_or_npm_registry %}, the image inherits the access setting of the repository from which the image was published. For example, if the repository is public, the image is also public. If the repository is private, the image is also private, but is accessible from the repository. -This behavior is controlled by the **Inherit access from repo** option. **Inherit access from repo** is selected by default when publishing via {% data variables.product.prodname_actions %}, but not when publishing directly to {% data variables.product.prodname_dotcom %} Container Registry using a Personal Access Token (PAT). +This behavior is controlled by the **Inherit access from repo** option. **Inherit access from repo** is selected by default when publishing via {% data variables.product.prodname_actions %}, but not when publishing directly to {% data variables.product.prodname_ghcr_or_npm_registry %} using a Personal Access Token (PAT). If the **Inherit access from repo** option was not selected when the image was published, you can manually add the repository to the published container image's access controls. 詳しい情報については「[パッケージのアクセス制御と可視性](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#inheriting-access-for-a-container-image-from-a-repository)」を参照してください。 @@ -46,13 +46,13 @@ If you want to allow a subset of an organization's repositories to access a cont ### Publishing a container image from a codespace -Seamless access from a codespace to {% data variables.product.prodname_dotcom %} Container Registry is limited to pulling container images. If you want to publish a container image from inside a codespace, you must use a personal access token (PAT) with the `write:packages` scope. +Seamless access from a codespace to {% data variables.product.prodname_ghcr_or_npm_registry %} is limited to pulling container images. If you want to publish a container image from inside a codespace, you must use a personal access token (PAT) with the `write:packages` scope. -We recommend publishing images via {% data variables.product.prodname_actions %}. For more information, see "[Publishing Docker images](/actions/publishing-packages/publishing-docker-images)." +We recommend publishing images via {% data variables.product.prodname_actions %}. For more information, see "[Publishing Docker images](/actions/publishing-packages/publishing-docker-images)" and "[Publishing Node.js packages](/actions/publishing-packages/publishing-nodejs-packages)." ## Accessing images stored in other container registries -If you are accessing a container image from a registry that isn't {% data variables.product.prodname_dotcom %} Container Registry, {% data variables.product.prodname_codespaces %} checks for the presence of three secrets, which define the server name, username, and personal access token (PAT) for a container registry. これらのシークレットが見つかった場合、{% data variables.product.prodname_github_codespaces %} はレジストリを codespace 内で使用できるようにします。 +If you are accessing a container image from a registry that isn't {% data variables.product.prodname_ghcr_or_npm_registry %}, {% data variables.product.prodname_codespaces %} checks for the presence of three secrets, which define the server name, username, and personal access token (PAT) for a container registry. これらのシークレットが見つかった場合、{% data variables.product.prodname_github_codespaces %} はレジストリを codespace 内で使用できるようにします。 - `<*>_CONTAINER_REGISTRY_SERVER` - `<*>_CONTAINER_REGISTRY_USER` diff --git a/translations/ja-JP/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md b/translations/ja-JP/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md index fe5c5af7c40d..3515dfcd64bb 100644 --- a/translations/ja-JP/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md +++ b/translations/ja-JP/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md @@ -17,7 +17,7 @@ redirect_from: ## {% data variables.product.prodname_vscode_command_palette %} について -The Command Palette is one of the focal features of {% data variables.product.prodname_vscode %} and is available for you to use in {% data variables.product.prodname_github_codespaces %}. The {% data variables.product.prodname_vscode_command_palette %} allows you to access many commands for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_vscode_shortname %}. For more information on using the {% data variables.product.prodname_vscode_command_palette_shortname %}, see "[User Interface](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette)" in the {% data variables.product.prodname_vscode_shortname %} documentation. +The Command Palette is one of the focal features of {% data variables.product.prodname_vscode %} and is available for you to use in {% data variables.product.prodname_github_codespaces %}. コマンドパレットを使用すると、{% data variables.product.prodname_codespaces %} および {% data variables.product.prodname_vscode_shortname %} の多くのコマンドにアクセスできます。 For more information on using the {% data variables.product.prodname_vscode_command_palette_shortname %}, see "[User Interface](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette)" in the {% data variables.product.prodname_vscode_shortname %} documentation. ## Accessing the {% data variables.product.prodname_vscode_command_palette_shortname %} diff --git a/translations/ja-JP/content/codespaces/developing-in-codespaces/getting-started-with-github-codespaces-for-machine-learning.md b/translations/ja-JP/content/codespaces/developing-in-codespaces/getting-started-with-github-codespaces-for-machine-learning.md new file mode 100644 index 000000000000..f33a542c769a --- /dev/null +++ b/translations/ja-JP/content/codespaces/developing-in-codespaces/getting-started-with-github-codespaces-for-machine-learning.md @@ -0,0 +1,120 @@ +--- +title: Getting started with GitHub Codespaces for machine learning +shortTitle: Machine learning +intro: 'Learn about working on machine learning projects with {% data variables.product.prodname_github_codespaces %} and its out-of-the-box tools.' +product: '{% data reusables.gated-features.codespaces %}' +versions: + fpt: '*' + ghec: '*' +type: tutorial +topics: + - Codespaces + - Developer +--- + +## はじめに + +This guide introduces you to machine learning with {% data variables.product.prodname_github_codespaces %}. You’ll build a simple image classifier, learn about some of the tools that come preinstalled in {% data variables.product.prodname_github_codespaces %}, configure your development environment for NVIDIA CUDA, and use {% data variables.product.prodname_cli %} to open your codespace in JupyterLab. + +## Prerequisite + +You have access to {% data variables.product.prodname_github_codespaces %}. 詳しい情報については、「[codespace を作成する](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-github-codespaces)」を参照してください。 + +## Build a simple image classifier + +We'll use a Jupyter notebook to build a simple image classifier. + +Jupyter notebooks are sets of cells that you can execute one after another. The notebook we'll use includes a number of cells that build an image classifier using [PyTorch](https://pytorch.org/). Each cell is a different phase of that process: download a dataset, set up a neural network, train a model, and then test that model. + +We'll run all of the cells, in sequence, to perform all phases of building the image classifier. When we do this Jupyter saves the output back into the notebook so that you can examine the results. + +### Creating a repository and a codespace + +1. Go to the [github/codespaces-getting-started-ml](https://github.com/github/codespaces-getting-started-ml) template repository and click **Use this template**. +{% data reusables.codespaces.open-codespace-from-template-repo %} + + By default, a codespace for this repository opens in a web-based version of {% data variables.product.prodname_vscode %}. + +### Open the image classifier notebook + +The default container image that's used by {% data variables.product.prodname_github_codespaces %} includes a set of machine learning libraries that are preinstalled in your codespace. For example, Numpy, pandas, SciPy, Matplotlib, seaborn, scikit-learn, TensorFlow, Keras, PyTorch, Requests, and Plotly. For more information about the default image, see "[Introduction to dev containers](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers#using-the-default-dev-container-configuration)" and [the `devcontainers/images` repository](https://github.com/devcontainers/images/tree/main/src/codespaces#github-codespaces-default-linux-universal). + +1. In the {% data variables.product.prodname_vscode_shortname %} editor, close any "Get Started" tabs that are displayed. +1. Open the `image-classifier.ipynb` notebook file. +1. Click the Python kernel link at the top right of the editor. + + ![Screenshot of the Python kernal link](/assets/images/help/codespaces/jupyter-python-kernel-link.png) + +1. In the drop-down menu, choose the kernel in the directory `/opt/python/latest/bin/python`. + + ![Screenshot of the Python kernal drop-down menu](/assets/images/help/codespaces/jupyter-python-kernel-dropdown.png) + +### Build the image classifier + +The image classifier notebook contains all the code you need to download a dataset, train a neural network, and evaluate its performance. + +1. Click **Run All** to execute all of the notebook’s cells. + + ![Screenshot of the Run All button](/assets/images/help/codespaces/jupyter-run-all.png) + +1. Scroll down to view the output of each cell. + + ![Screenshot of Step 3 in the editor](/assets/images/help/codespaces/jupyter-notebook-step3.png) + +## Configure NVIDIA CUDA for your codespace + +Some software, such as TensorFlow, requires you to install NVIDIA CUDA to use your codespace’s GPU. Where this is the case, you can create your own custom configuration, by using a `devcontainer.json` file, and specify that CUDA should be installed. For more information on creating a custom configuration, see "[Introduction to dev containers](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers#creating-a-custom-dev-container-configuration)." + +{% note %} + +**Note**: For full details of the script that's run when you add the `nvidia-cuda` feature, see [the devcontainers/features repository](https://github.com/devcontainers/features/tree/main/src/nvidia-cuda). + +{% endnote %} + +1. Within a codespace, open the `.devcontainer/devcontainer.json` file in the editor. +1. Add a top-level `features` object with the following contents: + + ```json{:copy} + “features”: { + "ghcr.io/devcontainers/features/nvidia-cuda:1": { + "installCudnn": true + } + } + ``` + + For more information about the `features` object, see the [development containers specification](https://containers.dev/implementors/features/#devcontainer-json-properties). + + If you are using the `devcontainer.json` file from the image classifier repository you created for this tutorial, your `devcontainer.json` file will now look like this: + + ``` + { + "customizations": { + "vscode": { + "extensions": [ + "ms-python.python", + "ms-toolsai.jupyter" + ] + } + }, + “features”: { + "ghcr.io/devcontainers/features/nvidia-cuda:1": { + "installCudnn": true + } + } + } + ``` + +1. Save the change. +{% data reusables.codespaces.rebuild-command %} + The codespace container will be rebuilt. This will take several minutes. When the rebuild is complete the codespace is automatically reopened. +1. Commit the change to the repository so that CUDA will be installed in any new codespaces you create from this repository in future. + +## Open your codespace in JupyterLab + +The default container image that's used by {% data variables.product.prodname_github_codespaces %} includes JupyterLab, the web-based Jupyter IDE. You can use {% data variables.product.prodname_cli %} to open your codespace in JupyterLab without having to install anything else on your codespace. + +1. In the terminal, enter the {% data variables.product.prodname_cli %} command `gh cs jupyter`. +1. Choose the codespace you want to open. + + ![Screenshot of opening a codespace from the terminal](/assets/images/help/codespaces/open-codespace-in-jupyter.png) + diff --git a/translations/ja-JP/content/codespaces/developing-in-codespaces/index.md b/translations/ja-JP/content/codespaces/developing-in-codespaces/index.md index 061964fee11a..d91e90dfa7e6 100644 --- a/translations/ja-JP/content/codespaces/developing-in-codespaces/index.md +++ b/translations/ja-JP/content/codespaces/developing-in-codespaces/index.md @@ -18,6 +18,7 @@ children: - /forwarding-ports-in-your-codespace - /default-environment-variables-for-your-codespace - /connecting-to-a-private-network + - /getting-started-with-github-codespaces-for-machine-learning - /using-github-codespaces-in-visual-studio-code - /using-github-codespaces-with-github-cli --- diff --git a/translations/ja-JP/content/codespaces/getting-started/deep-dive.md b/translations/ja-JP/content/codespaces/getting-started/deep-dive.md index f1696544d85e..daee2615f323 100644 --- a/translations/ja-JP/content/codespaces/getting-started/deep-dive.md +++ b/translations/ja-JP/content/codespaces/getting-started/deep-dive.md @@ -73,7 +73,7 @@ As you develop in your codespace, it will save any changes to your files every f ### Closing or stopping your codespace -To stop your codespace you can [use the {% data variables.product.prodname_vscode_command_palette %}](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces#suspending-or-stopping-a-codespace) (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)). If you exit your codespace without running the stop command (for example, closing the browser tab), or if you leave the codespace running without interaction, the codespace and its running processes will continue until a window of inactivity occurs, after which the codespace will stop. By default, the window of inactivity is 30 minutes. +To stop your codespace you can [use the {% data variables.product.prodname_vscode_command_palette %}](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces#suspending-or-stopping-a-codespace) (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)). If you exit your codespace without running the stop command (for example, closing the browser tab), or if you leave the codespace running without interaction, the codespace and its running processes will continue until a window of inactivity occurs, after which the codespace will stop. By default, the window of inactivity is 30 minutes. When you close or stop your codespace, all uncommitted changes are preserved until you connect to the codespace again. diff --git a/translations/ja-JP/content/codespaces/getting-started/quickstart.md b/translations/ja-JP/content/codespaces/getting-started/quickstart.md index 8257434b67fc..6e7616a77d2a 100644 --- a/translations/ja-JP/content/codespaces/getting-started/quickstart.md +++ b/translations/ja-JP/content/codespaces/getting-started/quickstart.md @@ -1,6 +1,6 @@ --- -title: 'Quickstart for {% data variables.product.prodname_github_codespaces %}' -shortTitle: 'Quickstart for {% data variables.product.prodname_codespaces %}' +title: '{% data variables.product.prodname_github_codespaces %}のクイックスタート' +shortTitle: '{% data variables.product.prodname_codespaces %}のクイックスタート' intro: 'Try out {% data variables.product.prodname_github_codespaces %} in 5 minutes.' allowTitleToDifferFromFilename: true product: '{% data reusables.gated-features.codespaces %}' @@ -25,12 +25,7 @@ For more information on exactly how {% data variables.product.prodname_github_co ## codespace を作成する 1. Navigate to the [template repository](https://github.com/github/haikus-for-codespaces) and select **Use this template**. - -1. Choose an owner for the new repository, enter a repository name, select your preferred privacy setting, and click **Create repository from template**. - -1. Navigate to the main page of the newly created repository. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click **Create codespace on main**. - - ![[New codespace] ボタン](/assets/images/help/codespaces/new-codespace-button.png) +{% data reusables.codespaces.open-codespace-from-template-repo %} ## Running the application diff --git a/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md b/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md index 0ce93328685b..e08d31dbce51 100644 --- a/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md +++ b/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md @@ -155,9 +155,9 @@ You can add features to your predefined container configuration to customize whi You can add some of the most common features by selecting them when configuring your predefined container. For more information on the available features, see the [script library](https://github.com/microsoft/vscode-dev-containers/tree/main/script-library#scripts) in the `vscode-dev-containers` repository. -1. Access the Command Palette (`Shift + Command + P` / `Ctrl + Shift + P`), then start typing "configure". Select **Codespaces: Configure Devcontainer Features**. +1. Access the Command Palette (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)), then start typing "configure". Select **Codespaces: Configure Devcontainer Features**. - ![The Configure Devcontainer Features command in the command palette](/assets/images/help/codespaces/codespaces-configure-features.png) + ![The Configure Devcontainer Features command in the Command Palette](/assets/images/help/codespaces/codespaces-configure-features.png) 1. Update your feature selections, then click **OK**. @@ -165,7 +165,7 @@ You can add some of the most common features by selecting them when configuring 1. To apply the changes, in the bottom right corner of the screen, click **Rebuild now**. For more information about rebuilding your container, see "[Applying changes to your configuration](#applying-configuration-changes-to-a-codespace)." - !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/rebuild-prompt.png) + !["Codespaces: Rebuild Container" in the Command Palette](/assets/images/help/codespaces/rebuild-prompt.png) ## Creating a custom dev container configuration diff --git a/translations/ja-JP/content/codespaces/troubleshooting/github-codespaces-logs.md b/translations/ja-JP/content/codespaces/troubleshooting/github-codespaces-logs.md index 90a6b34fafe6..6b720dea6702 100644 --- a/translations/ja-JP/content/codespaces/troubleshooting/github-codespaces-logs.md +++ b/translations/ja-JP/content/codespaces/troubleshooting/github-codespaces-logs.md @@ -28,7 +28,7 @@ These logs contain detailed information about the codespace, the container, the {% webui %} 1. If you are using {% data variables.product.prodname_codespaces %} in the browser, ensure that you are connected to the codespace you want to debug. -1. Open the {% data variables.product.prodname_vscode %} Command Palette (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) and type **Export logs**. Select **Codespaces: Export Logs** from the list to download the logs. +1. Open the {% data variables.product.prodname_vscode_command_palette_shortname %} (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)) and type **Export logs**. Select **Codespaces: Export Logs** from the list to download the logs. 1. Define where to save the zip archive of logs then click **Save** (desktop) or click **OK** (web). 1. If you are using {% data variables.product.prodname_codespaces %} in the browser, right-click on the zip archive of logs from the Explorer view and select **Download…** to download them to your local machine. @@ -36,7 +36,7 @@ These logs contain detailed information about the codespace, the container, the {% vscode %} -1. Open the {% data variables.product.prodname_vscode %} Command Palette (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) and type **Export logs**. Select **Codespaces: Export Logs** from the list to download the logs. +1. Open the {% data variables.product.prodname_vscode_command_palette_shortname %} (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)) and type **Export logs**. Select **Codespaces: Export Logs** from the list to download the logs. 1. Define where to save the zip archive of logs then click **Save** (desktop) or click **OK** (web). {% endvscode %} @@ -55,7 +55,7 @@ These logs contain information about the container, dev container, and their con {% webui %} 1. Connect to the codespace you want to debug. -2. Open the {% data variables.product.prodname_vscode_command_palette %} (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) and type **Creation logs**. Select **Codespaces: View Creation Log** from the list to open the `creation.log` file. +2. Open the {% data variables.product.prodname_vscode_command_palette_shortname %} (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)) and type **Creation logs**. Select **Codespaces: View Creation Log** from the list to open the `creation.log` file. If you want to share the log with support, you can copy the text from the creation log into a text editor and save the file locally. @@ -63,7 +63,7 @@ If you want to share the log with support, you can copy the text from the creati {% vscode %} -Open the Command Palette (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) and type **Creation logs**. Select **Codespaces: View Creation Log** from the list to open the `creation.log` file. +Open the {% data variables.product.prodname_vscode_command_palette_shortname %} (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)) and type **Creation logs**. Select **Codespaces: View Creation Log** from the list to open the `creation.log` file. If you want to share the log with support, you can copy the text from the creation log into a text editor and save the file locally. diff --git a/translations/ja-JP/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md b/translations/ja-JP/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md index 4afe402686d7..27a5c18eb984 100644 --- a/translations/ja-JP/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md +++ b/translations/ja-JP/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md @@ -1,5 +1,5 @@ --- -title: Troubleshooting creation and deletion of Codespaces +title: Troubleshooting creation and deletion of codespaces intro: 'This article provides troubleshooting steps for common issues you may experience when creating or deleting a codespace, including storage and configuration issues.' product: '{% data reusables.gated-features.codespaces %}' versions: @@ -16,6 +16,8 @@ shortTitle: Creation and deletion ### No access to create a codespace {% data variables.product.prodname_codespaces %} are not available for all repositories. If the "Open with Codespaces" button is missing, {% data variables.product.prodname_github_codespaces %} may not be available for that repository. 詳しい情報については、「[codespace を作成する](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces)」を参照してください。 +You can't create a codespace for a private repository that is owned by an organization, unless you have write access to the repository or the organization has enabled forking for it. + If you believe your organization has [enabled {% data variables.product.prodname_codespaces %}](/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization#about-enabling-codespaces-for-your-organization), make sure that an organization owner or billing manager has set the spending limit for {% data variables.product.prodname_codespaces %}. 詳しい情報については「[{% data variables.product.prodname_codespaces %}の利用上限の管理](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces)」を参照してください。 ### Codespace does not open when created diff --git a/translations/ja-JP/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md b/translations/ja-JP/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md index b1b17e697b5f..1cd2b24f4d2c 100644 --- a/translations/ja-JP/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md +++ b/translations/ja-JP/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md @@ -18,7 +18,7 @@ redirect_from: Codespaces are set to stop after 30 minutes without any activity. If you try to interact with a codespace after it has stopped, you may see a `503 service unavailable` error. - If a **Start** button is shown in {% data variables.product.prodname_vscode %} or in your browser window, click **Start** to reconnect to the codespace. -- Reset your codespace by reloading the window. From the [command palette](/codespaces/codespaces-reference/using-the-command-palette-in-codespaces#accessing-the-command-palette) in {% data variables.product.prodname_vscode %}, click **Developer: Reload Window**. +- Reset your codespace by reloading the window. From the [Command Palette](/codespaces/codespaces-reference/using-the-command-palette-in-codespaces#accessing-the-command-palette) in {% data variables.product.prodname_vscode %}, click **Developer: Reload Window**. ## Browser cannot connect diff --git a/translations/ja-JP/content/developers/apps/building-github-apps/authenticating-with-github-apps.md b/translations/ja-JP/content/developers/apps/building-github-apps/authenticating-with-github-apps.md index 62275c90b66f..d08318c307ab 100644 --- a/translations/ja-JP/content/developers/apps/building-github-apps/authenticating-with-github-apps.md +++ b/translations/ja-JP/content/developers/apps/building-github-apps/authenticating-with-github-apps.md @@ -147,18 +147,24 @@ $ curl -i -X POST \ ```shell $ curl -i \ --H "Authorization: token YOUR_INSTALLATION_ACCESS_TOKEN" \ +-H "Authorization: Bearer YOUR_INSTALLATION_ACCESS_TOKEN" \ -H "Accept: application/vnd.github+json" \ {% data variables.product.api_url_pre %}/installation/repositories ``` `YOUR_INSTALLATION_ACCESS_TOKEN` の値は置き換えてください。 +{% note %} + +**ノート:** {% data reusables.getting-started.bearer-vs-token %} + +{% endnote %} + ## インストールとして API エンドポイントにアクセスする インストールアクセストークンを使用して {% data variables.product.prodname_github_apps %} の概要を取得するために利用できる REST API エンドポイントの一覧については、「[利用可能なエンドポイント](/rest/overview/endpoints-available-for-github-apps)」を参照してください。 -インストールに関連するエンドポイントの一覧については、「[インストール](/rest/reference/apps#installations)」を参照してください。 +For a list of endpoints related to installations, see "[Installations](/rest/reference/apps#installations)." ## インストールによる HTTP ベースの Git アクセス diff --git a/translations/ja-JP/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md b/translations/ja-JP/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md index 0baabc064964..ca471d973145 100644 --- a/translations/ja-JP/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md +++ b/translations/ja-JP/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md @@ -108,13 +108,13 @@ GitHub Appが`login`パラメータを指定すると、ユーザに対して利 ユーザのアクセストークンを使用すると、GitHub App がユーザの代わりに API にリクエストを発行できます。 - Authorization: token OAUTH-TOKEN + Authorization: Bearer OAUTH-TOKEN GET {% data variables.product.api_url_code %}/user たとえば、curlでは以下のようにAuthorizationヘッダを設定できます。 ```shell -curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre %}/user +curl -H "Authorization: Bearer OAUTH-TOKEN" {% data variables.product.api_url_pre %}/user ``` ## デバイスフロー @@ -133,12 +133,12 @@ curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre ユーザの OAuth トークンを取得したら、そのユーザがアクセスできるインストールされたアプリケーションを確認できます。 - Authorization: token OAUTH-TOKEN + Authorization: Bearer OAUTH-TOKEN GET /user/installations また、インストールされたアプリケーションでユーザがアクセスできるリポジトリも確認できます。 - Authorization: token OAUTH-TOKEN + Authorization: Bearer OAUTH-TOKEN GET /user/installations/:installation_id/repositories 詳細については、[ユーザアクセストークンがアクセスできるインストールされたアプリケーションの一覧表示](/rest/apps#list-app-installations-accessible-to-the-user-access-token)および[ユーザアクセストークンがアクセスできるリポジトリの一覧表示](/rest/apps#list-repositories-accessible-to-the-user-access-token)でご確認ください。 diff --git a/translations/ja-JP/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md b/translations/ja-JP/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md index 9741288825c8..135c0354d056 100644 --- a/translations/ja-JP/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md +++ b/translations/ja-JP/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md @@ -23,6 +23,8 @@ Organization に許可リストがある場合、{% data variables.product.prodn ## {% data variables.product.prodname_github_app %} に IPアドレス許可リストを追加する +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.apps.settings-step %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} diff --git a/translations/ja-JP/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md b/translations/ja-JP/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md index 1f4c4dd83c11..30d4a5847147 100644 --- a/translations/ja-JP/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md +++ b/translations/ja-JP/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md @@ -47,7 +47,7 @@ Rate limits for {% data variables.product.prodname_github_apps %} and {% data va {% ifversion fpt or ghec %} -{% data variables.product.prodname_github_apps %} that are installed on an organization or a repository within an enterprise on {% data variables.product.product_location %} are subject to a limit of 15,000 requests per hour. +{% data variables.product.prodname_github_apps %} that are installed on an organization within an enterprise on {% data variables.product.product_location %} are subject to a limit of 15,000 requests per hour per organization that has installed the app. {% endif %} diff --git a/translations/ja-JP/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md b/translations/ja-JP/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md index 134182eb65f1..16619daebe73 100644 --- a/translations/ja-JP/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md +++ b/translations/ja-JP/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md @@ -106,13 +106,13 @@ Accept: application/xml The access token allows you to make requests to the API on a behalf of a user. - Authorization: token OAUTH-TOKEN + Authorization: Bearer OAUTH-TOKEN GET {% data variables.product.api_url_code %}/user For example, in curl you can set the Authorization header like this: ```shell -curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre %}/user +curl -H "Authorization: Bearer OAUTH-TOKEN" {% data variables.product.api_url_pre %}/user ``` ## Device flow diff --git a/translations/ja-JP/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md b/translations/ja-JP/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md index 828e2ca5081b..2a7df28d1290 100644 --- a/translations/ja-JP/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md +++ b/translations/ja-JP/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md @@ -28,7 +28,7 @@ CLIツールなど、{% data variables.product.prodname_oauth_app %}がブラウ どのOAuthスコープを所有しているか、そしてAPIアクションが何を受け付けるかを知るには、ヘッダを確認してください。 ```shell -$ curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre %}/users/codertocat -I +$ curl -H "Authorization: Bearer OAUTH-TOKEN" {% data variables.product.api_url_pre %}/users/codertocat -I HTTP/2 200 X-OAuth-Scopes: repo, user X-Accepted-OAuth-Scopes: user diff --git a/translations/ja-JP/content/developers/overview/github-developer-program.md b/translations/ja-JP/content/developers/overview/github-developer-program.md index 149d6c63a79b..138cf031917a 100644 --- a/translations/ja-JP/content/developers/overview/github-developer-program.md +++ b/translations/ja-JP/content/developers/overview/github-developer-program.md @@ -23,9 +23,9 @@ Email partnerships@github.com to re ## GitHubと連携するインテグレーションがありますか? 素晴らしいです! プログラムに参加していただければ嬉しく思います。 以下のようにすれば、情報を展開できます。

-* [あなたのインテグレーションについてお知らせください。](https://support.github.com/contact?tags=rr-general-technical&form[subject]=New+GitHub+Integration) -* [OctocatもしくはGitHubロゴ](https://github.com/logos)を使って、あなたの製品がGitHubと動作することを示してください。 -* Webサイトにインテグレーションに関するビデオあるいはブログをポストしてください。 +* [Let us know about your integration](https://support.github.com/contact?tags=rr-general-technical&form[subject]=New+GitHub+Integration). +* Use the [Octocat or GitHub logo](https://github.com/logos) to identify that your product works with GitHub. +* Post a video or a blog on your website about your integration. ## GitHub開発者プログラムに参加する準備はできましたか? diff --git a/translations/ja-JP/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md b/translations/ja-JP/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md index a0fae35e8fcd..cf8e39bfa0c4 100644 --- a/translations/ja-JP/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md +++ b/translations/ja-JP/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md @@ -37,12 +37,12 @@ $ export SECRET_TOKEN=your_token ## GitHub からのペイロードを検証する -シークレットトークンが設定されると、{% data variables.product.product_name %} はそれを使用して各ペイロードでハッシュ署名を作成します。 This hash signature is included with the headers of each request as `X-Hub-Signature-256`. +シークレットトークンが設定されると、{% data variables.product.product_name %} はそれを使用して各ペイロードでハッシュ署名を作成します。 This hash signature is included with the headers of each request as `x-hub-signature-256`. {% ifversion fpt or ghes or ghec %} {% note %} -**注釈:** 下位互換性のために、SHA-1 ハッシュ関数を使用して生成される `X-Hub-Signature` ヘッダーも含まれています。 可能であれば、セキュリティを向上させるために `X-Hub-Signature-256` ヘッダを使用することをお勧めします。 以下は、`X-Hub-Signature-256` ヘッダの使用例です。 +**Note:** For backward-compatibility, we also include the `x-hub-signature` header that is generated using the SHA-1 hash function. If possible, we recommend that you use the `x-hub-signature-256` header for improved security. The example below demonstrates using the `x-hub-signature-256` header. {% endnote %} {% endif %} diff --git a/translations/ja-JP/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-to-github-classroom.md b/translations/ja-JP/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-to-github-classroom.md index 7ebf8bf01ebe..eabef812062f 100644 --- a/translations/ja-JP/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-to-github-classroom.md +++ b/translations/ja-JP/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-to-github-classroom.md @@ -25,23 +25,22 @@ LMSを{% data variables.product.prodname_classroom %}に接続するよう構成 ## サポートするLMS -{% data variables.product.prodname_classroom %}は、Learning Tools Interoperability (LTI) 規格を実装するLMSからの、名簿データのインポートをサポートしています。 +{% note %} -- LTIバージョン1.0および1.1 -- LTI Names and Roles Provisioning 1.X +**Note:** {% data variables.product.prodname_classroom %} previously supported import of roster data from LMSes that implement Learning Tools Interoperability (LTI) versions 1.0 and 1.1. On June 30, 2022, the Instructional Management System (IMS) Global Learning Consortium [ended support for LTI versions 1.0 and 1.1](https://www.imsglobal.org/lti-security-announcement-and-deprecation-schedule). In the interest of keeping sensitive student information safe and secure, {% data variables.product.company_short %} has temporarily disabled importing roster data from LTI-compliant LMSes.

-LTIは、情報の安全性と機密性を保つために役立ちます。 LTIは業界標準のプロトコルであり、GitHub ClassroomによるLTIの使用は、教育管理システム (IMS) グローバル・ラーニング・コンソーシアムにより認定されています。 詳しい情報については、IMSグローバル・ラーニング・コンソーシアムのウェブサイト上にある[Learning Tools Interoperability (学習ツールの相互運用性) ](https://www.imsglobal.org/activity/learning-tools-interoperability)および[About IMS Global Learning Consortium (IMSグローバル・ラーニング・コンソーシアムについて) ](http://www.imsglobal.org/aboutims.html)を参照してください。 +Support for the latest version of Learning Tools Interoperability, [LTI 1.3](https://www.imsglobal.org/activity/learning-tools-interoperability), is currently being worked on and will be made available in {% data variables.product.prodname_classroom %} very soon. + +{% endnote %} + +LTIは業界標準のプロトコルであり、GitHub ClassroomによるLTIの使用は、教育管理システム (IMS) グローバル・ラーニング・コンソーシアムにより認定されています。 詳しい情報については、IMSグローバル・ラーニング・コンソーシアムのウェブサイト上にある[Learning Tools Interoperability (学習ツールの相互運用性) ](https://www.imsglobal.org/activity/learning-tools-interoperability)および[About IMS Global Learning Consortium (IMSグローバル・ラーニング・コンソーシアムについて) ](http://www.imsglobal.org/aboutims.html)を参照してください。 {% data variables.product.company_short %}は、以下のLMSから{% data variables.product.prodname_classroom %}への名簿のインポートを確認しています。 -- Canvas - Google Classroom -- Moodle -- Sakai -現在のところ、{% data variables.product.prodname_classroom %}はBlackboardおよびBrightspaceからの名簿のインポートはサポートしていません。 -## クラスルームの構成認証情報を生成する +## Connecting to Google Classroom {% data reusables.classroom.sign-into-github-classroom %} {% data reusables.classroom.click-classroom-in-list %} @@ -49,88 +48,15 @@ LTIは、情報の安全性と機密性を保つために役立ちます。 LTI 1. クラスルームに既に名簿がある場合は、その名簿を更新するか、その名簿を削除して新しい名簿を作成できます。 - 名簿の削除や作成に関する詳細については、「[クラスルームの名簿を削除する](/education/manage-coursework-with-github-classroom/manage-classrooms#deleting-a-roster-for-a-classroom)」および「[クラスルームの名簿を作成する](/education/manage-coursework-with-github-classroom/manage-classrooms#creating-a-roster-for-your-classroom)」を参照してください。 - 名簿の更新に関する詳細については、「[クラスルームの名簿に学生を追加する](/education/manage-coursework-with-github-classroom/manage-classrooms#adding-students-to-the-roster-for-your-classroom)」を参照してください。 -1. LMSのリストの中から、お使いのLMSをクリックします。 お使いのLMSがサポートされていない場合、[**Other LMS**] をクリックします。 ![LMSのリスト](/assets/images/help/classroom/classroom-settings-click-lms.png) -1. LMSの接続について読み、[**Connect to _LMS_**] をクリックします。 -1. クラスルームへの接続に用いる、[Consumer Key]、[Shared Secret]、および [Launch URL] をコピーします。 ![認証情報のコピー](/assets/images/help/classroom/classroom-copy-credentials.png) - -## 一般的なLMSを設定する - -外部ツールが名簿情報を受信できるよう、LMSのプライバシー設定を行う必要があります。 - -1. お使いのLMSに移動します。 -1. 外部ツールを設定します。 -1. {% data variables.product.prodname_classroom %}で生成された構成認証情報を入力します。 - - Consumer key - - 共有シークレット - - Launch URL (「ツールURL」などと呼ばれることもあります) - -## Canvasを設定する - -{% data variables.product.prodname_classroom %}をCanvasの外部アプリケーションとして設定し、クラスルームに名簿データをインポートできます。 Canvasに関する詳細は、[Canvasのウェブサイト](https://www.instructure.com/canvas/)を参照してください。 - -1. [Canvas](https://www.instructure.com/canvas/#login)にサインインします。 -1. {% data variables.product.prodname_classroom %}と連携するCanvasのコースを選択します。 -1. 左のサイドバーで、**Settings(設定)**をクリックしてください。 -1. [**Apps**] タブをクリックします。 -1. [**View app configurations**] をクリックします。 -1. [**+App**] をクリックします。 -1. [**Configuration Type**] ドロップダウンメニューで、[**By URL**] をクリックします。 -1. {% data variables.product.prodname_classroom %}からコピーした構成認証情報を貼り付けます。 詳しい情報については、「[クラスルームの構成認証情報を生成する](#generating-configuration-credentials-for-your-classroom)」を参照してください。 - - | Canvasアプリケーション構成のフィールド | 値または設定 | - |:------------------------------------------------------------------------- |:--------------------------------------------------------------- | - | **Consumer Key** | {% data variables.product.prodname_classroom %}からのConsumer key | - | **Shared Secret** | {% data variables.product.prodname_classroom %}からのShared secret | - | **Allow this tool to access the IMS Names and Role Provisioning Service** | 有効 | - | **Configuration URL** | {% data variables.product.prodname_classroom %}からのLaunch URL | - - {% note %} - - **注釈**: [Allow this tool to access the IMS Names and Role Provisioning Service] というラベルのチェックボックスがCanvasで表示されていない場合、Canvasの管理者がCanvasサポートに連絡し、お使いのCanvasアカウントでメンバーシップサービス設定を有効化する必要があります。 この機能を有効化しないと、Canvasから名簿を同期できません。 詳しい情報については、Canvasウェブサイトの[How do I contact Canvas Support? (Canvasサポートに連絡する方法)](https://community.canvaslms.com/t5/Canvas-Basics-Guide/How-do-I-contact-Canvas-Support/ta-p/389767) を参照してください。 - - {% endnote %} - -1. **Submit(サブミット)**をクリックしてください。 -1. 左のサイドバーで [**Home**] をクリックします。 -1. 左のサイドバーで [**GitHub Classroom**] をクリックし、Canvasが確認メールを送信するようにします。 メールの指示に従い、{% data variables.product.prodname_classroom %}との連携を完了します。 - -## Moodleを設定する - -{% data variables.product.prodname_classroom %}をMoodleのアクティビティとして設定し、クラスルームに名簿データをインポートできます。 Moodleに関する詳細は、[Moodleのウェブサイト](https://moodle.org)を参照してください。 - -Moodleのバージョンは3.0以上である必要があります。 - -1. [Moodle](https://moodle.org/login/)にサインインします。 -1. {% data variables.product.prodname_classroom %}と連携するMoodleのコースを選択します。 -1. [**Turn editing on**] をクリックします。 -1. Moodleで{% data variables.product.prodname_classroom %}を使用するところで、[**Add an activity or resource**] をクリックします。 -1. [**External tool**] を選択し、[**Add**] をクリックします。 -1. [Activity name] フィールドに、「GitHub Classroom」と入力します。 -1. [**Preconfigured tool**] フィールドで、ドロップダウンメニューの右にある [**+**] をクリックします。 -1. [External tool configuration] の下に、{% data variables.product.prodname_classroom %} からコピーしたした構成認証情報を貼り付けます。 詳しい情報については、「[クラスルームの構成認証情報を生成する](#generating-configuration-credentials-for-your-classroom)」を参照してください。 - - | Moodleアプリケーション設定のフィールド | 値または設定 | - |:---------------------------- |:--------------------------------------------------------------------------------------------------------------------------------- | - | **Tool name** | {% data variables.product.prodname_classroom %} - _あなたのクラスルーム名_

**注釈**: 任意の名前を設定できますが、わかりやすいよう、この値をお勧めします。 | - | **Tool URL** | {% data variables.product.prodname_classroom %}からのLaunch URL | - | **LTI version** | LTI 1.0/1.1 | - | **Default launch container** | 新規ウィンドウ | - | **Consumer key** | {% data variables.product.prodname_classroom %}からのConsumer key | - | **共有シークレット** | {% data variables.product.prodname_classroom %}からのShared secret | - -1. [**Services**] までスクロールしてクリックします。 -1. [IMS LTI Names and Role Provisioning] の右にあるドロップダウンメニューを選択し、[**Use this service to retrieve members' information as per privacy settings**] をクリックします。 -1. [**Privacy**] までスクロールしてクリックします。 -1. [**Share launcher's name with tool**] と [**Share launcher's email with tool**] の右にあるドロップダウンメニューをそれぞれ選択し、[**Always**] をクリックします。 -1. ページの下部で**Save changes(変更の保存)**をクリックしてください。 -1. [**Preconfigure tool**] メニューで、[**GitHub Classroom - _あなたのクラスルーム名_**] をクリックします。 -1. [Common module settings] で、[Availability] の右にあるドロップダウンメニューを選択し、[**Hide from students**] をクリックします。 -1. ページの下部で、[**Save and return to course**] をクリックします -1. {% data variables.product.prodname_classroom %} を表示したい場所に移動し、{% data variables.product.prodname_classroom %}アクティビティをクリックします。 - -## LMSから名簿をインポートする - -LMSから{% data variables.product.prodname_classroom %}への名簿のインポートに関する詳細については、「[クラスルームの管理](/education/manage-coursework-with-github-classroom/manage-classrooms#creating-a-roster-for-your-classroom)」を参照してください。 +1. In the list of LMSes, click Google Classroom. ![Google Classroom](/assets/images/help/classroom/classroom-settings-click-google-classroom.png) +1. Sign in to Google, then select the Classroom to link to. + + +## Connecting to Canvas, Moodle, Sakai, and other LMSes + +Connecting to other LMSes is temporarily unavailable as {% data variables.product.company_short %} updates to Learning Tools Interoperability (LTI) version 1.3. For more information, see "[Supported LMSes](#supported-lmses)." + +In the meantime, you may manually input your roster for your class. For more information about manually importing the roster from your LMS into {% data variables.product.prodname_classroom %}, see "[Manage classrooms](/education/manage-coursework-with-github-classroom/manage-classrooms#creating-a-roster-for-your-classroom)." ## LMSを切断する diff --git a/translations/ja-JP/content/get-started/exploring-projects-on-github/following-organizations.md b/translations/ja-JP/content/get-started/exploring-projects-on-github/following-organizations.md index 8599a8336936..a6385b86bdb7 100644 --- a/translations/ja-JP/content/get-started/exploring-projects-on-github/following-organizations.md +++ b/translations/ja-JP/content/get-started/exploring-projects-on-github/following-organizations.md @@ -7,15 +7,11 @@ topics: - Profile --- -{% note %} - -**Note:** The ability to follow organizations is currently in public beta and subject to change. - -{% endnote %} +{% data reusables.organizations.follow-organizations-beta %} ## About followers on {% data variables.product.product_name %} -When you follow organizations, you'll see their public activity on your personal dashboard. 詳細は「[パーソナルダッシュボードについて](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard#staying-updated-with-activity-from-the-community)」を参照してください。 +{% data reusables.organizations.about-following-organizations %} For more information, see "[About your personal dashboard](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard#staying-updated-with-activity-from-the-community)." You can unfollow an organization if you do not wish to see their {% ifversion fpt or ghec %}public{% endif %} activity on {% data variables.product.product_name %}. diff --git a/translations/ja-JP/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md b/translations/ja-JP/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md index ecbabbb9d74c..eddab6d9bf85 100644 --- a/translations/ja-JP/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md +++ b/translations/ja-JP/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md @@ -57,11 +57,21 @@ If you have existing source code or repositories stored locally on your computer 1. {% data variables.product.product_location %}上で[新しいリポジトリを作成](/repositories/creating-and-managing-repositories/creating-a-new-repository)します。 エラーを避けるため、新しいリポジトリは*README*、ライセンス、あるいは `gitignore` で初期化しないでください。 これらのファイルは、プロジェクトを {% data variables.product.product_name %}にプッシュした後で追加できます。 ![[Create New Repository] ドロップダウン](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. ワーキングディレクトリをローカルプロジェクトに変更します。 -4. ローカルディレクトリを Git リポジトリとして初期化します。 - ```shell - $ git init -b main - ``` +4. Use the `init` command to initialize the local directory as a Git repository. By default, the initial branch is called `master`. + + If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using `-b`. + + ``` shell + $ git init -b main + ``` + + If you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using `&& git branch -m`. + + ``` shell + $ git init && git branch -m main + ``` 5. ファイルを新しいローカルリポジトリに追加します。 これで、それらのファイルが最初のコミットに備えてステージングされます。 + ```shell $ git add . # ローカルリポジトリにファイルを追加し、コミットに備えてステージします。 {% data reusables.git.unstage-codeblock %} @@ -92,10 +102,19 @@ If you have existing source code or repositories stored locally on your computer 1. {% data variables.product.product_location %}上で[新しいリポジトリを作成](/articles/creating-a-new-repository)します。 エラーを避けるため、新しいリポジトリは*README*、ライセンス、あるいは `gitignore` で初期化しないでください。 これらのファイルは、プロジェクトを {% data variables.product.product_name %}にプッシュした後で追加できます。 ![[Create New Repository] ドロップダウン](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. ワーキングディレクトリをローカルプロジェクトに変更します。 -4. ローカルディレクトリを Git リポジトリとして初期化します。 - ```shell - $ git init -b main - ``` +4. Use the `init` command to initialize the local directory as a Git repository. By default, the initial branch is called `master`. + + If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using `-b`. + + ``` shell + $ git init -b main + ``` + + If you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using `&& git branch -m`. + + ``` shell + $ git init && git branch -m main + ``` 5. ファイルを新しいローカルリポジトリに追加します。 これで、それらのファイルが最初のコミットに備えてステージングされます。 ```shell $ git add . @@ -127,10 +146,19 @@ If you have existing source code or repositories stored locally on your computer 1. {% data variables.product.product_location %}上で[新しいリポジトリを作成](/articles/creating-a-new-repository)します。 エラーを避けるため、新しいリポジトリは*README*、ライセンス、あるいは `gitignore` で初期化しないでください。 これらのファイルは、プロジェクトを {% data variables.product.product_name %}にプッシュした後で追加できます。 ![[Create New Repository] ドロップダウン](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. ワーキングディレクトリをローカルプロジェクトに変更します。 -4. ローカルディレクトリを Git リポジトリとして初期化します。 - ```shell - $ git init -b main - ``` +4. Use the `init` command to initialize the local directory as a Git repository. By default, the initial branch is called `master`. + + If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using `-b`. + + ``` shell + $ git init -b main + ``` + + If you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using `&& git branch -m`. + + ``` shell + $ git init && git branch -m main + ``` 5. ファイルを新しいローカルリポジトリに追加します。 これで、それらのファイルが最初のコミットに備えてステージングされます。 ```shell $ git add . diff --git a/translations/ja-JP/content/get-started/quickstart/be-social.md b/translations/ja-JP/content/get-started/quickstart/be-social.md index f2ae29f7f066..3bd6a70bc690 100644 --- a/translations/ja-JP/content/get-started/quickstart/be-social.md +++ b/translations/ja-JP/content/get-started/quickstart/be-social.md @@ -58,7 +58,23 @@ From your dashboard, click the drop down menu of your username on the left side ![アカウントのコンテキストの切り替えのドロップダウン](/assets/images/help/overview/dashboard-contextswitcher.png) -### {% data variables.product.prodname_dotcom %} 上の他のプロジェクトを調べる +{% ifversion for-you-feed %} + +## Following organizations + +{% data reusables.organizations.follow-organizations-beta %} + +{% data reusables.organizations.about-following-organizations %} + +To follow an organization, in the header of the organization's page, click **Follow**. + +![Screenshot of the organization header, with the follow button highlighted](/assets/images/help/profile/organization-profile-following.png) + +For more information, see "[Following organizations](/get-started/exploring-projects-on-github/following-organizations)." + +{% endif %} + +## {% data variables.product.prodname_dotcom %} 上の他のプロジェクトを調べる You can discover new and interesting projects on {% data variables.product.prodname_dotcom %}'s Explore page. You can star interesting projects to make them easy to find again later. Visit your stars page to see all your starred projects. For more information about stars, see "[Saving repositories with stars](/get-started/exploring-projects-on-github/saving-repositories-with-stars)." diff --git a/translations/ja-JP/content/get-started/quickstart/fork-a-repo.md b/translations/ja-JP/content/get-started/quickstart/fork-a-repo.md index 761eedd63dd2..85aeaac6b53a 100644 --- a/translations/ja-JP/content/get-started/quickstart/fork-a-repo.md +++ b/translations/ja-JP/content/get-started/quickstart/fork-a-repo.md @@ -113,7 +113,7 @@ Right now, you have a fork of the Spoon-Knife repository, but you do not have th > Cloning into `Spoon-Knife`... > remote: Counting objects: 10, done. > remote: Compressing objects: 100% (8/8), done. - > remove: Total 10 (delta 1), reused 10 (delta 1) + > remote: Total 10 (delta 1), reused 10 (delta 1) > Unpacking objects: 100% (10/10), done. ``` diff --git a/translations/ja-JP/content/graphql/guides/migrating-graphql-global-node-ids.md b/translations/ja-JP/content/graphql/guides/migrating-graphql-global-node-ids.md index 3f4d167846e7..544b7f5e9d69 100644 --- a/translations/ja-JP/content/graphql/guides/migrating-graphql-global-node-ids.md +++ b/translations/ja-JP/content/graphql/guides/migrating-graphql-global-node-ids.md @@ -32,7 +32,7 @@ GraphQLグローバルノードIDへの参照を保存している場合にの ``` $ curl \ - -H "Authorization: token $GITHUB_TOKEN" \ + -H "Authorization: Bearer $GITHUB_TOKEN" \ -H "X-Github-Next-Global-ID: 1" \ https://api.github.com/graphql \ -d '{ "query": "{ node(id: \"MDQ6VXNlcjM0MDczMDM=\") { id } }" }' diff --git a/translations/ja-JP/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md b/translations/ja-JP/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md index 5b0a136253f7..bfeb800caa1c 100644 --- a/translations/ja-JP/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md +++ b/translations/ja-JP/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md @@ -70,7 +70,7 @@ Organization名とプロジェクト番号が分かっていれば、Organizatio ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"query{organization(login: \"ORGANIZATION\") {projectV2(number: NUMBER){id}}}"}' ``` {% endcurl %} @@ -94,7 +94,7 @@ Organization中のすべてのプロジェクトのノードIDを見つけるこ ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"{organization(login: \"ORGANIZATION\") {projectsV2(first: 20) {nodes {id title}}}}"}' ``` {% endcurl %} @@ -125,7 +125,7 @@ APIを通じてプロジェクトを更新するには、プロジェクトの ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"query{user(login: \"USER\") {projectV2(number: NUMBER){id}}}"}' ``` {% endcurl %} @@ -149,7 +149,7 @@ gh api graphql -f query=' ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"{user(login: \"USER\") {projectsV2(first: 20) {nodes {id title}}}}"}' ``` {% endcurl %} @@ -180,7 +180,7 @@ gh api graphql -f query=' ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2Field { id name } ... on ProjectV2IterationField { id name configuration { iterations { startDate id }}} ... on ProjectV2SingleSelectField { id name options { id name }}}}}}}"}' ``` {% endcurl %} @@ -284,7 +284,7 @@ gh api graphql -f query=' ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2FieldCommon { id name }}}}}}"}' ``` {% endcurl %} @@ -354,7 +354,7 @@ APIでクエリを行い、プロジェクト中のアイテムに関する情 ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { items(first: 20) { nodes{ id fieldValues(first: 8) { nodes{ ... on ProjectV2ItemFieldTextValue { text field { ... on ProjectV2FieldCommon { name }}} ... on ProjectV2ItemFieldDateValue { date field { ... on ProjectV2FieldCommon { name } } } ... on ProjectV2ItemFieldSingleSelectValue { name field { ... on ProjectV2FieldCommon { name }}}}} content{ ... on DraftIssue { title body } ...on Issue { title assignees(first: 10) { nodes{ login }}} ...on PullRequest { title assignees(first: 10) { nodes{ login }}}}}}}}}"}' ``` {% endcurl %} @@ -446,7 +446,7 @@ gh api graphql -f query=' ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"mutation {addProjectV2ItemById(input: {projectId: \"PROJECT_ID\" contentId: \"CONTENT_ID\"}) {item {id}}}"}' ``` {% endcurl %} @@ -488,8 +488,8 @@ gh api graphql -f query=' ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ - --data '{"query":"mutation {addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) {item {id}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) {projectItem {id}}}"}' ``` {% endcurl %} @@ -498,7 +498,7 @@ curl --request POST \ gh api graphql -f query=' mutation { addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) { - item { + projectItem { id } } @@ -512,7 +512,7 @@ gh api graphql -f query=' { "data": { "addProjectV2ItemById": { - "item": { + "projectItem": { "id": "PVTI_lADOANN5s84ACbL0zgBbxFc" } } @@ -528,7 +528,7 @@ gh api graphql -f query=' ```shell curl --request POST \ --url https://api.github.com/graphql \ ---header 'Authorization: token TOKEN' \ +--header 'Authorization: Bearer TOKEN' \ --data '{"query":"mutation { updateProjectV2(input: { projectId: \"PROJECT_ID\", title: \"Project title\", public: false, readme: \"# Project README\n\nA long description\", shortDescription: \"A short description\"}) { projectV2 { id, title, readme, shortDescription }}}"}' ``` {% endcurl %} @@ -565,7 +565,7 @@ gh api graphql -f query=' ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { text: "Updated text" }}) { projectV2Item { id }}}"}' ``` {% endcurl %} @@ -619,7 +619,7 @@ gh api graphql -f query=' ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { singleSelectOptionId: "OPTION_ID" }}) { projectV2Item { id }}}"}' ``` {% endcurl %} @@ -659,7 +659,7 @@ gh api graphql -f query=' ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { singleSelectOptionId: "OPTION_ID" }}) { projectV2Item { id }}}"}' ``` {% endcurl %} @@ -694,7 +694,7 @@ gh api graphql -f query=' ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"mutation {deleteProjectV2Item(input: {projectId: \"PROJECT_ID\" itemId: \"ITEM_ID\"}) {deletedItemId}}"}' ``` {% endcurl %} diff --git a/translations/ja-JP/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md b/translations/ja-JP/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md index 7e46a5395cf2..cfd6821b286c 100644 --- a/translations/ja-JP/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md +++ b/translations/ja-JP/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md @@ -23,7 +23,7 @@ To transfer an open issue to another repository, you must have write access to t {% endnote %} -When you transfer an issue, comments, labels and assignees are retained. The issue's milestones are not retained. This issue will stay on any user-owned or organization-wide project boards and be removed from any repository project boards. For more information, see "[About project boards](/articles/about-project-boards)." +When you transfer an issue, comments and assignees are retained. Labels and milestones are also retained if they're present in the target repository, with labels matching by name and milestones matching by both name and due date. This issue will stay on any user-owned or organization-wide project boards and be removed from any repository project boards. For more information, see "[About project boards](/articles/about-project-boards)." People or teams who are mentioned in the issue will receive a notification letting them know that the issue has been transferred to a new repository. The original URL redirects to the new issue's URL. People who don't have read permissions in the new repository will see a banner letting them know that the issue has been transferred to a new repository that they can't access. diff --git a/translations/ja-JP/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md b/translations/ja-JP/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md index e0adf8b4d559..66d1d9f1e099 100644 --- a/translations/ja-JP/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md +++ b/translations/ja-JP/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md @@ -38,6 +38,8 @@ Enterprise アカウントで Organization に対して許可される IP アド {% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %} +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} diff --git a/translations/ja-JP/content/packages/index.md b/translations/ja-JP/content/packages/index.md index df29da2cf118..968eddf1d9bb 100644 --- a/translations/ja-JP/content/packages/index.md +++ b/translations/ja-JP/content/packages/index.md @@ -18,6 +18,7 @@ featuredLinks: guideCards: - '{% ifversion docker-ghcr-enterprise-migration %}/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry{% endif %}' - '{% ifversion fpt or ghec or ghes > 3.4 %}/packages/working-with-a-github-packages-registry/working-with-the-container-registry{% else %}/packages/working-with-a-github-packages-registry/working-with-the-docker-registry{% endif %}' + - '{% ifversion packages-npm-v2 %}/packages/working-with-a-github-packages-registry/working-with-the-npm-registry{% endif %}' - /packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry changelog: label: packages diff --git a/translations/ja-JP/content/packages/learn-github-packages/about-permissions-for-github-packages.md b/translations/ja-JP/content/packages/learn-github-packages/about-permissions-for-github-packages.md index 6bedc6b0bb8c..15b8a24c93c6 100644 --- a/translations/ja-JP/content/packages/learn-github-packages/about-permissions-for-github-packages.md +++ b/translations/ja-JP/content/packages/learn-github-packages/about-permissions-for-github-packages.md @@ -18,20 +18,22 @@ shortTitle: 権限について リポジトリスコープのパッケージは、パッケージを所有するリポジトリの権限と可視性を継承します。 リポジトリをスコープとするパッケージは、リポジトリのメインページにアクセスし、ページ右にある**パッケージ**リンクをクリックすれば見つかります。 {% ifversion fpt or ghec %}詳しい情報については「[リポジトリのパッケージへの接続](/packages/learn-github-packages/connecting-a-repository-to-a-package)」を参照してください。{% endif %} -以下の{% data variables.product.prodname_registry %}レジストリは、リポジトリスコープの権限を使います。 +以下の{% data variables.product.prodname_registry %}レジストリは、リポジトリスコープの権限**のみ**を使います。 {% ifversion not fpt or ghec %}-Dockerレジストリ(`docker.pkg.github.com`){% endif %} - - npmレジストリ + {% ifversion packages-npm-v2 %}{% else %}- npm registry{% endif %} - RubyGemsレジストリ - Apache Mavenレジストリ - NuGetレジストリ +{% ifversion packages-npm-v2 %}{% data variables.product.prodname_ghcr_and_npm_registry %}については、パッケージがユーザ、Organizationをスコープとするか、あるいはリポジトリにリンクするかを選択できます。{% endif %} + {% ifversion fpt or ghec %} ## ユーザ/Organizationスコープのパッケージの詳細な権限 詳細な権限を持つパッケージは、個人ユーザもしくはOrganizationアカウントをスコープとします。 パッケージのアクセス制御と可視性は、パッケージに接続された(あるいはリンクされた)リポジトリは別個に変更できます。 -現在の処、{% data variables.product.prodname_container_registry %}だけがコンテナイメージパッケージに関する詳細な権限を提供しています。 +現在のところ、{% data variables.product.prodname_ghcr_and_npm_registry %}だけがコンテナイメージパッケージに関する詳細な権限を提供しています。 ## コンテナイメージの可視性とアクセス権限 diff --git a/translations/ja-JP/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md b/translations/ja-JP/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md index 7577c081f545..0624ca0bcb0c 100644 --- a/translations/ja-JP/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md +++ b/translations/ja-JP/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md @@ -16,7 +16,7 @@ shortTitle: アクセスコントロールと可視性 詳細な権限を持つパッケージは、個人ユーザもしくはOrganizationアカウントをスコープとします。 パッケージのアクセス制御と可視性は、パッケージに接続された(あるいはリンクされた)リポジトリは別個に変更できます。 -現在は、{% data variables.product.prodname_container_registry %}でのみ詳細な権限を使うことができます。 詳細な権限は、npmレジストリのような他のパッケージレジストリではサポートされていません。{% ifversion docker-ghcr-enterprise-migration %}{% data variables.product.prodname_container_registry %}への移行に関する詳しい情報については「[Dockerレジストリから{% data variables.product.prodname_container_registry %}への移行](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)」を参照してください。{% endif %} +現在は、{% data variables.product.prodname_ghcr_and_npm_registry %}でのみ詳細な権限を使うことができます。 詳細な権限は、RubyGemsレジストリのような他のパッケージレジストリではサポートされていません。{% ifversion docker-ghcr-enterprise-migration %}{% data variables.product.prodname_container_registry %}への移行に関する詳しい情報については「[Dockerレジストリから{% data variables.product.prodname_container_registry %}への移行](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)」を参照してください。{% endif %} リポジトリをスコープとするパッケージの権限や、PATに関するパッケージ関連のスコープ、Actionsのワークフローの権限の管理についての詳しい情報は、「[GitHub Packagesの権限について](/packages/learn-github-packages/about-permissions-for-github-packages)」を参照してください。 @@ -95,7 +95,7 @@ Organization が所有するコンテナイメージに対する管理者権限 {% ifversion fpt or ghec %} ## パッケージへの{% data variables.product.prodname_codespaces %}アクセスの確保 -デフォルトでは、codespaceは**Inherit access(アクセスの継承)**オプションが選択された同じリポジトリ内で公開されたパッケージなど、{% data variables.product.prodname_dotcom %} Container Registry内の特定パッケージにシームレスにアクセスできます。 自動的に設定されるアクセスに関する詳しい情報については「[{% data variables.product.prodname_dotcom %} Container Registryに保存されたイメージへのアクセス](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry#accessing-images-stored-in-github-container-registry)」を参照してください。 +デフォルトでは、codespaceは**Inherit access(アクセスの継承)**オプションが選択された同じリポジトリ内で公開されたパッケージなど、{% data variables.product.prodname_ghcr_and_npm_registry %} 内の特定パッケージにシームレスにアクセスできます。 自動的に設定されるアクセスに関する詳しい情報については「[codespaceへのプライベートイメージレジストリへのアクセスの許可](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry#accessing-images-stored-in-container-registry-and-npm-registry) 」を参照してください。 あるいは、codespaceがパッケージに確実にアクセスできるようにするには、codespaceが起動されたリポジトリへのアクセスを許可しなければなりません。 diff --git a/translations/ja-JP/content/packages/learn-github-packages/deleting-and-restoring-a-package.md b/translations/ja-JP/content/packages/learn-github-packages/deleting-and-restoring-a-package.md index 2290c045b118..75b849f90e65 100644 --- a/translations/ja-JP/content/packages/learn-github-packages/deleting-and-restoring-a-package.md +++ b/translations/ja-JP/content/packages/learn-github-packages/deleting-and-restoring-a-package.md @@ -23,12 +23,12 @@ shortTitle: パッケージの削除と復元 - プライベートパッケージ全体 - パッケージの全バージョンでダウンロード数が5000以下の場合、パブリックパッケージ全体 - プライベートパッケージの特定のバージョン -- パッケージバージョンのダウンロード数が5000以下の場合、パブリックパッケージの特定のバージョン +- パッケージバージョンのダウンロード数が5,000以下の場合、パブリックパッケージの特定のバージョン {% note %} **注釈:** -- パッケージのいずれかのパージョンでダウンロード数が5000を超えている場合は、パブリックパッケージを削除できません。 この場合は、[GitHubサポート](https://support.github.com/contact?tags=docs-packages)までお問い合わせください。 +- パッケージのいずれかのパージョンでダウンロード数が5,000を超えている場合は、パブリックパッケージを削除できません。 この場合は、[GitHubサポート](https://support.github.com/contact?tags=docs-packages)までお問い合わせください。 - パブリックパッケージを削除する場合、そのパッケージに依存するプロジェクトを破壊する可能性があることに注意してください。 {% endnote %} @@ -46,7 +46,7 @@ REST APIを使用してパッケージを管理できます。 詳しい情報 {% endif %} -権限とアクセスをリポジトリから継承するパッケージでは、GraphQLを使って特定のパッケージバージョンを削除できます。{% ifversion fpt or ghec %}{% data variables.product.prodname_registry %}GraphQL APIは、パッケージの名前空間`https://ghcr.io/OWNER/PACKAGE-NAME`を使うコンテナあるいはDockerイメージをサポートしません。{% endif %}GraphQLサポートに関する詳しい情報については「[GraphQLでリポジトリをスコープとするパッケージのバージョンを削除する](#deleting-a-version-of-a-repository-scoped-package-with-graphql)」を参照してください。 +権限とアクセスをリポジトリから継承するパッケージでは、GraphQLを使って特定のパッケージバージョンを削除できます。{% data reusables.package_registry.no-graphql-to-delete-packages %}GraphQLサポートに関する詳しい情報については「[GraphQLでリポジトリをスコープとするパッケージのバージョンを削除する](#deleting-a-version-of-a-repository-scoped-package-with-graphql)」を参照してください。 {% endif %} @@ -54,17 +54,19 @@ REST APIを使用してパッケージを管理できます。 詳しい情報 リポジトリからアクセス権限を継承しているパッケージの場合、そのリポジトリに対する管理者権限がある場合はパッケージを削除できます。 -{% data variables.product.prodname_registry %}上でリポジトリのスコープが付いたパッケージには、以下が挙げられます。 -- npm -- RubyGems -- maven -- Gradle -- NuGet -{% ifversion not fpt or ghec %}-`docker.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`にあるDockerイメージ{% endif %} +以下の{% data variables.product.prodname_registry %}レジストリは、リポジトリスコープの権限**のみ**を使います。 + + {% ifversion not fpt or ghec %}-`docker.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`にあるDockerイメージ{% endif %} + {% ifversion packages-npm-v2 %}{% else %}- npm{% endif %} + - RubyGemsレジストリ + - Apache Mavenレジストリ + - NuGetレジストリ + +{% ifversion packages-npm-v2 %}{% data variables.product.prodname_ghcr_and_npm_registry %}については、パッケージがユーザ、Organizationをスコープとするか、あるいはリポジトリにリンクするかを選択できます。{% endif %} {% ifversion fpt or ghec %} -`https://ghcr.io/OWNER/PACKAGE-NAME`に保存されたコンテナイメージなど、リポジトリとは別に詳細な権限を持つパッケージを削除する場合は、そのパッケージに対するアクセス権限が必要です。 詳しい情報については「[{% data variables.product.prodname_registry %}の権限について](/packages/learn-github-packages/about-permissions-for-github-packages)」を参照してください。 +`https://ghcr.io/OWNER/PACKAGE-NAME`あるいは`https://npm.pkg.github.com/OWNER/PACKAGE-NAME`に保存されたコンテナイメージなど、リポジトリとは別に詳細な権限を持つパッケージを削除する場合は、そのパッケージに対するアクセス権限が必要です。 詳しい情報については「[{% data variables.product.prodname_registry %}の権限について](/packages/learn-github-packages/about-permissions-for-github-packages)」を参照してください。 {% endif %} @@ -86,9 +88,7 @@ REST APIを使用してパッケージを管理できます。 詳しい情報 リポジトリから権限とアクセスを継承しているパッケージの場合、GraphQLを使用して特定のパッケージバージョンを削除できます。 -{% ifversion fpt or ghec %} -`ghcr.io`にあるコンテナあるいはDockerイメージについては、GraphQLはサポートされていませんがREST APIが使えます。 詳しい情報については、「[{% data variables.product.prodname_registry %} API](/rest/reference/packages)」を参照してください。 -{% endif %} +{% data reusables.package_registry.no-graphql-to-delete-packages %}{% ifversion fpt or ghec %}ただし、REST APIを使うことはできます。 詳しい情報については「[{% data variables.product.prodname_registry %} API](/rest/reference/packages)」を参照してください。{% endif %} GraphQL APIの`deletePackageVersion`ミューテーションを使ってください。 `read:packages`、`delete:packages`、`repo`スコープを持つトークンを使わなければなりません。 トークンに関する詳しい情報については「[{% data variables.product.prodname_registry %}について](/packages/publishing-and-managing-packages/about-github-packages#authenticating-to-github-packages)」を参照してください。 diff --git a/translations/ja-JP/content/packages/learn-github-packages/introduction-to-github-packages.md b/translations/ja-JP/content/packages/learn-github-packages/introduction-to-github-packages.md index fc5090006ea3..5450ffcff9f3 100644 --- a/translations/ja-JP/content/packages/learn-github-packages/introduction-to-github-packages.md +++ b/translations/ja-JP/content/packages/learn-github-packages/introduction-to-github-packages.md @@ -51,7 +51,7 @@ For more information about the configuration of {% data variables.product.prodna | | | |--------------------|--------------------| -| Permissions | {% ifversion fpt or ghec %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_container_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted.

For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} | +| Permissions | {% ifversion fpt or ghec %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_ghcr_and_npm_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted.

For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} | | Visibility | {% data reusables.package_registry.public-or-private-packages %} | For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)." @@ -101,7 +101,9 @@ For more information about Docker and the {% data variables.product.prodname_con ## Managing packages {% ifversion fpt or ghec %} -You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. For more information, see the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." +You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." + +{% data reusables.package_registry.no-graphql-to-delete-packages %} {% endif %} {% ifversion ghes %} @@ -112,7 +114,9 @@ You can delete a private or public package in the {% data variables.product.prod You can delete a version of a package in the {% data variables.product.product_name %} user interface or using the GraphQL API. {% endif %} -When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and "[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." +When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. + +For more information, see {% ifversion ghes or ghae %}"[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and {% endif %}"[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." You can configure webhooks to subscribe to package-related events, such as when a package is published or updated. For more information, see the "[`package` webhook event](/webhooks/event-payloads/#package)." diff --git a/translations/ja-JP/content/packages/learn-github-packages/viewing-packages.md b/translations/ja-JP/content/packages/learn-github-packages/viewing-packages.md index cfb53cbd2b5f..4e9f2d9ac4c9 100644 --- a/translations/ja-JP/content/packages/learn-github-packages/viewing-packages.md +++ b/translations/ja-JP/content/packages/learn-github-packages/viewing-packages.md @@ -23,15 +23,15 @@ versions: パッケージを見ることができるかどうかは、いくつかの要素に依存します。 デフォルトでは、公開したパッケージはすべて見ることができます。 -リポジトリをスコープとするパッケージは、そのパッケージを所有するリポジトリから権限と可視性を継承します。 以下のレジストリは、この種の権限を使用します。{% ifversion not fpt or ghec %} +リポジトリをスコープとするパッケージは、そのパッケージを所有するリポジトリから権限と可視性を継承します。 以下のレジストリは、この種類の権限**のみ**を利用します:{% ifversion not fpt or ghec %} - Dockerレジストリ (`docker.pkg.github.com`){% endif %} -- npmレジストリ +{% ifversion packages-npm-v2 %}{% else %}- npm registry{% endif %} - RubyGemsレジストリ - Apache Mavenレジストリ - NuGetレジストリ {% ifversion fpt or ghec %} -コンテナレジストリは、個人ユーザもしくはOrganizationアカウントが所有する各パッケージごとにカスタマイズできる、詳細な権限及び可視性の設定のオプションを提供します。 詳細な権限を利用することも、パッケージをレジストリに接続してその権限を継承することもできます。 詳しい情報については「[リポジトリのパッケージへの接続](/packages/learn-github-packages/connecting-a-repository-to-a-package)」を参照してください。 +{% data variables.product.prodname_ghcr_and_npm_registry %}は、個人ユーザもしくはOrganizationアカウントが所有する各パッケージごとにカスタマイズできる、詳細な権限及び可視性の設定のオプションを提供します。 詳細な権限を利用することも、パッケージをレジストリに接続してその権限を継承することもできます。 詳しい情報については「[リポジトリのパッケージへの接続](/packages/learn-github-packages/connecting-a-repository-to-a-package)」を参照してください。 {% endif %} 詳しい情報については「[GitHub Packagesの権限について](/packages/learn-github-packages/about-permissions-for-github-packages)」{% ifversion fpt or ghec %}及び「[パッケージのアクセス制御と可視性の設定](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)」{% endif %}を参照してください。 diff --git a/translations/ja-JP/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md b/translations/ja-JP/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md index abf40d843570..6b3f8fc7cddc 100644 --- a/translations/ja-JP/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md +++ b/translations/ja-JP/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md @@ -24,9 +24,9 @@ shortTitle: Publish & install with Actions You can extend the CI and CD capabilities of your repository by publishing or installing packages as part of your workflow. {% ifversion fpt or ghec %} -### Authenticating to the {% data variables.product.prodname_container_registry %} +### Authenticating to the {% data variables.product.prodname_ghcr_and_npm_registry %} -{% data reusables.package_registry.authenticate_with_pat_for_container_registry %} +{% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} {% endif %} @@ -40,7 +40,7 @@ You can reference the `GITHUB_TOKEN` in your workflow file using the {% raw %}`{ {% note %} -**Note:** Repository-owned packages include RubyGems, npm, Apache Maven, NuGet, {% ifversion fpt or ghec %}and Gradle. {% else %}Gradle, and Docker packages that use the package namespace `docker.pkg.github.com`.{% endif %} +**Note:** Some registries, such as RubyGems, {% ifversion packages-npm-v2 %}{% else %}npm, {% endif %}Apache Maven, NuGet, {% ifversion fpt or ghec %}and Gradle{% else %}Gradle, and Docker packages that use the package namespace `docker.pkg.github.com`{% endif %}, only allow repository-owned packages. With {% data variables.product.prodname_ghcr_and_npm_registry_full %} you can choose to allow packages to be owned by a user, an organization, or linked to a repository. {% endnote %} @@ -49,11 +49,11 @@ When you enable GitHub Actions, GitHub installs a GitHub App on your repository. {% data variables.product.prodname_registry %} allows you to push and pull packages through the `GITHUB_TOKEN` available to a {% data variables.product.prodname_actions %} workflow. {% ifversion fpt or ghec %} -## About permissions and package access for {% data variables.product.prodname_container_registry %} +## About permissions and package access for {% data variables.product.prodname_ghcr_and_npm_registry %} -The {% data variables.product.prodname_container_registry %} (`ghcr.io`) allows users to create and administer containers as free-standing resources at the organization level. Containers can be owned by an organization or personal account and you can customize access to each of your containers separately from repository permissions. +The {% data variables.product.prodname_ghcr_and_npm_registry_full %} allows users to create and administer packages as free-standing resources at the organization level. Packages can be owned by an organization or personal account and you can customize access to each of your packages separately from repository permissions. -All workflows accessing the {% data variables.product.prodname_container_registry %} should use the `GITHUB_TOKEN` instead of a personal access token. For more information about security best practices, see "[Security hardening for GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)." +All workflows accessing the {% data variables.product.prodname_ghcr_and_npm_registry %} should use the `GITHUB_TOKEN` instead of a personal access token. For more information about security best practices, see "[Security hardening for GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)." ## Default permissions and access settings for containers modified through workflows @@ -484,9 +484,9 @@ Installing packages hosted by {% data variables.product.prodname_registry %} thr {% data reusables.package_registry.actions-configuration %} {% ifversion fpt or ghec %} -## Upgrading a workflow that accesses `ghcr.io` +## Upgrading a workflow that accesses a registry using a PAT -The {% data variables.product.prodname_container_registry %} supports the `GITHUB_TOKEN` for easy and secure authentication in your workflows. If your workflow is using a personal access token (PAT) to authenticate to `ghcr.io`, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. +The {% data variables.product.prodname_ghcr_and_npm_registry %} support the `GITHUB_TOKEN` for easy and secure authentication in your workflows. If your workflow is using a personal access token (PAT) to authenticate to the registry, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. For more information about the `GITHUB_TOKEN`, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)." @@ -504,9 +504,9 @@ Using the `GITHUB_TOKEN` instead of a PAT, which includes the `repo` scope, incr {% endnote %} 1. Optionally, using the "role" drop-down menu, select the default access level that you'd like the repository to have to your container image. ![Permission access levels to give to repositories](/assets/images/help/package-registry/repository-permission-options-for-package-access-through-actions.png) -1. Open your workflow file. On the line where you log in to `ghcr.io`, replace your PAT with {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. +1. Open your workflow file. On the line where you log in to the registry, replace your PAT with {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. -For example, this workflow publishes a Docker image using {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} to authenticate. +For example, this workflow publishes a Docker image to the {% data variables.product.prodname_container_registry %} and uses {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} to authenticate. ```yaml{:copy} name: Demo Push diff --git a/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md b/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md index 02708a404d0d..98ac905c0ad4 100644 --- a/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md +++ b/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md @@ -42,7 +42,9 @@ When installing or publishing a Docker image, the {% data variables.product.prod ## Authenticating to the {% data variables.product.prodname_container_registry %} -{% data reusables.package_registry.authenticate_with_pat_for_container_registry %} +{% ifversion fpt or ghec or ghes > 3.4 %} +To authenticate to the {% data variables.product.prodname_container_registry %} (`ghcr.io`) within a {% data variables.product.prodname_actions %} workflow, use the `GITHUB_TOKEN` for the best security and experience. {% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} +{% endif %} {% ifversion ghes %}Ensure that you replace `HOSTNAME` with {% data variables.product.product_location_enterprise %} hostname or IP address in the examples below.{% endif %} diff --git a/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md b/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md index 993e933de3bb..8007cd2b6f96 100644 --- a/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md +++ b/translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md @@ -21,6 +21,8 @@ shortTitle: npm registry {% data reusables.package_registry.admins-can-configure-package-types %} +{% ifversion packages-npm-v2 %} +{% else %} ## Limits for published npm versions If you publish over 1,000 npm package versions to {% data variables.product.prodname_registry %}, you may see performance issues and timeouts occur during usage. @@ -28,12 +30,17 @@ If you publish over 1,000 npm package versions to {% data variables.product.prod In the future, to improve performance of the service, you won't be able to publish more than 1,000 versions of a package on {% data variables.product.prodname_dotcom %}. Any versions published before hitting this limit will still be readable. If you reach this limit, consider deleting package versions or contact Support for help. When this limit is enforced, our documentation will be updated with a way to work around this limit. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" or "[Contacting Support](/packages/learn-github-packages/about-github-packages#contacting-support)." +{% endif %} ## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} -{% data reusables.package_registry.authenticate-packages-github-token %} +{% ifversion packages-npm-v2 %} +{% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} + +You can also choose to give access permissions to packages independently for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_actions %}. For more information, see "[Ensuring Codespaces access to your package](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-codespaces-access-to-your-package) and [Ensuring workflow access to your package](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-workflow-access-to-your-package)." +{% endif %} ### Authenticating with a personal access token @@ -94,12 +101,24 @@ $ npm login --scope=@OWNER --registry=https://HOSTNAME/_regist {% endnote %} +{% ifversion packages-npm-v2 %} +The {% data variables.product.prodname_registry %} registry stores npm packages within your organization or personal account, and allows you to associate a package with a repository. You can choose whether to inherit permissions from a repository, or set granular permissions independently of a repository. +{% endif %} + By default, {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the name field of the *package.json* file. For example, you would publish a package named `@my-org/test` to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. If you're running [npm v8.5.3](https://github.com/npm/cli/releases/tag/v8.5.3) or later, you can add a summary for the package listing page by including a *README.md* file in your package directory. For more information, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" and "[How to create Node.js Modules](https://docs.npmjs.com/getting-started/creating-node-modules)" in the npm documentation. You can publish multiple packages to the same {% data variables.product.prodname_dotcom %} repository by including a `URL` field in the *package.json* file. For more information, see "[Publishing multiple packages to the same repository](#publishing-multiple-packages-to-the-same-repository)." +{% ifversion fpt or ghec %} +When a package is published, it isn't automatically linked to a repository. You can however choose to link your published package to a repository using the user interface or command line. For more information, see "[Connecting a repository to a package](/packages/learn-github-packages/connecting-a-repository-to-a-package)." +{% endif %} + You can set up the scope mapping for your project using either a local *.npmrc* file in the project or using the `publishConfig` option in the *package.json*. {% data variables.product.prodname_registry %} only supports scoped npm packages. Scoped packages have names with the format of `@owner/name`. Scoped packages always begin with an `@` symbol. You may need to update the name in your *package.json* to use the scoped name. For example, `"name": "@codertocat/hello-world-npm"`. +{% ifversion packages-npm-v2 %} +When you first publish a package, the default visibility is private. When a package is linked to repository, the package visibility is dependent on the repository's visibility. To change the visibility or set access permissions, see "[Configuring a package's access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." +{% endif %} + {% data reusables.package_registry.viewing-packages %} ### Publishing a package using a local *.npmrc* file diff --git a/translations/ja-JP/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md b/translations/ja-JP/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md index a5c0f73d4c47..faead37ea432 100644 --- a/translations/ja-JP/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md +++ b/translations/ja-JP/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md @@ -46,7 +46,7 @@ DNS レコードの設定が正しいかどうかを検証するために利用 {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} 4. "Custom domain(カスタムドメイン)" の下で、カスタムドメインを入力して**Save(保存)**をクリックします。 サイトをブランチから公開しているなら、これで`CNAME`ファイルをソースブランチのルートに追加するコミットが作成されます。 サイトをカスタムの{% data variables.product.prodname_actions %}ワークフローで公開しているなら、`CNAME`ファイルは作成されません。 公開ソースに関する詳しい情報については「[GitHub Pagesサイトの公開ソースの設定](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)」を参照してください。 ![カスタムドメインの保存ボタン](/assets/images/help/pages/save-custom-subdomain.png) -5. お使いの DNS プロバイダにアクセスし、サブドメインがサイトのデフォルトドメインを指す `CNAME` レコードを作成します。 たとえば、サイトで `www.example.com` というサブドメインを使いたい場合、`www.example.com` が `.github.io` を指す`CNAME` レコードを作成します。 Organization サイトで `www.anotherexample.com` というサブドメインを使用する場合、`www.anotherexample.com` が `.github.io` を指す`CNAME` レコードを作成します。 `CNAME` レコードは、リポジトリ名を除いて、常に`.github.io` または `.github.io` を指している必要があります。 {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} +5. お使いの DNS プロバイダにアクセスし、サブドメインがサイトのデフォルトドメインを指す `CNAME` レコードを作成します。 たとえば、サイトで `www.example.com` というサブドメインを使いたい場合、`www.example.com` が `.github.io` を指す`CNAME` レコードを作成します。 Organization サイトで `another.example.com` というサブドメインを使用する場合、`another.example.com` が `.github.io` を指す`CNAME` レコードを作成します。 `CNAME` レコードは、リポジトリ名を除いて、常に`.github.io` または `.github.io` を指している必要があります。 {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} {% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %} {% data reusables.command_line.open_the_multi_os_terminal %} diff --git a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md index a8698de14e68..a2a2deeb5092 100644 --- a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md +++ b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md @@ -18,7 +18,7 @@ shortTitle: Merge PR automatically ## 自動マージについて -プルリクエストの自動マージを有効にすると、必要なすべてのレビューを満たし、ステータスチェックに合格すると、プルリクエストが自動的にマージされます。 自動マージにより、要件が満たされるのを待つ必要がなくなるため、他のタスクに進むことができます。 +If you enable auto-merge for a pull request, the pull request will merge automatically when all required reviews are met and all required status checks have passed. 自動マージにより、要件が満たされるのを待つ必要がなくなるため、他のタスクに進むことができます。 プルリクエストで自動マージを使用する前に、リポジトリで自動マージを有効にする必要があります。 詳しい情報については、「[リポジトリ内のプルリクエストの自動マージを管理する](/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository)」を参照してください。 diff --git a/translations/ja-JP/content/rest/apps/installations.md b/translations/ja-JP/content/rest/apps/installations.md index d83948fc68d9..9a2a2972aaee 100644 --- a/translations/ja-JP/content/rest/apps/installations.md +++ b/translations/ja-JP/content/rest/apps/installations.md @@ -17,4 +17,4 @@ versions: _インストール_とは、アプリケーションをインストールしたユーザまたは Organization のアカウントを指します。 インストールして認証し、特定のリポジトリへのアクセスを制限する方法については、「[インストールとして認証する](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)」を参照してください。 -Organization のすべての GitHub App インストールを一覧表示するには、「[Organization のアプリケーションインストールの一覧表示](/rest/reference/orgs#list-app-installations-for-an-organization)」を参照してください。 +Organization のすべての GitHub App インストールを一覧表示するには、「[Organization のアプリケーションインストールの一覧表示](/rest/orgs/orgs#list-app-installations-for-an-organization)」を参照してください。 diff --git a/translations/ja-JP/content/rest/deployments/deployments.md b/translations/ja-JP/content/rest/deployments/deployments.md index 36384095b48a..489e58df7e38 100644 --- a/translations/ja-JP/content/rest/deployments/deployments.md +++ b/translations/ja-JP/content/rest/deployments/deployments.md @@ -19,7 +19,7 @@ miniTocMaxHeadingLevel: 3 デプロイメントのステータスには、オプションとして `description` と `log_url` を含めることもできます。これによりデプロイメントのステータスがより有用なものになるので、非常におすすめです。 `log_url` はデプロイメントの出力の完全な URL で、`description` はデプロイメントで発生したことの概要を示すものです。 -GitHub は、新しいデプロイメント、デプロイメントのステータスが作成されたときに、`deployment` イベント、`deployment_status` イベントをディスパッチします。 These events allow third-party integrations to receive and respond to deployment requests, and update the status of a deployment as progress is made. +GitHub は、新しいデプロイメント、デプロイメントのステータスが作成されたときに、`deployment` イベント、`deployment_status` イベントをディスパッチします。 これらのイベントにより、サードパーティのインテグレーションがデプロイメントのリクエストに対する応答を受けとって反応し、進展があるたびにステータスを更新できます。 以下は、これらの相互作用がどのように機能するかを示す簡単なシーケンス図です。 diff --git a/translations/ja-JP/content/rest/guides/getting-started-with-the-rest-api.md b/translations/ja-JP/content/rest/guides/getting-started-with-the-rest-api.md index dd9545f30b92..8c54d89f60fc 100644 --- a/translations/ja-JP/content/rest/guides/getting-started-with-the-rest-api.md +++ b/translations/ja-JP/content/rest/guides/getting-started-with-the-rest-api.md @@ -166,7 +166,7 @@ curl --request GET \ {% note %} -**Note:** In most cases, you can use `Authorization: Bearer` or `Authorization: token`. JSON web tokens (JWTs) will only work with `Authorization: Bearer`. +**Note:** {% data reusables.getting-started.bearer-vs-token %} {% endnote %} diff --git a/translations/ja-JP/content/rest/overview/other-authentication-methods.md b/translations/ja-JP/content/rest/overview/other-authentication-methods.md index 9b78b65c4ca8..9948e2eacc76 100644 --- a/translations/ja-JP/content/rest/overview/other-authentication-methods.md +++ b/translations/ja-JP/content/rest/overview/other-authentication-methods.md @@ -76,10 +76,16 @@ $ curl -u username {% data variables.product.api_url_pre %}/user {% endnote %} +{% note %} + +**ノート:** {% data reusables.getting-started.bearer-vs-token %} + +{% endnote %} + 認証に[SAML SSO][saml-sso]を強制しているOrganizationにアクセスするためAPIを使用している場合は、個人アクセストークン (PAT) を作成し、Organizationに対して[そのトークンを認証する][allowlist]必要があります。 `X-GitHub-SSO` で指定された URL にアクセスして、Organization のトークンを承認します。 ```shell -$ curl -v -H "Authorization: token TOKEN" {% data variables.product.api_url_pre %}/repos/octodocs-test/test +$ curl -v -H "Authorization: Bearer TOKEN" {% data variables.product.api_url_pre %}/repos/octodocs-test/test > X-GitHub-SSO: required; url=https://github.com/orgs/octodocs-test/sso?authorization_request=AZSCKtL4U8yX1H3sCQIVnVgmjmon5fWxks5YrqhJgah0b2tlbl9pZM4EuMz4 { @@ -91,7 +97,7 @@ $ curl -v -H "Authorization: token TOKEN" {% data variables.product.api 複数の Organization からのデータをリクエストする場合(たとえば、[ユーザが作成した Issue のリストをリクエストする場合][user-issues])、`X-GitHub-SSO` ヘッダは、個人アクセストークンを承認する必要がある Organization を示します。 ```shell -$ curl -v -H "Authorization: token TOKEN" {% data variables.product.api_url_pre %}/user/issues +$ curl -v -H "Authorization: Bearer TOKEN" {% data variables.product.api_url_pre %}/user/issues > X-GitHub-SSO: partial-results; organizations=21955855,20582480 ``` diff --git a/translations/ja-JP/content/rest/overview/resources-in-the-rest-api.md b/translations/ja-JP/content/rest/overview/resources-in-the-rest-api.md index a4c4c6469735..0668815a6bb1 100644 --- a/translations/ja-JP/content/rest/overview/resources-in-the-rest-api.md +++ b/translations/ja-JP/content/rest/overview/resources-in-the-rest-api.md @@ -79,7 +79,7 @@ $ curl -u "username" {% data variables.product.api_url_pre %} ### OAuth2 トークン(ヘッダに送信) ```shell -$ curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre %} +$ curl -H "Authorization: Bearer OAUTH-TOKEN" {% data variables.product.api_url_pre %} ``` {% note %} @@ -88,6 +88,12 @@ $ curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product. {% endnote %} +{% note %} + +**ノート:** {% data reusables.getting-started.bearer-vs-token %} + +{% endnote %} + [OAuth2 の詳細](/apps/building-oauth-apps/)をお読みください。 OAuth2 トークンは、本番アプリケーションの [Web アプリケーションフロー](/developers/apps/authorizing-oauth-apps#web-application-flow)で取得できることに注意してください。 {% ifversion fpt or ghes or ghec %} diff --git a/translations/ja-JP/content/rest/overview/troubleshooting.md b/translations/ja-JP/content/rest/overview/troubleshooting.md index 4d97fa8f1321..094cd17e7c17 100644 --- a/translations/ja-JP/content/rest/overview/troubleshooting.md +++ b/translations/ja-JP/content/rest/overview/troubleshooting.md @@ -44,13 +44,13 @@ curl -u my_user:my_password https://api.github.com/user/repos エンドポイントをテストするとき、またはローカル開発を実行するときには、かわりに[個人アクセストークン](/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)を使用してください。 ```bash -curl -H 'Authorization: token my_access_token' https://api.github.com/user/repos +curl -H 'Authorization: Bearer my_access_token' https://api.github.com/user/repos ``` OAuth App の場合は、[Web アプリケーションフロー](/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow)を使用して、API 呼び出しのヘッダーで使用する OAuth トークンを生成する必要があります。 ```bash -curl -H 'Authorization: token my-oauth-token' https://api.github.com/user/repos +curl -H 'Authorization: Bearer my-oauth-token' https://api.github.com/user/repos ``` ## タイムアウト diff --git a/translations/ja-JP/content/rest/quickstart.md b/translations/ja-JP/content/rest/quickstart.md index f46c499ab474..7c56fcf40206 100644 --- a/translations/ja-JP/content/rest/quickstart.md +++ b/translations/ja-JP/content/rest/quickstart.md @@ -7,7 +7,7 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: クイックスタート +shortTitle: Quickstart topics: - API redirect_from: @@ -62,9 +62,9 @@ jobs: If you are authenticating with a {% data variables.product.prodname_github_app %}, you can create an installation access token within your workflow: -1. Store your {% data variables.product.prodname_github_app %}'s ID as a secret. In the following example, replace `APP_ID` with the name of the secret. アプリケーションIDは、アプリケーションの設定ページで、あるいはアプリケーションのAPIを通じて確認できます。 詳しい情報については「[アプリケーション](/rest/apps/apps#get-an-app)」を参照してください。 For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." -1. アプリケーションの秘密鍵を生成してください。 Store the contents of the resulting file as a secret. (ファイルの内容は、`-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----`という部分も含めて全体をほぞんしてください。) In the following example, replace `APP_PEM` with the name of the secret. 詳しい情報については「[{% data variables.product.prodname_github_apps %}での認証](/developers/apps/building-github-apps/authenticating-with-github-apps#generating-a-private-key)」を参照してください。 -1. Add a step to generate a token, and use that token instead of `GITHUB_TOKEN`. Note that this token will expire after 60 minutes. 例: +1. Store your {% data variables.product.prodname_github_app %}'s ID as a secret. In the following example, replace `APP_ID` with the name of the secret. You can find your app ID on the settings page for your app or through the App API. For more information, see "[Apps](/rest/apps/apps#get-an-app)." For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." +1. Generate a private key for your app. Store the contents of the resulting file as a secret. (Store the entire contents of the file, including `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----`.) In the following example, replace `APP_PEM` with the name of the secret. For more information, see "[Authenticating with {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps/authenticating-with-github-apps#generating-a-private-key)." +1. Add a step to generate a token, and use that token instead of `GITHUB_TOKEN`. Note that this token will expire after 60 minutes. For example: ```yaml {% data reusables.actions.actions-not-certified-by-github-comment %} @@ -203,9 +203,9 @@ try { If you are authenticating with a {% data variables.product.prodname_github_app %}, you can create an installation access token within your workflow: -1. Store your {% data variables.product.prodname_github_app %}'s ID as a secret. In the following example, replace `APP_ID` with the name of the secret. アプリケーションIDは、アプリケーションの設定ページで、あるいはアプリケーションのAPIを通じて確認できます。 詳しい情報については「[アプリケーション](/rest/apps/apps#get-an-app)」を参照してください。 For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." -1. アプリケーションの秘密鍵を生成してください。 Store the contents of the resulting file as a secret. (ファイルの内容は、`-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----`という部分も含めて全体をほぞんしてください。) In the following example, replace `APP_PEM` with the name of the secret. 詳しい情報については「[{% data variables.product.prodname_github_apps %}での認証](/developers/apps/building-github-apps/authenticating-with-github-apps#generating-a-private-key)」を参照してください。 -1. Add a step to generate a token, and use that token instead of `GITHUB_TOKEN`. Note that this token will expire after 60 minutes. 例: +1. Store your {% data variables.product.prodname_github_app %}'s ID as a secret. In the following example, replace `APP_ID` with the name of the secret. You can find your app ID on the settings page for your app or through the App API. For more information, see "[Apps](/rest/apps/apps#get-an-app)." For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." +1. Generate a private key for your app. Store the contents of the resulting file as a secret. (Store the entire contents of the file, including `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----`.) In the following example, replace `APP_PEM` with the name of the secret. For more information, see "[Authenticating with {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps/authenticating-with-github-apps#generating-a-private-key)." +1. Add a step to generate a token, and use that token instead of `GITHUB_TOKEN`. Note that this token will expire after 60 minutes. For example: ```yaml {% data reusables.actions.actions-not-certified-by-github-comment %} @@ -284,7 +284,7 @@ jobs: {% note %} - **Note:** In most cases, you can use `Authorization: Bearer` or `Authorization: token`. JSON web tokens (JWTs) only work with `Authorization: Bearer`. + **Note:** {% data reusables.getting-started.bearer-vs-token %} {% endnote %} @@ -314,9 +314,9 @@ jobs: If you are authenticating with a {% data variables.product.prodname_github_app %}, you can create an installation access token within your workflow: -1. Store your {% data variables.product.prodname_github_app %}'s ID as a secret. In the following example, replace `APP_ID` with the name of the secret. アプリケーションIDは、アプリケーションの設定ページで、あるいはアプリケーションのAPIを通じて確認できます。 詳しい情報については「[アプリケーション](/rest/apps/apps#get-an-app)」を参照してください。 For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." -1. アプリケーションの秘密鍵を生成してください。 Store the contents of the resulting file as a secret. (ファイルの内容は、`-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----`という部分も含めて全体をほぞんしてください。) In the following example, replace `APP_PEM` with the name of the secret. 詳しい情報については「[{% data variables.product.prodname_github_apps %}での認証](/developers/apps/building-github-apps/authenticating-with-github-apps#generating-a-private-key)」を参照してください。 -1. Add a step to generate a token, and use that token instead of `GITHUB_TOKEN`. Note that this token will expire after 60 minutes. 例: +1. Store your {% data variables.product.prodname_github_app %}'s ID as a secret. In the following example, replace `APP_ID` with the name of the secret. You can find your app ID on the settings page for your app or through the App API. For more information, see "[Apps](/rest/apps/apps#get-an-app)." For more information about secrets, see "[Encrypted secrets](/actions/security-guides/encrypted-secrets)." +1. Generate a private key for your app. Store the contents of the resulting file as a secret. (Store the entire contents of the file, including `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----`.) In the following example, replace `APP_PEM` with the name of the secret. For more information, see "[Authenticating with {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps/authenticating-with-github-apps#generating-a-private-key)." +1. Add a step to generate a token, and use that token instead of `GITHUB_TOKEN`. Note that this token will expire after 60 minutes. For example: ```yaml {% data reusables.actions.actions-not-certified-by-github-comment %} @@ -346,6 +346,6 @@ jobs: {% endcurl %} -## 次のステップ +## Next steps For a more detailed guide, see "[Getting started with the REST API](/rest/guides/getting-started-with-the-rest-api)." diff --git a/translations/ja-JP/content/rest/teams/external-groups.md b/translations/ja-JP/content/rest/teams/external-groups.md index de118fd6e86f..b7f035641830 100644 --- a/translations/ja-JP/content/rest/teams/external-groups.md +++ b/translations/ja-JP/content/rest/teams/external-groups.md @@ -19,7 +19,7 @@ miniTocMaxHeadingLevel: 3 **ノート:** -- 外部グループAPIは、{% data variables.product.prodname_emus %}を使用しているEnterpriseの一部であるOrganizationでのみ利用できます。 詳しい情報については「[Enterpriseが管理しているユーザ](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)」を参照してください。 +- External groups APIは、{% data variables.product.prodname_emus %}を使用しているEnterpriseの一部であるOrganizationでのみ利用できます。 詳しい情報については「[Enterpriseが管理しているユーザ](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)」を参照してください。 - OrganizationがTeam同期を使用している場合、Team Synchronization APIが利用できます。 詳しい情報については「[Team synchronization API](#team-synchronization)」を参照してください。 {% endnote %} diff --git a/translations/ja-JP/content/rest/users/index.md b/translations/ja-JP/content/rest/users/index.md index cd57b26e0d53..74913338d30a 100644 --- a/translations/ja-JP/content/rest/users/index.md +++ b/translations/ja-JP/content/rest/users/index.md @@ -19,5 +19,6 @@ children: - /followers - /gpg-keys - /keys + - /ssh-signing-keys --- diff --git a/translations/ja-JP/content/rest/users/ssh-signing-keys.md b/translations/ja-JP/content/rest/users/ssh-signing-keys.md new file mode 100644 index 000000000000..910254d9dfd9 --- /dev/null +++ b/translations/ja-JP/content/rest/users/ssh-signing-keys.md @@ -0,0 +1,13 @@ +--- +title: SSH署名キー +intro: '' +versions: + fpt: '*' + ghes: '>=3.7' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + diff --git a/translations/ja-JP/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md b/translations/ja-JP/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md index 8cf626bbd052..88705321ab5e 100644 --- a/translations/ja-JP/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md +++ b/translations/ja-JP/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md @@ -21,9 +21,9 @@ GitHub を利用する際、数多くの追加製品や機能 (「追加製品 「追加製品および機能」を利用することにより、お客様は以下に挙げた該当する「GitHub 追加製品および機能の利用規約」にも同意することとなります。 A violation of these GitHub Terms for Additional Products and Features is a violation of the Agreement. かぎ括弧に括られた用語のうち、ここで定義されていないものについては、「契約」に示された意味を持つものとします。 **Enterprise ユーザ向け** -- **GitHub Enterprise Cloud** users may have access to the following Additional Products and Features: Actions, Advanced Security, Advisory Database, Codespaces, Dependabot Preview, GitHub Enterprise Importer, Learning Lab, Packages, and Pages. +- **GitHub Enterprise Cloud** users may have access to the following Additional Products and Features: Actions, Advanced Security, Advisory Database, Codespaces, Dependabot Preview, GitHub Enterprise Importer, Packages, and Pages. -- **GitHub Enterprise Server** users may have access to the following Additional Products and Features: Actions, Advanced Security, Advisory Database, Connect, Dependabot Preview, GitHub Enterprise Importer, Learning Lab, Packages, Pages, and SQL Server Images. +- **GitHub Enterprise Server** users may have access to the following Additional Products and Features: Actions, Advanced Security, Advisory Database, Connect, Dependabot Preview, GitHub Enterprise Importer, Packages, Pages, and SQL Server Images. - **GitHub AE** users may have access to the following Additional Products and Features: Actions, Advanced Security, Advisory Database, Connect, Dependabot Preview, GitHub Enterprise Importer, Packages and Pages. @@ -106,19 +106,6 @@ GitHub Copilot (i) may, depending on your preferred telemetry settings, collect ## GitHub Enterprise Importer Importer is a framework for exporting data from other sources to be imported to the GitHub platform. Importer is provided “AS-IS”. -## Learning Lab -GitHub Learning Lab では、GitHub に組み込まれたインタラクティブなコースを無料で提供しており、自動の即時フィードバックやヘルプも備わっています。 - -*コース資料。*GitHubは、自らが提供するコース資料の所有者であり、Learning Labの使用に関連した内部的な業務目的で、かかるコース資料を複製、保守、使用、および実行するための世界的で非独占的、期間限定、譲渡不可の無料ライセンスをお客様に付与します。 - -コース資料で提供されるソースコードの一部には、オープンソースライセンスの条項が適用される場合があります。 - -お客様が作成するコースはお客様が所有し、GitHubに対して、かかるコース資料を複製、保守、使用、および実行するための世界的で非独占的、期間限定、譲渡不可の無料ライセンスをGitHubに付与します。 - -GitHubコースの使用、ならびにお客様ご自身によるコース資料の作成および保管は、いずれかの当事者による相手方の知的所有権の共同所有権を構成するものではありません。 - -「個人データ」の利用には、「[GitHubのプライバシーについての声明](/github/site-policy/github-privacy-statement)」が適用されます。 - ## npm npm はソフトウェアパッケージのホスティングサービスであり、ソフトウェアパッケージをプライベートまたパブリックでホストでき、パッケージをプロジェクト中で依存関係として使えるようになります。 npm はJavaScriptエコシステムのためのレコードのレジストリです。 npm 公開レジストリの利用は無料ですが、プライベートパッケージを公開したり、チームを使用してプライベートパッケージを管理したい場合には有料となります。 [npm ドキュメント](https://docs.npmjs.com/)にはアカウントの種類の制限や、[プライベートパッケージ](https://docs.npmjs.com/about-private-packages)および[Organization](https://docs.npmjs.com/organizations)の管理方法についての詳細が記載されています。 npm registryレジストリの利用規程は、[オープンソース規約](https://www.npmjs.com/policies/open-source-terms)に概説されています。 また、npm [solo](https://www.npmjs.com/policies/solo-plan)と[org](https://www.npmjs.com/policies/orgs-plan)の両方のプランに補足条項があります。 npmの利用には、npm[利用規約](https://www.npmjs.com/policies/terms)が適用されます。 diff --git a/translations/ja-JP/content/site-policy/privacy-policies/github-privacy-statement.md b/translations/ja-JP/content/site-policy/privacy-policies/github-privacy-statement.md index 4fbe56791c35..4e3059082127 100644 --- a/translations/ja-JP/content/site-policy/privacy-policies/github-privacy-statement.md +++ b/translations/ja-JP/content/site-policy/privacy-policies/github-privacy-statement.md @@ -15,7 +15,7 @@ topics: - Legal --- -Effective date: May 31, 2022 +Effective date: September 1, 2022 Thanks for entrusting GitHub Inc. or GitHub B.V. (“GitHub”, “we”, "us" or "our") with your source code, your projects, and your personal data. This Privacy Statement explains our practices regarding the collection, use, and disclosure of your data, including any personal data we collect and process in connection with our website and any applications, software, products, and services provided by GitHub, including any Beta Previews (collectively “Service”). @@ -25,28 +25,28 @@ Thanks for entrusting GitHub Inc. or GitHub B.V. (“GitHub”, “we”, "us" o ## ショートバージョン -Githubではお客様の個人情報をプライバシーステートメントに記載のとおり使用します。 お客様の所在地や住所、どこの国の市民かに関係なく、出身国や所在地を問わず世界中のすべてのユーザーに対して等しく高水準のプライバシー保護を提供します。 +Githubではお客様の個人情報をプライバシーステートメントに記載のとおり使用します。 No matter where you are, where you live, or what your citizenship is, you have the same high standard of privacy protection when using GitHub's products as all our users around the world, regardless of their country of origin or location. To see our Privacy Notice to residents of California, please go to [GitHub's Notice about the California Consumer Privacy Act](#githubs-notice-to-california-residents) or scroll down. ## 概要 -| セクション | 各セクションの内容 | -| --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [Who is responsible for the processing of your information](#who-is-responsible-for-the-processing-of-your-information) | Subject to limited exceptions, GitHub is the controller and entity responsible for the processing of your personal data in connection with the Website or Service. | -| [GitHubが収集する情報](#what-information-github-collects) | GitHubは、お客様の登録内容や支払い、取引、ユーザプロフィールから直接情報を収集します。 当社は、また、お客様の同意が必要な場合は同意を得て、自動的に利用情報、クッキー、およびデバイス情報から収集します。 GitHub may also collect personal data from third parties. We only collect the minimum amount of personal data necessary from you, unless you choose to provide more. | -| [当社のお客様情報の利用方法](#how-github-uses-your-information) | In this section, we describe the ways in which we use your information, including to provide you the Service, to communicate with you, for security and compliance purposes, and to improve our Website or Service or develop new features and functionality of our Website or Service. 法令が要求している場合、さらに、お客様の情報を処理する法的な根拠を記載します。 | -| [当社が収集したお客様の情報の共有方法](#how-we-share-the-information-we-collect) | 次のいずれかの場合において、当社はお客様の情報を第三者と共有することがあります。 ・お客様の同意がある場合 ・当社のサービスプロバイダ間と共有する場合 ・セキュリティを目的とする場合 ・当社の法的義務を遵守する必要がある場合 ・事業法人または事業部門について支配者の変更または売却が行われた場合 当社が個人情報を販売することはありません。GitHubでは広告を掲載することもありません。 | -| [Your choices regarding our processing of your personal data](#your-choices-regarding-our-processing-of-your-personal-data) | 当社は、お客様に対して、お客様の個人情報にアクセス、変更または削除する方法を提供します。 | -| [クッキー](#cookies) | We only use strictly necessary cookies to provide, secure, and improve our Website or Service or develop new features and functionality of our Website or Service. 当社は、このクッキーとトラッキングについて透明性の高いページを提供します。 We do not send any information to third-party analytics services. | -| [お客様情報についての当社の保護方法](#how-github-secures-your-information) | We take all measures reasonably necessary to protect the confidentiality, integrity, and availability of your personal data on GitHub and to protect the resilience of our servers. | -| [Communication preferences](#communication-preferences) | 当社は、お客様にemailでご連絡します。 アカウント設定または当社にご連絡いただければ、当社からお客様への方法を管理できます。 | -| [苦情の解決](#resolving-complaints) | 万が一、当社がプライバシーに関する懸念を迅速かつ十分に解決できない場合、当社は紛争解決の方法を提案します。 | -| [プライバシーステートメントの変更](#changes-to-our-privacy-statement) | 当社は、本プライバシーステートメントの重大な変更について当該変更が有効となる30日前に、お客様に通知します。 お客様は、変更を当社のサイトポリシーリポジトリにおいて確認することもできます。 | -| [ライセンス](#license) | 本プライバシーステートメントは、[Creative Commons Zero license](https://creativecommons.org/publicdomain/zero/1.0/)の元でライセンス付与されています。 | -| [GitHubへの連絡](#contacting-github) | 当社のプライバシーステートメントに関するご質問がある場合はお気軽にお問い合わせください。 | -| [翻訳](#translations) | 当社では、一部のプライバシーステートメントの翻訳のリンクを提供しています。 | +| セクション | 各セクションの内容 | +| --------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [Who is responsible for the processing of your information](#who-is-responsible-for-the-processing-of-your-information) | Subject to limited exceptions, GitHub is the controller and entity responsible for the processing of your personal data in connection with the Website or Service if you are in North America. For individuals outside North America the data controller is GitHub B.V. | +| [GitHubが収集する情報](#what-information-github-collects) | GitHubは、お客様の登録内容や支払い、取引、ユーザプロフィールから直接情報を収集します。 当社は、また、お客様の同意が必要な場合は同意を得て、自動的に利用情報、クッキー、およびデバイス情報から収集します。 GitHub may also collect personal data from third parties. We only collect the minimum amount of personal data necessary from you, unless you choose to provide more. | +| [当社のお客様情報の利用方法](#how-github-uses-your-information) | In this section, we describe the ways in which we use your information, including to provide you the Service, to communicate with you, for security and compliance purposes, and to improve our Website or Service or develop new features and functionality of our Website or Service. 法令が要求している場合、さらに、お客様の情報を処理する法的な根拠を記載します。 | +| [当社が収集したお客様の情報の共有方法](#how-we-share-the-information-we-collect) | 次のいずれかの場合において、当社はお客様の情報を第三者と共有することがあります。 ・お客様の同意がある場合 ・当社のサービスプロバイダ間と共有する場合 ・セキュリティを目的とする場合 ・当社の法的義務を遵守する必要がある場合 ・事業法人または事業部門について支配者の変更または売却が行われた場合 当社が個人情報を販売することはありません。GitHubでは広告を掲載することもありません。 | +| [Your choices regarding our processing of your personal data](#your-choices-regarding-our-processing-of-your-personal-data) | 当社は、お客様に対して、お客様の個人情報にアクセス、変更または削除する方法を提供します。 | +| [クッキー](#cookies) | Except for cookies used on our Enterprise Marketing Pages, we only use strictly necessary cookies to provide, secure, and improve our Website or Service or develop new features and functionality of our Website or Service.

As described below, we may use non-essential cookies on certain pages of our website to support our enterprise marketing efforts and market our products and services to enterprise customers, for example on resources.github.com (collectively “Enterprise Marketing Pages”).

We offer a [page](https://github.com/privacy/cookies) that makes all uses of cookies very transparent. | +| [お客様情報についての当社の保護方法](#how-github-secures-your-information) | We take all measures reasonably necessary to protect the confidentiality, integrity, and availability of your personal data on GitHub and to protect the resilience of our servers. | +| [Communication preferences](#communication-preferences) | 当社は、お客様にemailでご連絡します。 アカウント設定または当社にご連絡いただければ、当社からお客様への方法を管理できます。 | +| [苦情の解決](#resolving-complaints) | 万が一、当社がプライバシーに関する懸念を迅速かつ十分に解決できない場合、当社は紛争解決の方法を提案します。 | +| [プライバシーステートメントの変更](#changes-to-our-privacy-statement) | 当社は、本プライバシーステートメントの重大な変更について当該変更が有効となる30日前に、お客様に通知します。 お客様は、変更を当社のサイトポリシーリポジトリにおいて確認することもできます。 | +| [ライセンス](#license) | 本プライバシーステートメントは、[Creative Commons Zero license](https://creativecommons.org/publicdomain/zero/1.0/)の元でライセンス付与されています。 | +| [GitHubへの連絡](#contacting-github) | 当社のプライバシーステートメントに関するご質問がある場合はお気軽にお問い合わせください。 | +| [翻訳](#translations) | 当社では、一部のプライバシーステートメントの翻訳のリンクを提供しています。 | ## GitHubのプライバシーについての声明 @@ -122,13 +122,14 @@ We may use your information to provide, administer, analyze, manage, and operate - Personalization of our Service by understanding you and your preferences to enhance your experience and enjoyment using our Service. - Provide customer support and respond to your questions. - Deliver promotional communications with you about new services, features, offers, promotions, and other information about our Service. +- Personalize and measure the effectiveness of enterprise business ads, promotional communications or marketing you receive related to the Enterprise Marketing Pages. - Send you information, including confirmations, invoices, technical notices, updates, security alerts, support and administrative messages. We combine data we collect from different sources for these purposes and to give you a more seamless, consistent, and personalized experience. ## 当社が収集したお客様の情報の共有方法 -We share personal data with your consent or as necessary to complete your transactions or provide the services you have requested or authorized. In addition, we may share each of the categories of your personal data described above with the types of third parties described below for the following business purposes: +We share personal data as described below, including with your consent or as necessary to complete your transactions or provide the services you have requested or authorized. In addition, we may share each of the categories of your personal data described above with the types of third parties described below for the following business purposes: ### Public information You may select options available through our Service to publicly display and share your name and/or username and certain other information, such as your profile, demographic data, content and files, or geolocation data. For example, if you would like your email address to remain private, even when you’re commenting on public repositories, [you can adjust your setting for your email address to be private in your user profile](https://github.com/settings/emails). You can also [update your local Git configuration to use your private email address](/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address). コミットメッセージ内のメールアドレスに関する詳細については、[こちら](/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address)を参照してください。 @@ -144,9 +145,9 @@ You can enable or add third-party applications, known as "Developer Products" to You may indicate, through your actions on GitHub, that you are willing to share your personal data. If you collaborate on or become a member of an organization, then its Account owners may receive your personal data. When you accept an invitation to an organization, you will be notified of the types of information owners may be able to see (for more information, see [About Organization Membership](/github/setting-up-and-managing-your-github-user-account/about-organization-membership)). Please contact the Account owners for more information about how they might process your personal data in their Organization and the ways for you to access, update, alter, or delete your personal data stored in the Account. ### サービスプロバイダ -We share your personal data with service providers who process the information on our behalf to provide or improve our Service. For example, our service providers may perform payment processing, customer support ticketing, network data transmission, security, and other similar services. While GitHub processes all personal data in the United States, our service providers may process data outside of the United States or the European Union. Such processing by service providers will be in compliance with applicable law including any relevant transfer mechanism. +We share your personal data with service providers who process the information on our behalf to provide or improve our Service. For example, our service providers may perform payment processing, customer support ticketing, network data transmission, web analytics, marketing operations, security, and other similar services. While GitHub processes all personal data in the United States, our service providers may process data outside of the United States or the European Union. Such processing by service providers will be in compliance with applicable law including any relevant transfer mechanism. - ### Affiliates We enable access to personal data across our subsidiaries, affiliates, and related companies, for example, where we share common data systems or where access is needed to operate and provide the Service. + ### Affiliates We enable access to personal data across our subsidiaries, affiliates, and related companies, for example, where we share common data systems, when affiliates provide services on our behalf, or where access is needed to operate and provide the Service. ### セキュリティを目的とする場合 We will disclose personal data if we believe it is necessary to: @@ -171,7 +172,7 @@ We *do not* sell your personal data for monetary or other consideration as defin ## Your choices regarding our processing of your personal data We provide choices about the personal data we collect about you. The choices you make will not apply to any personal data associated with an Organization under your Account. -Access, correction, and deletion. If you're a GitHub user, you may access, update, alter, or delete your basic user profile information by [editing your user profile](https://github.com/settings/profile) or contacting [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://enterprise.githubsupport.com/hc/en-us). 当社がお客様について収集する情報は、プロフィールに掲載する情報を限定する、お客様の情報を最新に保つ、または[GitHub Support](https://support.github.com/contact)もしくは[GitHubPremium Support](https://enterprise.githubsupport.com/hc/en-us)に連絡することにより管理できます。 +Access, correction, and deletion. If you're a GitHub user, you may access, update, alter, or delete your basic user profile information by [editing your user profile](https://github.com/settings/profile) or contacting [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://enterprise.githubsupport.com/hc/en-us). You can control the information we collect about you by limiting what information is in your profile, by keeping your information current, by changing your cookie preferences, or by contacting [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://enterprise.githubsupport.com/hc/en-us). We retain and use your information as described in this Privacy Statement, but barring legal requirements, we will delete your full profile within 90 days of your request. アカウントが削除された後でも、他のユーザのリポジトリへのコントリビューションおよび他のIssueのコメントなどの一定のデータは残存します。 However, we will delete or de-identify your personal data, including your username and email address, from the author field of issues, pull requests, and comments by associating them with a ghost user. That said, the email address you have provided via your Git commit settings will always be associated with your commits in the Git system. メールアドレスを非公開にする場合、Gitコミット設定もアップデートする必要があります。 当社は、Gitコミット履歴のデータを変更または削除することはできません。Gitソフトウェアは記録を保持する設計になっています。ただし、当社は、お客様がその記録に入力する情報を管理できるようにします。 @@ -208,13 +209,65 @@ We rely on different lawful bases for collecting and processing personal data ab ### Cookies and tracking technologies -GitHub uses cookies to provide, secure and improve our Service or to develop new features and functionality of our Service. For example, we use them to keep you logged in, remember your preferences, identify your device for security purposes, compile statistical reports, and provide information for future development of GitHub. We use our own cookies and do not use any third-party service providers in this context. If you disable your browser or device’s ability to accept these cookies, you will not be able to log in or use our Service. [GitHub上のクッキー](/github/site-policy/github-subprocessors-and-cookies#cookies-on-github)については、[GitHubの当社のサブプロセッサーおよびクッキー](/github/site-policy/github-subprocessors-and-cookies)のページで、当社が設定するクッキー、クッキーの必要性、およびクッキーの有効期限について詳しく説明しています。 +GitHub uses cookies to provide, secure and improve our Service or to develop new features and functionality of our Service. For example, we use them to (i) keep you logged in, (ii) remember your preferences, (iii) identify your device for security and fraud purposes, including as needed to maintain the integrity of our Service, (iv) compile statistical reports, and (v) provide information and insight for future development of GitHub. We provide more information about [cookies on GitHub](https://github.com/privacy/cookies) that describes the cookies we set, the needs we have for those cookies, and the expiration of such cookies. + +For Enterprise Marketing Pages, we may also use non-essential cookies to (i) gather information about enterprise users’ interests and online activities to personalize their experiences, including by making the ads, content, recommendations, and marketing seen or received more relevant and (ii) serve and measure the effectiveness of targeted advertising and other marketing efforts. If you disable the non-essential cookies on the Enterprise Marketing Pages, the ads, content, and marketing you see may be less relevant. Our emails to users may contain a pixel tag, which is a small, clear image that can tell us whether or not you have opened an email and what your IP address is. We use this pixel tag to make our email communications more effective and to make sure we are not sending you unwanted email. -### DNT +The length of time a cookie will stay on your browser or device depends on whether it is a “persistent” or “session” cookie. Session cookies will only stay on your device until you stop browsing. Persistent cookies stay until they expire or are deleted. The expiration time or retention period applicable to persistent cookies depends on the purpose of the cookie collection and tool used. You may be able to delete cookie data as described here. + +#### What are cookies and similar technologies? + +We use cookies and similar technologies, such as web beacons, local storage, and mobile analytics, to operate and provide our Services. When visiting Enterprise Marketing Pages, like resources.github.com, these and additional cookies, like advertising IDs, may be used for sales and marketing purposes. + +Cookies are small text files stored by your browser on your device. A cookie can later be read when your browser connects to a web server in the same domain that placed the cookie. The text in a cookie contains a string of numbers and letters that may uniquely identify your device and can contain other information as well. This allows the web server to recognize your browser over time, each time it connects to that web server. + +Web beacons are electronic images (also called “single-pixel” or “clear GIFs”) that are contained within a website or email. When your browser opens a webpage or email that contains a web beacon, it automatically connects to the web server that hosts the image (typically operated by a third party). This allows that web server to log information about your device and to set and read its own cookies. In the same way, third-party content on our websites (such as embedded videos, plug-ins, or ads) results in your browser connecting to the third-party web server that hosts that content. + +Mobile identifiers for analytics can be accessed and used by apps on mobile devices in much the same way that websites access and use cookies. When visiting Enterprise Marketing pages, like resources.github.com, on a mobile device these may allow us and our third-party analytics and advertising partners to collect data for sales and marketing purposes. + +We may also use so-called “flash cookies” (also known as “Local Shared Objects” or “LSOs”) to collect and store information about your use of our Services. Flash cookies are commonly used for advertisements and videos. + +#### How do we and our partners use cookies and similar technologies? + +The GitHub Services use cookies and similar technologies for a variety of purposes, including to store your preferences and settings, enable you to sign-in, analyze how our Services perform, track your interaction with the Services, develop inferences, combat fraud, and fulfill other legitimate purposes. Some of these cookies and technologies may be provided by third parties, including service providers and advertising partners. For example, our analytics and advertising partners may use these technologies in our Services to collect personal information (such as the pages you visit, the links you click on, and similar usage information, identifiers, and device information) related to your online activities over time and across Services for various purposes, including targeted advertising. GitHub will place non-essential cookies on pages where we market products and services to enterprise customers, for example, on resources.github.com. + +We and/or our partners also share the information we collect or infer with third parties for these purposes. + +The table below provides additional information about how we use different types of cookies: + +| 目的 | 説明 | +|:---------------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Required Cookies | GitHub uses required cookies to perform essential website functions and to provide the services. For example, cookies are used to log you in, save your language preferences, provide a shopping cart experience, improve performance, route traffic between web servers, detect the size of your screen, determine page load times, improve user experience, and for audience measurement. These cookies are necessary for our websites to work. | +| 分析 | We allow third parties to use analytics cookies to understand how you use our websites so we can make them better. For example, cookies are used to gather information about the pages you visit and how many clicks you need to accomplish a task. We also use some analytics cookies to provide personalized advertising. | +| Social Media | GitHub and third parties use social media cookies to show you ads and content based on your social media profiles and activity on GitHub’s websites. This ensures that the ads and content you see on our websites and on social media will better reflect your interests. This also enables third parties to develop and improve their products, which they may use on websites that are not owned or operated by GitHub. | +| Advertising | In addition, GitHub and third parties use advertising cookies to show you new ads based on ads you've already seen. Cookies also track which ads you click or purchases you make after clicking an ad. This is done both for payment purposes and to show you ads that are more relevant to you. For example, cookies are used to detect when you click an ad and to show you ads based on your social media interests and website browsing history. | + +#### What are your cookie choices and controls? + + You have several options to disable non-essential cookies: + + 1. **Specifically on GitHub Enterprise Marketing Pages** + + Any GitHub page that serves non-essential cookies will have a link in the page’s footer to cookie settings. You can express your preferences at any time by clicking on that linking and updating your settings. + + Some users will also be able to manage non-essential cookies via a cookie consent banner, including the options to accept, manage, and reject all non-essential cookies. + 2. **Generally for all websites** + + You can control the cookies you encounter on the web using a variety of widely-available tools. 例: + - If your browser sends a [Do Not Track](https://en.wikipedia.org/wiki/Do_Not_Track) (DNT) signal, GitHub will not set non-essential cookies and will not load third party resources which set non-essential cookies. + - Many browsers provide cookie controls which may limit the types of cookies you encounter online. Check out the documentation for your browser to learn more. + - If you enable a browser extension designed to block tracking, such as [Privacy Badger](https://en.wikipedia.org/wiki/Privacy_Badger), non-essential cookies set by a website or third parties may be disabled. + - If you enable a browser extension designed to block unwanted content, such as [uBlock Origin](https://en.wikipedia.org/wiki/UBlock_Origin), non-essential cookies will be disabled to the extent that content that sets non-essential cookies will be blocked. + - Advertising controls. Our advertising partners may participate in associations that provide simple ways to opt out of ad targeting, which you can access at: + - United States: [NAI](http://optout.networkadvertising.org) and [DAA](http://optout.aboutads.info/) + - Canada: [Digital Advertising Alliance of Canada](https://youradchoices.ca/) + - Europe: [European Digital Advertising Alliance](http://www.youronlinechoices.com/) + + These choices are specific to the browser you are using. If you access our Services from other devices or browsers, take these actions from those systems to ensure your choices apply to the data collected when you use those systems. + -「[Do Not Track](https://www.eff.org/issues/do-not-track)」(DNT) とは、オンラインサービスに対して、第三者のトラッキングサービスからお客様のオンライン活動についての特定の種類の情報を収集して共有することを望まない場合に、ブラウザで設定できるプライバシー設定です。 GitHubは、ブラウザのDNTシグナルに応答し、[DNTシグナルへの応答についてのW3C基準](https://www.w3.org/TR/tracking-dnt/)に従います。 トラッキングを望まないことを通知するようブラウザに対して設定したい場合、この通知を有効化する方法について、ブラウザのドキュメントをご確認ください。 [Privacy Badger](https://privacybadger.org/)など、トラッキングをブロックする良いアプリケーションもあります。 ## Retention of personal data We retain personal data for as long as necessary to provide the services and fulfill the transactions you have requested, comply with our legal obligations, resolve disputes, enforce our agreements, and other legitimate and lawful business purposes. Because these needs can vary for different data types in the context of different services, actual retention periods can vary significantly based on criteria such as user expectations or consent, the sensitivity of the data, the availability of automated controls that enable users to delete data, and our legal or contractual obligations. For example, we may retain your personal data for longer periods, where necessary, subject to applicable law, for security purposes. @@ -238,15 +291,11 @@ GitHub processes personal data both inside and outside of the United States and ### 苦情の解決 If you have concerns about the way GitHub is handling your personal data, please let us know immediately. 当社はお客様を手助けしたいと考えています。 お客様は、[プライバシー連絡フォーム](https://support.github.com/contact/privacy)に記入することで、当社に連絡できます。 You may also email us directly at **(privacy [at] github [dot] com)** with the subject line "Privacy Concerns." 当社は、遅くとも45日以内に速やかに返信します。 -お客様は、当社のデータ保護責任者に直接連絡することもできます。 +You may also contact our Data Protection Officer directly at at **github [at]dp-officer [dot] com** + +**If you are in North America:**
GitHub Data Protection Officer
88 Colin P. Kelly Jr. St.
San Francisco, CA 94107
United States
**privacy [at] github [dot] com**
-| 当社の米国本社 | 当社のEU事務所 | -| --------------------------------- | --------------------------------- | -| GitHub Data Protection Officer | GitHub BV | -| 88 Colin P. Kelly Jr. St. | Vijzelstraat 68-72 | -| San Francisco, CA 94107 | 1017 HL Amsterdam | -| 米国 | The Netherlands | -| **privacy [at] github [dot] com** | **privacy [at] github [dot] com** | +**If you are outside of North America:**
Github Data Protection Officer
c/o DP Dock DPO Services GmbH,
Attn: GitHub BV, Gut Projensdorf,
24161 Altenholz, Germany
github@dp-officer.com cc: **privacy [at] github [dot] com**
CC: GitHub BV, Vijzelstraat 68-72, 1017 HL Amsterdam, The Netherlands ### 紛争解決プロセス @@ -298,7 +347,7 @@ We use the categories of personal information described above for the purposes l CCPAの下では、カリフォルニア州住民の個人情報を他者に販売する企業は、1) 個人情報を他者に販売する前にカリフォルニア州住民に通知する義務があり、2) カリフォルニア州住民に個人情報の販売をオプトアウトする権利を与える義務があります。 GitHub does not sell personal information, including personal information of anyone under 16 years old. ### CCPAに基づくあなたの権利 -CCPAは、カリフォルニア州住民に、個人情報に関する特定の権利を付与します。 この権利に基づく請求を提出するには、[連絡フォーム](https://support.github.com/contact?tags=docs-policy)からご連絡ください。 +CCPAは、カリフォルニア州住民に、個人情報に関する特定の権利を付与します。 To submit a request based on these rights, please contact us via our [contact form](https://support.github.com/contact?tags=docs-policy). diff --git a/translations/ja-JP/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md b/translations/ja-JP/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md index 0e514db1d117..ea2b21b52fef 100644 --- a/translations/ja-JP/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md +++ b/translations/ja-JP/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md @@ -14,74 +14,23 @@ topics: - Legal --- -発効日:**2021年4月2日** +Effective date: **September 1, 2022** -{% note %} - -**Note:** Changes to the list of cookies on this page are currently pending. - -{% endnote %} GitHubは、お客様のデータを当社が利用する方法、お客様のデータを当社が収集する方法、およびお客様のデータを共有する対象について、高い透明性を提供します。 この目的のため、[当社のサブプロセッサ](#github-subprocessors)および[クッキー](#cookies-on-github)の使用方法ついて説明するページをご用意しました。 ## GitHubのサブプロセッサ -当社がお客様の情報を、ベンダーやサービスプロバイダなどのサードパーティーのサブプロセッサと共有する場合、それについては当社が責任を負います。 新たなベンダーとのやり取りを行う際に、当社はお客様の信頼を維持するため努力し、全てのベンダーに対して、 ユーザの個人情報 ([プライバシーについての声明](/articles/github-privacy-statement/)の定義による) に関する取り扱いを制限する、データ保護契約を締結するよう要求しています。 You can sign up to receive subprocessor list updates [here](https://www.github.com/privacy/subprocessors). +当社がお客様の情報を、ベンダーやサービスプロバイダなどのサードパーティーのサブプロセッサと共有する場合、それについては当社が責任を負います。 新たなベンダーとのやり取りを行う際に、当社はお客様の信頼を維持するため努力し、全てのベンダーに対して、 ユーザの個人情報 ([プライバシーについての声明](/articles/github-privacy-statement/)の定義による) に関する取り扱いを制限する、データ保護契約を締結するよう要求しています。 -| サブプロセッサ名 | 処理の内容 | 処理の場所 | 会社所在地 | -|:------------------------ |:--------------------------------- |:----- |:----- | -| Automattic | ブログサービス | 米国 | 米国 | -| AWS Amazon | データのホスティング | 米国 | 米国 | -| Braintree (PayPal) | プランのクレジットカード決済処理業者 | 米国 | 米国 | -| Clearbit | マーケティングデータのエンリッチメントサービス | 米国 | 米国 | -| Discourse | コミュニティフォーラムのソフトウェアプロバイダ | 米国 | 米国 | -| Eloqua | マーケティングキャンペーンの自動化 | 米国 | 米国 | -| Google Apps | 社内インフラストラクチャ | 米国 | 米国 | -| MailChimp | 顧客チケットメールサービスプロバイダ | 米国 | 米国 | -| Mailgun | トランザクションメールサービスプロバイダ | 米国 | 米国 | -| Microsoft | マイクロソフトサービス | 米国 | 米国 | -| Nexmo | SMS通知プロバイダ | 米国 | 米国 | -| Salesforce.com | 顧客関係管理 | 米国 | 米国 | -| Sentry.io | アプリケーション監視プロバイダ | 米国 | 米国 | -| Stripe | 決済プロバイダ | 米国 | 米国 | -| Twilio & Twilio Sendgrid | SMS通知プロバイダおよびトランザクションメールサービスプロバイダ | 米国 | 米国 | -| Zendesk | カスタマーサポートのチケットシステム | 米国 | 米国 | -| Zuora | 企業課金システム | 米国 | 米国 | +When we bring on a new subprocessor who handles our Users' Personal Information, or remove a subprocessor, or we change how we use a subprocessor, we will update the list of subprocessors. You can view the current list of subprocessors, and sign up to receive subprocessor list updates, at [https://www.github.com/privacy/subprocessors](https://www.github.com/privacy/subprocessors). -当社ユーザの個人情報を取り扱う新たなサブプロセッサとやり取りを始める際、サブプロセッサと解約する際、およびサブプロセッサの利用方法を変更する際は、このページを更新します。 新たなサブプロセッサについての質問や懸念がある場合は、 {% data variables.contact.contact_privacy %}からお気軽にお問い合わせください。 +新たなサブプロセッサについての質問や懸念がある場合は、 {% data variables.contact.contact_privacy %}からお気軽にお問い合わせください。 ## GitHubのCookie ウェブサイトを提供および保護し、ウェブサイトの利用状況を分析して優れたユーザエクスペリエンスを提供するために、GitHubはクッキーを使用します。 クッキーに関する詳細な情報や、その使用方法と理由について知りたい場合は、当社の[プライバシーについての声明](/github/site-policy/github-privacy-statement#our-use-of-cookies-and-tracking)を参照してください。 -クッキーの数や名前は変わることがあるため、以下の表も適時更新されることがあります。 - -| サービスプロバイダ | クッキーの名前 | 説明 | 有効期限* | -|:--------- |:------------------------------------ |:----------------------------------------------------------------------------------- |:---------------------------- | -| GitHub | `app_manifest_token` | このクッキーは、リダイレクト中のユーザセッションをフェッチし、フローの状態を維持するため、App Manifestフロー中に使用されます。 | 5分間 | -| GitHub | `color_mode` | このクッキーは、ユーザが選択したテーマ設定を示すために使用されます。 | セッション | -| GitHub | `_device_id` | このクッキーは、セキュリティ上の目的により、認識されたデバイスを追跡するために使用されます。 | 1年間 | -| GitHub | `dotcom_user` | このクッキーは、ユーザがすでにログインしていることを当社に通知するために使用されます。 | 1年間 | -| GitHub | `_gh_ent` | このクッキーは、お客様が複数のステップのうちどのステップにあるのかなど、一時アプリケーションおよびフレームワークにおけるページ間での状態を記録するために使用されます。 | 2週間 | -| GitHub | `_gh_sess` | このクッキーは、ユーザが複数のステップのうちどのステップにあるのかなど、一時アプリケーションおよびフレームワークにおけるページ間での状態を記録するために使用されます。 | セッション | -| GitHub | `gist_oauth_csrf` | このクッキーは、OAuthフローを開始したユーザが、それを完了したユーザと同一であることを保証するために、Gistによって設定されます。 | OAuth state の検証後に削除 | -| GitHub | `gist_user_session` | このクッキーは、別のホストで実行されている場合にGistによって使用されます。 | 2週間 | -| GitHub | `has_recent_activity` | このクッキーは、アプリケーションに最近アクセスしたユーザにセキュリティインタースティシャルを表示させないために使用されます。 | 1時間 | -| GitHub | `__Host-gist_user_session_same_site` | このクッキーは、SameSiteクッキーをサポートするブラウザが、リクエストがGitHubから発信されているかどうかを確認できるように設定されます。 | 2週間 | -| GitHub | `__Host-user_session_same_site` | このクッキーは、SameSiteクッキーをサポートするブラウザが、リクエストがGitHubから発信されているかどうかを確認できるように設定されます。 | 2週間 | -| GitHub | `logged_in` | このクッキーは、ユーザがすでにログインしていることを当社に通知するために使用されます。 | 1年間 | -| GitHub | `marketplace_repository_ids` | このクッキーは、Marketplaceのインストールフローに使用されます。 | 1時間 | -| GitHub | `marketplace_suggested_target_id` | このクッキーは、Marketplaceのインストールフローに使用されます。 | 1時間 | -| GitHub | `_octo` | このクッキーは、動的コンテンツのキャッシング、条件付き機能へのアクセス、サポートリクエストのメタデータ、ファーストパーティ分析などのセッション管理に使用されます。 | 1年間 | -| GitHub | `org_transform_notice` | このクッキーは、Organizationの変換時に通知を行うために使用されます。 | 1時間 | -| GitHub | `private_mode_user_session` | このクッキーは、Enterprise認証リクエストに使用されます。 | 2週間 | -| GitHub | `saml_csrf_token` | このクッキーは、トークンをクライアントに関連付けるために、SAML認証パスメソッドによって設定されます。 | ユーザがブラウザを閉じるか、認証リクエストを完了するまで | -| GitHub | `saml_csrf_token_legacy` | このクッキーは、トークンをクライアントに関連付けるために、SAML認証パスメソッドによって設定されます。 | ユーザがブラウザを閉じるか、認証リクエストを完了するまで | -| GitHub | `saml_return_to` | このクッキーは、SAML認証ループ時に、状態を維持するためSAML認証パスメソッドによって設定されます。 | ユーザがブラウザを閉じるか、認証リクエストを完了するまで | -| GitHub | `saml_return_to_legacy` | このクッキーは、SAML認証ループ時に、状態を維持するためSAML認証パスメソッドによって設定されます。 | ユーザがブラウザを閉じるか、認証リクエストを完了するまで | -| GitHub | `tz` | このクッキーを使用すると、タイムゾーンに合わせてタイムスタンプをカスタマイズできます。 | セッション | -| GitHub | `user_session` | このクッキーはログインに使用されます。 | 2週間 | - -_*_ 以下に挙げるクッキーの**有効期限**日は通常、随時適用されます。 +You can view the current list of cookies on GitHub, and sign up to receive cookie list updates, at [https://github.com/privacy/cookies](https://github.com/privacy/cookies). (!) 当社は第三者によるクッキーの使用を、外部コンテンツをレンダリングする際に必要な外部機能を提供するために必要なものに限って使用していますが、当社の特定のページにおいては第三者によるその他のクッキーが設置される場合があります。 たとえば、クッキーを設定するサイトから、動画などのコンテンツを埋め込むことがあります。 第三者のクッキーは最小限に保つよう努めていますが、当社は第三者のコンテンツが設定するクッキーを常に管理できるわけではありません。 diff --git a/translations/ja-JP/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md b/translations/ja-JP/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md index facad55b1430..1824ba49a98a 100644 --- a/translations/ja-JP/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md +++ b/translations/ja-JP/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md @@ -25,7 +25,7 @@ shortTitle: Sponsor a contributor You can sponsor an account on behalf of your personal account to invest in projects that you personally benefit from. Organization に代わってアカウントをスポンサーできますが、それには多くの理由があります。 - Organization の作業が依存する特定のライブラリを維持する -- Organization として依存しているエコシステム (たとえばブロックチェーン) に投資する +- Investing in the ecosystem you rely on as an organization (such as blockchain) - オープンソースを大切にする Organization としてブランド認知度を確立する - Organization が提供する製品を補完するライブラリを構築しているオープンソース開発者に感謝する diff --git a/translations/ja-JP/data/features/actions-hosted-runners.yml b/translations/ja-JP/data/features/actions-hosted-runners.yml new file mode 100644 index 000000000000..fcc88d707de7 --- /dev/null +++ b/translations/ja-JP/data/features/actions-hosted-runners.yml @@ -0,0 +1,5 @@ +#Reference: #6458 +#Larger GitHub-hosted runners +versions: + fpt: '*' + ghec: '*' diff --git a/translations/ja-JP/data/features/code-scanning-exclude-queries-from-analysis.yml b/translations/ja-JP/data/features/code-scanning-exclude-queries-from-analysis.yml new file mode 100644 index 000000000000..2157533a6d34 --- /dev/null +++ b/translations/ja-JP/data/features/code-scanning-exclude-queries-from-analysis.yml @@ -0,0 +1,7 @@ +#Issue 7617 +#Users can easily exclude CodeQL queries from code scanning analyses - [GA] +versions: + fpt: '*' + ghec: '*' + ghes: '>3.6' + ghae: 'issue-7617' diff --git a/translations/ja-JP/data/features/dependency-review-action-ghes.yml b/translations/ja-JP/data/features/dependency-review-action-ghes.yml new file mode 100644 index 000000000000..2d8bca37f3b4 --- /dev/null +++ b/translations/ja-JP/data/features/dependency-review-action-ghes.yml @@ -0,0 +1,4 @@ +#Reference: Issue #7753 Dependency review action has shipped with GHES 3.6 and needs admin docs +versions: + ghes: '>3.5' + ghae: 'issue-7753' diff --git a/translations/ja-JP/data/features/packages-npm-v2.yml b/translations/ja-JP/data/features/packages-npm-v2.yml new file mode 100644 index 000000000000..572e412e4a45 --- /dev/null +++ b/translations/ja-JP/data/features/packages-npm-v2.yml @@ -0,0 +1,5 @@ +#Issue 7039 +#npm Package Registry Improvements (v2) GA +versions: + fpt: '*' + ghec: '*' diff --git a/translations/ja-JP/data/features/streaming-datadog.yml b/translations/ja-JP/data/features/streaming-datadog.yml new file mode 100644 index 000000000000..ab90546c8d4e --- /dev/null +++ b/translations/ja-JP/data/features/streaming-datadog.yml @@ -0,0 +1,4 @@ +#Reference #7495 +#Documentation for audit log streaming to a Datadog endpoint +versions: + ghec: '*' diff --git a/translations/ja-JP/data/learning-tracks/admin.yml b/translations/ja-JP/data/learning-tracks/admin.yml index a7aa266e929f..23816673a1ff 100644 --- a/translations/ja-JP/data/learning-tracks/admin.yml +++ b/translations/ja-JP/data/learning-tracks/admin.yml @@ -120,6 +120,7 @@ configure_github_advanced_security: - /admin/advanced-security/about-licensing-for-github-advanced-security - /admin/advanced-security/enabling-github-advanced-security-for-your-enterprise - /admin/advanced-security/configuring-code-scanning-for-your-appliance + - /admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-dependency-review-for-your-appliance - /admin/advanced-security/configuring-secret-scanning-for-your-appliance - /admin/policies/enforcing-policies-for-advanced-security-in-your-enterprise diff --git a/translations/ja-JP/data/release-notes/enterprise-server/3-2/18.yml b/translations/ja-JP/data/release-notes/enterprise-server/3-2/18.yml new file mode 100644 index 000000000000..0355db5ed329 --- /dev/null +++ b/translations/ja-JP/data/release-notes/enterprise-server/3-2/18.yml @@ -0,0 +1,16 @@ +date: '2022-08-30' +sections: + bugs: + - 重複したSSHキーがManagement Consoleと`/home/admin/.ssh/authorized_keys`ファイルの両方に現れることがあります。 + - スレッドセーフではないにもかかわらず並行に使われたライブラリのために、バックグラウンドタスクが停止する場合があります。 + changes: + - 並列化されたログのサニタイズの結果、Support Bundleの生成が速くなりました。Support Bundleに関する詳しい情報については「[GitHub Supportへのデータ提供](/support/contacting-github-support/providing-data-to-github-support)」を参照してください。 + known_issues: + - 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。 + - アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。 + - Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。 + - 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。 + - '{% data variables.product.prodname_github_connect %}で"Users can search GitHub.com(ユーザはGitHub.comの検索が可能)" が有効化されたとき、プライベート及びインターナルリポジトリのIssueが{% data variables.product.prodname_dotcom_the_website %}の検索結果に含まれません。' + - '{% data variables.product.prodname_registry %}のnpmレジストリは、メタデータのレスポンス中で時間の値を返さなくなります。これは、大きなパフォーマンス改善のために行われました。メタデータレスポンスの一部として時間の値を返すために必要なすべてのデータは保持し続け、既存のパフォーマンスの問題を解決した将来に、この値を返すことを再開します。' + - pre-receive フックの処理に固有のリソース制限によって、pre-receive フックに失敗するものが生じることがあります。 + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/ja-JP/data/release-notes/enterprise-server/3-3/13.yml b/translations/ja-JP/data/release-notes/enterprise-server/3-3/13.yml new file mode 100644 index 000000000000..1c2f2ee38521 --- /dev/null +++ b/translations/ja-JP/data/release-notes/enterprise-server/3-3/13.yml @@ -0,0 +1,23 @@ +date: '2022-08-30' +sections: + bugs: + - リポジトリを一時的なアクセスのためにロック解除したあと、サイト管理者はそのリポジトリ中のセキュリティ製品の設定を管理できませんでした。 + - 重複したSSHキーがManagement Consoleと`/home/admin/.ssh/authorized_keys`ファイルの両方に現れることがあります。 + - '`ghe-cluster-config-apply`を実行すると、クラスタ内の既存ノードに空の設定がレプリケーションされることがありました。' + - '`ghe-config-apply`で開始された設定の実行か完了しなかったり、あるいは`Container count mismatch`エラーを返したりすることがありました。' + - GitHub Enterprise Serverインスタンス上の自己署名TLS署名書を更新したあと、Webインターフェースの一部のページのUI要素が表示されませんでした。 + - スレッドセーフではないにもかかわらず並行に使われたライブラリのために、バックグラウンドタスクが停止する場合があります。 + changes: + - 並列化されたログのサニタイズの結果、Support Bundleの生成が速くなりました。Support Bundleに関する詳しい情報については「[GitHub Supportへのデータ提供](/support/contacting-github-support/providing-data-to-github-support)」を参照してください。 + - 'Enterprise Audit logには、`project.create`といったより多くのユーザ生成イベントが含まれるようになりました。REST APIも、`repo.create`といった追加のユーザ生成イベントを返します。詳しい情報については「[EnterpriseのAudit logへのアクセス](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)」及び「[EnterpriseでのAudit log APIの利用](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise#querying-the-audit-log-rest-api)」を参照してください。' + known_issues: + - '{% data variables.product.prodname_ghe_server %} 3.3にアップグレード後、{% data variables.product.prodname_actions %}が自動起動に失敗することがあります。この問題を解決するためには、アプライアンスにSSHで接続し、`ghe-actions-start`コマンドを実行してください。' + - 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。 + - アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。 + - Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。 + - 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。 + - '{% data variables.product.prodname_github_connect %}で"Users can search GitHub.com(ユーザはGitHub.comの検索が可能)" が有効化されたとき、プライベート及びインターナルリポジトリのIssueが{% data variables.product.prodname_dotcom_the_website %}の検索結果に含まれません。' + - '{% data variables.product.prodname_registry %}のnpmレジストリは、メタデータのレスポンス中で時間の値を返さなくなります。これは、大きなパフォーマンス改善のために行われました。メタデータレスポンスの一部として時間の値を返すために必要なすべてのデータは保持し続け、既存のパフォーマンスの問題を解決した将来に、この値を返すことを再開します。' + - pre-receive フックの処理に固有のリソース制限によって、pre-receive フックに失敗するものが生じることがあります。 + - '{% data variables.product.prodname_actions %}のストレージ設定は、"Force Path Style(パススタイルの強制)"が選択されている場合、検証できず{% data variables.enterprise.management_console %}に保存できません。その代わりに、`ghe-actions-precheck`コマンドラインユーティリティで設定しなければなりません。' + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/ja-JP/data/release-notes/enterprise-server/3-4/8.yml b/translations/ja-JP/data/release-notes/enterprise-server/3-4/8.yml new file mode 100644 index 000000000000..8ab888503fd9 --- /dev/null +++ b/translations/ja-JP/data/release-notes/enterprise-server/3-4/8.yml @@ -0,0 +1,26 @@ +date: '2022-08-30' +sections: + bugs: + - リポジトリを一時的なアクセスのためにロック解除したあと、サイト管理者はそのリポジトリ中のセキュリティ製品の設定を管理できませんでした。 + - 重複したSSHキーがManagement Consoleと`/home/admin/.ssh/authorized_keys`ファイルの両方に現れることがあります。 + - http(s)://HOSTNAME/stafftools/users/USERNAME/adminにある個人ユーザのためのサイトアドミンページに、GitHub Enterprise Serverのためのものではない機能が含まれていました。 + - '`ghe-cluster-config-apply`を実行すると、クラスタ内の既存ノードに空の設定がレプリケーションされることがありました。' + - '`ghe-config-apply`で開始された設定の実行か完了しなかったり、あるいは`Container count mismatch`エラーを返したりすることがありました。' + - GitHub Enterprise Serverインスタンス上の自己署名TLS署名書を更新したあと、Webインターフェースの一部のページのUI要素が表示されませんでした。 + - スレッドセーフではないにもかかわらず並行に使われたライブラリのために、バックグラウンドタスクが停止する場合があります。 + changes: + - 並列化されたログのサニタイズの結果、Support Bundleの生成が速くなりました。Support Bundleに関する詳しい情報については「[GitHub Supportへのデータ提供](/support/contacting-github-support/providing-data-to-github-support)」を参照してください。 + - '`organization`または`org`ルートを含むAPIは、OrganizationのスラグもしくはIDのいずれかを受け付けるようになりました。以前はAPIはスラグだけを受け付け、そのためにGitHub Advanced Securityのエンドポイントの`Link`ヘッダにはアクセスできなくなっていました。詳しい情報についてはREST APIドキュメンテーションの「[Organizations](https://docs.github.com/rest/orgs/orgs)」を参照してください。' + - 'Enterprise Audit logには、`project.create`といったより多くのユーザ生成イベントが含まれるようになりました。REST APIも、`repo.create`といった追加のユーザ生成イベントを返します。詳しい情報については「[EnterpriseのAudit logへのアクセス](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)」及び「[EnterpriseでのAudit log APIの利用](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise#querying-the-audit-log-rest-api)」を参照してください。' + known_issues: + - 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。 + - アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。 + - Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。 + - 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。 + - '{% data variables.product.prodname_github_connect %}で"Users can search GitHub.com(ユーザはGitHub.comの検索が可能)" が有効化されたとき、プライベート及びインターナルリポジトリのIssueが{% data variables.product.prodname_dotcom_the_website %}の検索結果に含まれません。' + - '{% data variables.product.prodname_registry %}のnpmレジストリは、メタデータのレスポンス中で時間の値を返さなくなります。これは、大きなパフォーマンス改善のために行われました。メタデータレスポンスの一部として時間の値を返すために必要なすべてのデータは保持し続け、既存のパフォーマンスの問題を解決した将来に、この値を返すことを再開します。' + - pre-receive フックの処理に固有のリソース制限によって、pre-receive フックに失敗するものが生じることがあります。 + - | + セルフホストランナーを--ephemeral`パラメータ付きで複数レベル(たとえばEnterpriseとOrganizationというように)に登録したあと、ランナーがアイドル状態で停止し、再登録が必要になることがあります。[更新: 2022年6月17日] + - '{% data variables.product.prodname_ghe_server %} 3.4にアップグレードしたあと、リリースがリポジトリから失われたように見えることがあります。これは、必要なElasticsearchのインデックスの移行が成功終了していない場合に起こります。' + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/ja-JP/data/release-notes/enterprise-server/3-5/5.yml b/translations/ja-JP/data/release-notes/enterprise-server/3-5/5.yml new file mode 100644 index 000000000000..3928c144412f --- /dev/null +++ b/translations/ja-JP/data/release-notes/enterprise-server/3-5/5.yml @@ -0,0 +1,27 @@ +date: '2022-08-30' +sections: + bugs: + - リポジトリを一時的なアクセスのためにロック解除したあと、サイト管理者はそのリポジトリ中のセキュリティ製品の設定を管理できませんでした。 + - 重複したSSHキーがManagement Consoleと`/home/admin/.ssh/authorized_keys`ファイルの両方に現れることがあります。 + - http(s)://HOSTNAME/stafftools/users/USERNAME/adminにある個人ユーザのためのサイトアドミンページに、GitHub Enterprise Serverのためのものではない機能が含まれていました。 + - '`ghe-cluster-config-apply`を実行すると、クラスタ内の既存ノードに空の設定がレプリケーションされることがありました。' + - '`ghe-config-apply`で開始された設定の実行か完了しなかったり、あるいは`Container count mismatch`エラーを返したりすることがありました。' + - GitHub Enterprise Serverインスタンス上の自己署名TLS署名書を更新したあと、Webインターフェースの一部のページのUI要素が表示されませんでした。 + - Webインターフェースの上部のサイトアドミンバーが、実行中のアプリケーションのバージョンのSHAへの壊れたリンクを含んでいました。 + - スレッドセーフではないにもかかわらず並行に使われたライブラリのために、バックグラウンドタスクが停止する場合があります。 + - サイト管理者がGitHub Enterprise Server 3.4に直接アップグレードしていない場合、GitHub Advanced Securityのお客様に対するSecret scanningのアラートがWeb UI及びREST APIから欠落していました。これらのアラートは表示されるようになりました。 + - ユーザがOrganizationにリポジトリをフォークしたとき、Organizationの長いリストは正しく表示されません。 + changes: + - 並列化されたログのサニタイズの結果、Support Bundleの生成が速くなりました。Support Bundleに関する詳しい情報については「[GitHub Supportへのデータ提供](/support/contacting-github-support/providing-data-to-github-support)」を参照してください。 + - '`organization`または`org`ルートを含むAPIは、OrganizationのスラグもしくはIDのいずれかを受け付けるようになりました。以前はAPIはスラグだけを受け付け、そのためにGitHub Advanced Securityのエンドポイントの`Link`ヘッダにはアクセスできなくなっていました。詳しい情報についてはREST APIドキュメンテーションの「[Organizations](https://docs.github.com/rest/orgs/orgs)」を参照してください。' + - 'Enterprise Audit logには、`project.create`といったより多くのユーザ生成イベントが含まれるようになりました。REST APIも、`repo.create`といった追加のユーザ生成イベントを返します。詳しい情報については「[EnterpriseのAudit logへのアクセス](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)」及び「[EnterpriseでのAudit log APIの利用](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise#querying-the-audit-log-rest-api)」を参照してください。' + - 最近更新されたリポジトリで、キャッシュレプリカが一部のGit操作を拒否することがありました。リポジトリキャッシングに関する詳しい情報については「[リポジトリキャッシングについて](/admin/enterprise-management/caching-repositories/about-repository-caching)」を参照してください。 + known_issues: + - 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。 + - アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。 + - Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。 + - 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。 + - GitHub Connectで"Users can search GitHub.com"が有効化されている場合、GitHub.comの検索結果にプライベート及びインターナルリポジトリのIssueが含まれません。 + - '{% data variables.product.prodname_registry %}のnpmレジストリは、メタデータのレスポンス中で時間の値を返さなくなります。これは、大きなパフォーマンス改善のために行われました。メタデータレスポンスの一部として時間の値を返すために必要なすべてのデータは保持し続け、既存のパフォーマンスの問題を解決した将来に、この値を返すことを再開します。' + - pre-receive フックの処理に固有のリソース制限によって、pre-receive フックに失敗するものが生じることがあります。 + - 別のホスト上で取られたバックアップからのアプライアンスのリストア後、Actionsサービスを再起動する必要があります。 diff --git a/translations/ja-JP/data/release-notes/enterprise-server/3-6/0.yml b/translations/ja-JP/data/release-notes/enterprise-server/3-6/0.yml index acc5767185f9..6af971dc733a 100644 --- a/translations/ja-JP/data/release-notes/enterprise-server/3-6/0.yml +++ b/translations/ja-JP/data/release-notes/enterprise-server/3-6/0.yml @@ -25,7 +25,9 @@ sections: -「[Enterpriseでのリポジトリ管理ポリシーの施行](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)」 -「[インスタンスのホストキーの設定](/admin/configuration/configuring-your-enterprise/configuring-host-keys-for-your-instance)」 - | - インスタンスに接続してくるSMTPコネクションにTLS暗号化を要求できます。詳しい情報については「[通知のメールの設定](/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications)」を参照してください。 + インスタンスへのSMTP接続にTLS暗号化を必須とすることができます。詳しい情報については「[通知のためのメールの設定](/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications#enforcing-tls-for-smtp-connections)」を参照してください。 + + -**ノート**: この機能はGitHub Enterprise Server 3.6.0では利用できません。この機能は今後のリリースで利用できるようになります。[更新: 2022 年8月26日] - heading: 監査ログ notes: @@ -210,3 +212,4 @@ sections: - リポジトリの設定で、読み取りアクセスを持つユーザにディスカッションの作成を許可するオプションを有効化しても、この機能は有効化されません。 - ユーザが既存のIssueをディスカッションに変換できないことがあります。 - Secret scanningのカスタムパターンは、特に"After secret"パターンにおいて`.*`を終了の区切り文字として持ちます。この区切り文字は、リポジトリにまたがるシークレットのスキャンにおいて矛盾を生じさせ、スキャンがまったく完了していないというリポジトリの履歴のギャップに気づくかもしれません。インクリメンタルなスキャンにも影響があるかもしれません。スキャンの問題を回避するために、パターンの終わりから`.*`という区切り文字を取り除く修正をしてください。 + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/ja-JP/data/release-notes/enterprise-server/3-6/1.yml b/translations/ja-JP/data/release-notes/enterprise-server/3-6/1.yml new file mode 100644 index 000000000000..2a1fba924fe8 --- /dev/null +++ b/translations/ja-JP/data/release-notes/enterprise-server/3-6/1.yml @@ -0,0 +1,33 @@ +date: '2022-08-30' +sections: + bugs: + - リポジトリを一時的なアクセスのためにロック解除したあと、サイト管理者はそのリポジトリ中のセキュリティ製品の設定を管理できませんでした。 + - 重複したSSHキーがManagement Consoleと`/home/admin/.ssh/authorized_keys`ファイルの両方に現れることがあります。 + - http(s)://HOSTNAME/stafftools/users/USERNAME/adminにある個人ユーザのためのサイトアドミンページに、GitHub Enterprise Serverのためのものではない機能が含まれていました。 + - '`ghe-cluster-config-apply`を実行すると、クラスタ内の既存ノードに空の設定がレプリケーションされることがありました。' + - '`ghe-config-apply`で開始された設定の実行か完了しなかったり、あるいは`Container count mismatch`エラーを返したりすることがありました。' + - GitHub Enterprise Serverインスタンス上の自己署名TLS署名書を更新したあと、Webインターフェースの一部のページのUI要素が表示されませんでした。 + - スレッドセーフではないにもかかわらず並行に使われたライブラリのために、バックグラウンドタスクが停止する場合があります。 + - Webインターフェースの上部のサイトアドミンバーが、実行中のアプリケーションのバージョンのSHAへの壊れたリンクを含んでいました。 + - Organizationオーナーは、ディスカッションの作成に必要なアクセスレベルを設定できませんでした。 + - ディスカッションのユーザは、GitHub.comのコミュニティガイドラインに誤って誘導されました。 + - ディスカッションの作成前に、ユーザは誤ってメールを検証するよう指示されることがありました。 + - サイト管理者がGitHub Enterprise Server 3.4に直接アップグレードしていない場合、GitHub Advanced Securityのお客様に対するSecret scanningのアラートがWeb UI及びREST APIから欠落していました。これらのアラートは表示されるようになりました。 + changes: + - 並列化されたログのサニタイズの結果、Support Bundleの生成が速くなりました。Support Bundleに関する詳しい情報については「[GitHub Supportへのデータ提供](/support/contacting-github-support/providing-data-to-github-support)」を参照してください。 + - '`organization`または`org`ルートを含むAPIは、OrganizationのスラグもしくはIDのいずれかを受け付けるようになりました。以前はAPIはスラグだけを受け付け、そのためにGitHub Advanced Securityのエンドポイントの`Link`ヘッダにはアクセスできなくなっていました。詳しい情報についてはREST APIドキュメンテーションの「[Organizations](https://docs.github.com/rest/orgs/orgs)」を参照してください。' + - 'Enterprise Audit logには、`project.create`といったより多くのユーザ生成イベントが含まれるようになりました。REST APIも、`repo.create`といった追加のユーザ生成イベントを返します。詳しい情報については「[EnterpriseのAudit logへのアクセス](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)」及び「[EnterpriseでのAudit log APIの利用](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise#querying-the-audit-log-rest-api)」を参照してください。' + - 最近更新されたリポジトリで、キャッシュレプリカが一部のGit操作を拒否することがありました。リポジトリキャッシングに関する詳しい情報については「[リポジトリキャッシングについて](/admin/enterprise-management/caching-repositories/about-repository-caching)」を参照してください。 + - 'REST APIを使ったグローバルアナウンスのバナーの却下を可能にするよう設定できるようになりました。詳しい情報については「[Enterpriseでのユーザメッセージのカスタマイズ](/admin/user-management/managing-users-in-your-enterprise/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner)」を参照してください。' + known_issues: + - 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。 + - アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。 + - Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。 + - 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。 + - GitHub Connectで"Users can search GitHub.com"が有効化されている場合、GitHub.comの検索結果にプライベート及びインターナルリポジトリのIssueが含まれません。 + - '{% data variables.product.prodname_registry %}のnpmレジストリは、メタデータのレスポンス中で時間の値を返さなくなります。これは、大きなパフォーマンス改善のために行われました。メタデータレスポンスの一部として時間の値を返すために必要なすべてのデータは保持し続け、既存のパフォーマンスの問題を解決した将来に、この値を返すことを再開します。' + - pre-receive フックの処理に固有のリソース制限によって、pre-receive フックに失敗するものが生じることがあります。 + - 他のホストで取られたバックアップからインスタンスを復元したあと、Actionsサービスは再起動する必要があります。 + - リポジトリの設定で、読み取りアクセスを持つユーザにディスカッションの作成を許可するオプションを有効化しても、この機能は有効化されません。 + - ユーザが既存のIssueをディスカッションに変換できないことがあります。 + - Secret scanningのカスタムパターンは、特に"After secret"パターンにおいて`.*`を終了の区切り文字として持ちます。この区切り文字は、リポジトリにまたがるシークレットのスキャンにおいて矛盾を生じさせ、スキャンがまったく完了していないというリポジトリの履歴のギャップに気づくかもしれません。インクリメンタルなスキャンにも影響があるかもしれません。スキャンの問題を回避するために、パターンの終わりから`.*`という区切り文字を取り除く修正をしてください。 diff --git a/translations/ja-JP/data/reusables/accounts/create-personal-access-tokens.md b/translations/ja-JP/data/reusables/accounts/create-personal-access-tokens.md index 2f21f547ddb9..fef12d84ddb7 100644 --- a/translations/ja-JP/data/reusables/accounts/create-personal-access-tokens.md +++ b/translations/ja-JP/data/reusables/accounts/create-personal-access-tokens.md @@ -1 +1 @@ -1. For each of your accounts, create a dedicated PAT with `repo` scope. 詳しい情報については、「[個人アクセストークンを作成する](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)」を参照してください。 \ No newline at end of file +1. 各アカウントに`repo`スコープを持つ専用のPATを作成してください。 詳しい情報については、「[個人アクセストークンを作成する](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)」を参照してください。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/actions/about-runner-groups.md b/translations/ja-JP/data/reusables/actions/about-runner-groups.md new file mode 100644 index 000000000000..61c01f3c830f --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/about-runner-groups.md @@ -0,0 +1,18 @@ +{% ifversion fpt %} +{% note %} + +**ノート:** すべてのOrganizationは1つのデフォルトランナーグループを持ちます。 Enterpriseアカウント及びEnterpriseアカウントが所有するOrganizationだけが、追加のランナーグループを作成して管理できます。 + +{% endnote %} + +ランナーグループは、ランナーへのアクセスを制御するために使われます。 Organization の管理者は、Organization 内のどのリポジトリがランナーグループにアクセスできるかを制御するアクセスポリシーを設定できます。 + +{% data variables.product.prodname_ghe_cloud %}を使っているなら、追加のランナーグループを作成できます。Enterpriseの管理者は、Enterprise内でランナーグループにアクセスできるOrganizationを制御するアクセスポリシーを設定でき、Organizationの管理者は、Enterpriseランナーグループに追加の詳細なリポジトリアクセスポリシーを割り当てる事ができます。 +{% endif -%} +{% ifversion ghec or ghes or ghae %} + +{% data reusables.actions.runner-group-enterprise-overview %} + +新しいランナーが作成されると、それらは自動的にデフォルトグループに割り当てられます。 ランナーは一度に1つのグループにのみ参加できます。 ランナーはデフォルトグループから別のグループに移動できます。 詳しい情報については「[ランナーのグループへの移動](#moving-a-runner-to-a-group)」を参照してください。 + +{% endif %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/actions/actions-billing.md b/translations/ja-JP/data/reusables/actions/actions-billing.md index 157e667d264e..c1efc3814ccb 100644 --- a/translations/ja-JP/data/reusables/actions/actions-billing.md +++ b/translations/ja-JP/data/reusables/actions/actions-billing.md @@ -1 +1 @@ -{% data variables.product.prodname_actions %} パブリックリポジトリとセルフホストランナーでは、どちらも利用は無料です。 プライベートリポジトリでは、それぞれの{% data variables.product.prodname_dotcom %}アカウントは使用している製品に応じて一定量の無料の分とストレージを受け取ります。 含まれる金額を超える利用については、支出制限によって管理されます。 +{% data variables.product.prodname_actions %}の利用は、パブリックリポジトリにおける標準の{% data variables.product.prodname_dotcom %}ホストランナーと、セルフホストランナーでは無料です。 プライベートリポジトリでは、それぞれの{% data variables.product.prodname_dotcom %}アカウントは使用している製品に応じて{% data variables.product.prodname_dotcom %}ホストランナーで利用できる一定量の無料の分とストレージを受け取ります。 含まれる金額を超える利用については、支出制限によって管理されます。 diff --git a/translations/ja-JP/data/reusables/actions/add-hosted-runner-overview.md b/translations/ja-JP/data/reusables/actions/add-hosted-runner-overview.md new file mode 100644 index 000000000000..b382211eab77 --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/add-hosted-runner-overview.md @@ -0,0 +1,3 @@ +利用可能な選択肢のリストから、オペレーティングシステムとハードウェア構成を選択できます。 このランナーの新しいインスタンスが自動スケーリングを通じてデプロイされると、それらはここで定義したのと同じオペレーティングシステムとハードウェア設定を使用します。 + +ランナーを特定するラベルを定義することもできます。これは、ワークフローが処理のためにランナーにジョブを送信できる方法です(`runs-on`を利用)。 新しいランナーは自動的にデフォルトグループに割り当てられるか、ランナーの作成プロセスの過程でランナーが参加するグループを選択することができます。 加えて、ランナーを登録したあとにランナーのグループメンバーシップを変更できます。 詳しい情報については「[{% data variables.actions.hosted_runner %}へのアクセスの制御](/actions/using-github-hosted-runners/controlling-access-to-larger-runners)」を参照してください。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/actions/add-hosted-runner.md b/translations/ja-JP/data/reusables/actions/add-hosted-runner.md new file mode 100644 index 000000000000..b94ed1df1345 --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/add-hosted-runner.md @@ -0,0 +1,11 @@ +1. **New runner(新規ランナー)**をクリックし、続いて**{% octicon "mark-github" aria-label="New hosted runner" %} New Github-hosted runner(新規GitHubホストランナー)**をクリックしてください。 +1. 新しいランナーを設定するために必要な詳細を入力してください。 + + - **Name(名前)**: 新しいランナーの名前を入力してください。 識別しやすいように、これは`ubuntu-20.04-16core`というように、ハードウェアとオペレーティングシステムの構成を示すようにすべきです。 + - **Runner image(ランナーイメージ)**: 利用可能な選択肢からオペレーティングシステムを選択してください。 オペレーティングシステムを選択すると、特定のバージョンを選択できるようになります。 + - **Runner size(ランナーサイズ)**: 利用可能な選択肢のドロップダウンリストから、ハードウェア構成を選択してください。 + - **Auto-scaling(オートスケーリング)**: いつでもアクティブにできるランナーの最大数を選択してください。 + - **Runner group(ランナーグループ)**: ランナーがメンバーになるグループを選択してください。 ランナーは要求に合わせてスケールアップやダウンをするので、このグループはランナーの複数のインスタンスをホストすることになります。 + - **Networking(ネットワーキング)**: {% data variables.product.prodname_ghe_cloud %}の場合のみ: {% data variables.actions.hosted_runner %}のインスタンスに静的IPアドレスの範囲が割り当てられるかどうかを選択してください。 合計で最大10個の静的IPアドレスを使用できます。 + +1. **Create runner(ランナーを作成)**をクリックしてください。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/actions/automatically-adding-a-runner-to-a-group.md b/translations/ja-JP/data/reusables/actions/automatically-adding-a-runner-to-a-group.md new file mode 100644 index 000000000000..8d37492757e1 --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/automatically-adding-a-runner-to-a-group.md @@ -0,0 +1,11 @@ +設定スクリプトを使って、自動的に新しいランナーをグループに追加できます。 たとえば、このコマンドは新しいランナーを登録し、 `--runnergroup`パラメータを使ってそのランナーを`rg-runnergroup`という名前のグループに追加します。 + +```sh +./config.sh --url $org_or_enterprise_url --token $token --runnergroup rg-runnergroup +``` + +このコマンドは、ランナーグループが存在しなければ失敗します。 + +``` +Could not find any self-hosted runner group named "rg-runnergroup". +``` \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/actions/changing-the-access-policy-of-a-runner-group.md b/translations/ja-JP/data/reusables/actions/changing-the-access-policy-of-a-runner-group.md new file mode 100644 index 000000000000..2cfc450dbe48 --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/changing-the-access-policy-of-a-runner-group.md @@ -0,0 +1,38 @@ +{% comment %} + +この手順の上には、必ずセキュリティの警告を含めてください。 これは、コンテキストがセルフホストランナーなのか、大きなランナーなのかによって、以下のいずれかになります。 + +{% data reusables.actions.self-hosted-runner-security-admonition %} +{% data reusables.actions.hosted-runner-security-admonition %} + +{% endcomment %} + +Enterprise内のランナーグループに対しては、Enterprise内のどのOrganizationがランナーグループにアクセスできるか{% ifversion restrict-groups-to-workflows %}、あるいはランナーグループが実行できるワークフローの制限{% endif %}を変更できます。 Organization内のランナーグループに対しては、Organization内のどのリポジトリがランナーグループにアクセスできるか{% ifversion restrict-groups-to-workflows %}、あるいはランナーグループが実行できるワークフローの制限{% endif %}を変更できます。 + +### ランナーグループにアクセスできるOrganizationあるいはリポジトリの変更 + +{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %} +{% data reusables.actions.runner-groups-navigate-to-repo-org-enterprise %} +{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %} +1. Enterprise内のランアーグループについては、**Organization access(Organizationのアクセス)**の下で、ランナーグループにアクセスできるOrganizationを変更してください。 Organization内のランナーグループについては、**Repository access(リポジトリアクセス)**の下で、ランナーグループにアクセスできるリポジトリを変更してください。 + +{% elsif ghae or ghes < 3.4 %} +{% data reusables.actions.configure-runner-group-access %} +{% endif %} + +{% ifversion restrict-groups-to-workflows %} +### Changing what workflows can access a runner group +You can configure a runner group to run either selected workflows or all workflows. For example, you might use this setting to protect secrets that are stored on runners or to standardize deployment workflows by restricting a runner group to run only a specific reusable workflow. This setting cannot be overridden if you are configuring an organization's runner group that was shared by an enterprise. +{% data reusables.actions.runner-groups-navigate-to-repo-org-enterprise %} +{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %} +1. Under **Workflow access**, select the dropdown menu and click **Selected workflows**. +1. {% octicon "gear" aria-label="the gear icon" %} をクリックします。 +1. Enter a comma separated list of the workflows that can access the runner group. Use the full path, including the repository name and owner. Pin the workflow to a branch, tag, or full SHA. 例: `octo-org/octo-repo/.github/workflows/build.yml@v2, octo-org/octo-repo/.github/workflows/deploy.yml@d6dc6c96df4f32fa27b039f2084f576ed2c5c2a5, monalisa/octo-test/.github/workflows/test.yml@main` + + Only jobs directly defined within the selected workflows will have access to the runner group. + + Organization-owned runner groups cannot access workflows from a different organization in the enterprise; instead, you must create an enterprise-owned runner group. + +1. [**Save**] をクリックします。 + +{% endif %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/actions/changing-the-name-of-a-runner-group.md b/translations/ja-JP/data/reusables/actions/changing-the-name-of-a-runner-group.md new file mode 100644 index 000000000000..0c97c37769aa --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/changing-the-name-of-a-runner-group.md @@ -0,0 +1,9 @@ +{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %} +{% data reusables.actions.runner-groups-navigate-to-repo-org-enterprise %} +{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %} +1. Change the runner group name. + +{% elsif ghae or ghes < 3.4 %} +{% data reusables.actions.configure-runner-group %} +1. Change the runner group name. +{% endif %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/actions/self-hosted-runner-configure-runner-group-access.md b/translations/ja-JP/data/reusables/actions/configure-runner-group-access.md similarity index 87% rename from translations/ja-JP/data/reusables/actions/self-hosted-runner-configure-runner-group-access.md rename to translations/ja-JP/data/reusables/actions/configure-runner-group-access.md index afab34d35031..474e187b5023 100644 --- a/translations/ja-JP/data/reusables/actions/self-hosted-runner-configure-runner-group-access.md +++ b/translations/ja-JP/data/reusables/actions/configure-runner-group-access.md @@ -1,4 +1,4 @@ -{% data reusables.actions.self-hosted-runner-configure-runner-group %} +{% data reusables.actions.configure-runner-group %} 1. ポリシーオプションを変更してください。 {% ifversion not ghae %} diff --git a/translations/ja-JP/data/reusables/actions/self-hosted-runner-configure-runner-group.md b/translations/ja-JP/data/reusables/actions/configure-runner-group.md similarity index 100% rename from translations/ja-JP/data/reusables/actions/self-hosted-runner-configure-runner-group.md rename to translations/ja-JP/data/reusables/actions/configure-runner-group.md diff --git a/translations/ja-JP/data/reusables/actions/self-hosted-runner-create-group.md b/translations/ja-JP/data/reusables/actions/create-runner-group.md similarity index 100% rename from translations/ja-JP/data/reusables/actions/self-hosted-runner-create-group.md rename to translations/ja-JP/data/reusables/actions/create-runner-group.md diff --git a/translations/ja-JP/data/reusables/actions/creating-a-runner-group-for-an-enterprise.md b/translations/ja-JP/data/reusables/actions/creating-a-runner-group-for-an-enterprise.md new file mode 100644 index 000000000000..f7081300167a --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/creating-a-runner-group-for-an-enterprise.md @@ -0,0 +1,28 @@ +{% comment %} + +Always include a security admonition above this procedure. This is either one of the following, depending on whether the context is self-hosted runners or larger runners. + +{% data reusables.actions.self-hosted-runner-security-admonition %} +{% data reusables.actions.hosted-runner-security-admonition %} + +{% endcomment %} + +Enterprises can add their runners to groups for access management. Enterprises can create groups of runners that are accessible to specific organizations in the enterprise account{% ifversion restrict-groups-to-workflows %} or to specific workflows{% endif %}. Organization owners can then assign additional granular repository{% ifversion restrict-groups-to-workflows %} or workflow{% endif %} access policies to the enterprise runner groups. For information about how to create a runner group with the REST API, see the enterprise endpoints in the [{% data variables.product.prodname_actions %} REST API](/rest/reference/actions#self-hosted-runner-groups). + +Runners are automatically assigned to the default group when created, and can only be members of one group at a time. 登録処理中にランナーを特定のグループに割り当てることも、後でランナーをデフォルトグループからカスタムグループに移動することもできます。 + +グループを作成するときは、ランナーグループにアクセスできる Organization を定義するポリシーを選択する必要があります。 + +{% data reusables.actions.runner-groups-add-to-enterprise-first-steps %} +1. To choose a policy for organization access, select the **Organization access** drop-down, and click a policy. You can configure a runner group to be accessible to a specific list of organizations, or all organizations in the enterprise.{% ifversion ghes %} By default, only private repositories can access runners in a runner group, but you can override this.{% endif %} + + {%- ifversion ghec or ghes %} + + ![ランナーグループのオプションを追加](/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png) + {%- elsif ghae %} + + ![ランナーグループのオプションを追加](/assets/images/help/settings/actions-enterprise-account-add-runner-group-options-ae.png) + {%- endif %} +{% data reusables.actions.runner-group-assign-policy-workflow %} +1. [**Save group**] をクリックしてグループを作成し、ポリシーを適用します。 + diff --git a/translations/ja-JP/data/reusables/actions/creating-a-runner-group-for-an-organization.md b/translations/ja-JP/data/reusables/actions/creating-a-runner-group-for-an-organization.md new file mode 100644 index 000000000000..8d1b7aa0beaf --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/creating-a-runner-group-for-an-organization.md @@ -0,0 +1,38 @@ +{% comment %} + +Always include a security admonition above this procedure. This is either one of the following, depending on whether the context is self-hosted runners or larger runners. + +{% data reusables.actions.self-hosted-runner-security-admonition %} +{% data reusables.actions.hosted-runner-security-admonition %} + +{% endcomment %} + +All organizations have a single default runner group. Organizations within an enterprise account can create additional groups. Organization の管理者は、個々のリポジトリにランナーグループへのアクセスを許可できます。 For information about how to create a runner group with the REST API, see "[Self-hosted runner groups](/rest/reference/actions#self-hosted-runner-groups)." + +Runners are automatically assigned to the default group when created, and can only be members of one group at a time. ランナーはデフォルトグループから作成した任意のグループに移動できます。 + +When creating a group, you must choose a policy that defines which repositories{% ifversion restrict-groups-to-workflows %} and workflows{% endif %} have access to the runner group. + +{% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %} +{% data reusables.organizations.navigate-to-org %} +{% data reusables.organizations.org_settings %} +{% data reusables.organizations.settings-sidebar-actions-runner-groups %} +1. In the "Runner groups" section, click **New runner group**. +1. Enter a name for your runner group. + {% data reusables.actions.runner-group-assign-policy-repo %} +{% data reusables.actions.runner-group-assign-policy-workflow %}{%- ifversion restrict-groups-to-workflows %} Organization-owned runner groups cannot access workflows from a different organization in the enterprise; instead, you must create an enterprise-owned runner group.{% endif %} +{% data reusables.actions.create-runner-group %} +{% elsif ghae or ghes < 3.4 %} +{% data reusables.organizations.navigate-to-org %} +{% data reusables.organizations.org_settings %} +{% data reusables.organizations.settings-sidebar-actions-runner-groups %} +1. Under {% ifversion ghes or ghae %}"Runners"{% endif %}, click **Add new**, and then **New group**. + + ![新しいランナーを追加](/assets/images/help/settings/actions-org-add-runner-group.png) +1. ランナーグループの名前を入力し、リポジトリアクセスのポリシーを割り当てます。 + + ランナーグループを、特定のリポジトリのリスト、もしくはEnterprise内のすべてのリポジトリからアクセスできるように設定できます。{% ifversion ghec or ghes %}デフォルトでは、プライベートリポジトリのみがランナーグループ内のランナーにアクセスできますが、これは上書きできます。 この設定は、Enterpriseによって共有されているOrganizationのランナーグループを設定している場合には上書きできません。{% endif %} + + ![ランナーグループのオプションを追加](/assets/images/help/settings/actions-org-add-runner-group-options.png) +1. [**Save group**] をクリックしてグループを作成し、ポリシーを適用します。 +{% endif %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/actions/hosted-runner-security-admonition.md b/translations/ja-JP/data/reusables/actions/hosted-runner-security-admonition.md new file mode 100644 index 000000000000..8c33797d55d7 --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/hosted-runner-security-admonition.md @@ -0,0 +1,5 @@ +{% warning %} + +**Warning**: {% data reusables.actions.hosted-runner-security %} + +{% endwarning %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/actions/hosted-runner-security.md b/translations/ja-JP/data/reusables/actions/hosted-runner-security.md new file mode 100644 index 000000000000..ed12d189db73 --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/hosted-runner-security.md @@ -0,0 +1,3 @@ +We recommend that you only use {% data variables.actions.hosted_runner %}s with private repositories: +- Forks of your repository can potentially run dangerous code on your {% data variables.actions.hosted_runner %} by creating a pull request that executes the code in a workflow. +- You could incur unexpected costs if you allow forked repositories to run jobs on your {% data variables.actions.hosted_runner %}s. \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/actions/jobs/section-running-jobs-in-a-container.md b/translations/ja-JP/data/reusables/actions/jobs/section-running-jobs-in-a-container.md index e7807da5b058..a5835ffc683e 100644 --- a/translations/ja-JP/data/reusables/actions/jobs/section-running-jobs-in-a-container.md +++ b/translations/ja-JP/data/reusables/actions/jobs/section-running-jobs-in-a-container.md @@ -2,6 +2,12 @@ `container`を設定しない場合は、コンテナで実行されるよう設定されているアクションを参照しているステップを除くすべてのステップが、`runs-on`で指定したホストで直接実行されます。 +{% note %} + +**ノート:** コンテナ内の`run`ステップのデフォルトシェルは`bash`ではなく`sh`です。 これは、[`jobs..defaults.run`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_iddefaultsrun)もしくは[`jobs..steps[*].shell`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell)で上書きできます。 + +{% endnote %} + ### 例: コンテナ内でのジョブの実行 ```yaml{:copy} diff --git a/translations/ja-JP/data/reusables/actions/moving-a-runner-to-a-group.md b/translations/ja-JP/data/reusables/actions/moving-a-runner-to-a-group.md new file mode 100644 index 000000000000..25f31b9753e0 --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/moving-a-runner-to-a-group.md @@ -0,0 +1,12 @@ +If you don't specify a runner group during the registration process, your new runners are automatically assigned to the default group, and can then be moved to another group. + +{% data reusables.actions.self-hosted-runner-navigate-to-org-enterprise %} +{% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %} +1. In the "Runners" list, click the runner that you want to configure. +2. Select the **Runner group** drop-down. +3. In "Move runner to group", choose a destination group for the runner. +{% elsif ghae or ghes < 3.4 %} +1. In the {% ifversion ghes or ghae %}"Runner groups"{% endif %} section of the settings page, locate the current group of the runner you want to move and expand the list of group members. ![ランナーグループのメンバーを表示](/assets/images/help/settings/actions-org-runner-group-members.png) +2. セルフホストランナーの横にあるチェックボックスを選択し、[**Move to group**] をクリックして、利用可能な移動先を確認します。 ![ランナーグループのメンバーを移動](/assets/images/help/settings/actions-org-runner-group-member-move.png) +3. 移動先のグループをクリックして、ランナーを移動します。 ![ランナーグループのメンバーを移動](/assets/images/help/settings/actions-org-runner-group-member-move-destination.png) +{% endif %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/actions/removing-a-runner-group.md b/translations/ja-JP/data/reusables/actions/removing-a-runner-group.md new file mode 100644 index 000000000000..2aaac0b4b199 --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/removing-a-runner-group.md @@ -0,0 +1,9 @@ +Runners are automatically returned to the default group when their group is removed. + +{% ifversion ghes or ghae or ghec %} +{% data reusables.actions.runner-groups-navigate-to-repo-org-enterprise %} +1. In the list of groups, to the right of the group you want to delete, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}. +2. グループを削除するには、[**Remove group**] をクリックします。 +3. 確認プロンプトを確認し、[**Remove this runner group**] をクリックします。 Any runners still in this group will be automatically moved to the default group, where they will inherit the access permissions assigned to that group. + +{% endif %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/actions/runner-group-enterprise-overview.md b/translations/ja-JP/data/reusables/actions/runner-group-enterprise-overview.md new file mode 100644 index 000000000000..516bccdefe90 --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/runner-group-enterprise-overview.md @@ -0,0 +1,3 @@ +Runner groups are used to control access to runners at the organization and enterprise level. Enterprise owners can configure access policies that control which organizations {% ifversion restrict-groups-to-workflows %}and workflows {% endif %}in an enterprise have access to the runner group. Organization owners can configure access policies that control which repositories{% ifversion restrict-groups-to-workflows %} and workflows{% endif %} in an organization have access to the runner group. + +When an enterprise owner grants access to a runner group, organization owners can see the runner group listed in the organization's runner settings. The organization owners can then assign additional granular repository{% ifversion restrict-groups-to-workflows %} and workflow{% endif %} access policies to the enterprise runner group. \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/actions/self-hosted-runner-groups-add-to-enterprise-first-steps.md b/translations/ja-JP/data/reusables/actions/runner-groups-add-to-enterprise-first-steps.md similarity index 100% rename from translations/ja-JP/data/reusables/actions/self-hosted-runner-groups-add-to-enterprise-first-steps.md rename to translations/ja-JP/data/reusables/actions/runner-groups-add-to-enterprise-first-steps.md diff --git a/translations/ja-JP/data/reusables/actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md b/translations/ja-JP/data/reusables/actions/runner-groups-navigate-to-repo-org-enterprise.md similarity index 83% rename from translations/ja-JP/data/reusables/actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md rename to translations/ja-JP/data/reusables/actions/runner-groups-navigate-to-repo-org-enterprise.md index 2415e0fb31a0..a8fcbd8570cb 100644 --- a/translations/ja-JP/data/reusables/actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md +++ b/translations/ja-JP/data/reusables/actions/runner-groups-navigate-to-repo-org-enterprise.md @@ -1,9 +1,9 @@ {% ifversion fpt %} -1. セルフホストランナーがあるリポジトリもしくはOrganizationのメインページにアクセスしてください。 +1. Navigate to the main page of the repository or organization where your runner groups are located. 2. {% octicon "gear" aria-label="The Settings gear" %} **Settings(設定)**をクリックしてください。 {% data reusables.organizations.settings-sidebar-actions-runner-groups %} {% elsif ghec or ghes or ghae %} -1. セルフホストランナーがあるところへアクセスしてください。 +1. Navigate to where your runner groups are located: * **Organizationの場合**: メインページにアクセスして{% octicon "gear" aria-label="The Settings gear" %} **Settings(設定)**をクリックしてください。 * **Enterpriseレベルのグループを使っている場合**: diff --git a/translations/ja-JP/data/reusables/actions/self-hosted-runner-add-to-enterprise.md b/translations/ja-JP/data/reusables/actions/self-hosted-runner-add-to-enterprise.md index 32481799bee7..c5f1a1338034 100644 --- a/translations/ja-JP/data/reusables/actions/self-hosted-runner-add-to-enterprise.md +++ b/translations/ja-JP/data/reusables/actions/self-hosted-runner-add-to-enterprise.md @@ -3,7 +3,7 @@ {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} {% data reusables.enterprise-accounts.actions-runners-tab %} -1. [**New runner**]をクリックしてください。 +{% ifversion actions-hosted-runners %}1. Click **New runner**, then click **New self-hosted runner**.{% else %}1. Click **New runner**.{% endif %} {% data reusables.actions.self-hosted-runner-configure %} {%- elsif ghae or ghes < 3.4 %} セルフホストランナーをEnterpriseに追加するには、Enterpriseのオーナーでなければなりません。 diff --git a/translations/ja-JP/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md b/translations/ja-JP/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md index 8bc647056231..e47b0bd92285 100644 --- a/translations/ja-JP/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md +++ b/translations/ja-JP/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md @@ -3,7 +3,7 @@ 2. {% octicon "gear" aria-label="The Settings gear" %} **Settings(設定)**をクリックしてください。 {% data reusables.organizations.settings-sidebar-actions-runners %} {% elsif ghec or ghes or ghae %} -1. セルフホストランナーが登録されているところへアクセスしてください: +1. Navigate to where your runner is registered: * **Organizationの場合**: メインページにアクセスして{% octicon "gear" aria-label="The Settings gear" %} **Settings(設定)**をクリックしてください。 * **Enterpriseレベルのランナーを使っている場合**: diff --git a/translations/ja-JP/data/reusables/actions/self-hosted-runner-navigate-to-repo-org-enterprise.md b/translations/ja-JP/data/reusables/actions/self-hosted-runner-navigate-to-repo-org-enterprise.md index 9ebda8c1fd84..de9048236322 100644 --- a/translations/ja-JP/data/reusables/actions/self-hosted-runner-navigate-to-repo-org-enterprise.md +++ b/translations/ja-JP/data/reusables/actions/self-hosted-runner-navigate-to-repo-org-enterprise.md @@ -3,7 +3,7 @@ 2. {% octicon "gear" aria-label="The Settings gear" %} **Settings(設定)**をクリックしてください。 {% data reusables.organizations.settings-sidebar-actions-runners %} {% elsif ghec or ghes or ghae %} -1. セルフホストランナーが登録されているところへアクセスしてください: +1. Navigate to where your runner is registered: * **Organizationもしくはリポジトリ内**: メインページにアクセスして{% octicon "gear" aria-label="The Settings gear" %}** Settings(設定)**をクリックしてください。 * **Enterpriseレベルのランナーを使っている場合**: diff --git a/translations/ja-JP/data/reusables/actions/self-hosted-runner-security-admonition.md b/translations/ja-JP/data/reusables/actions/self-hosted-runner-security-admonition.md new file mode 100644 index 000000000000..386ee2bad9ac --- /dev/null +++ b/translations/ja-JP/data/reusables/actions/self-hosted-runner-security-admonition.md @@ -0,0 +1,7 @@ +{% warning %} + +**Warning**: {% data reusables.actions.self-hosted-runner-security %} + +詳しい情報については「[セルフホストランナーについて](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)」を参照してください。 + +{% endwarning %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/actions/self-hosted-runner-security.md b/translations/ja-JP/data/reusables/actions/self-hosted-runner-security.md index 38c55056ab00..072c1de07725 100644 --- a/translations/ja-JP/data/reusables/actions/self-hosted-runner-security.md +++ b/translations/ja-JP/data/reusables/actions/self-hosted-runner-security.md @@ -1 +1 @@ -セルフホストランナーは、プライベートリポジトリでのみ利用することをおすすめします。 これは、ワークフロー中でコードを実行するPull Requestを作成することによって、リポジトリのフォークが危険なコードをセルフホストランナーマシン上で実行できる可能性があるためです。 +セルフホストランナーは、プライベートリポジトリでのみ利用することをおすすめします。 This is because forks of your public repository can potentially run dangerous code on your self-hosted runner machine by creating a pull request that executes the code in a workflow. \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/actions/use-request-body-api.md b/translations/ja-JP/data/reusables/actions/use-request-body-api.md index 1d37d0c4f027..716669acfd64 100644 --- a/translations/ja-JP/data/reusables/actions/use-request-body-api.md +++ b/translations/ja-JP/data/reusables/actions/use-request-body-api.md @@ -1 +1 @@ -To apply this configuration, submit a request to the API endpoint and include the required configuration in the request body. For more information, see "[Set the customization template for an OIDC subject claim for an organization](/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization)". \ No newline at end of file +この設定を適用するには、APIエンドポイントにリクエストをサブミットし、そのリクエストのボディに必要な設定を含めてください。 詳しい情報については「[OrganizationのOIDCサブジェクトクレームのカスタマイズテンプレートの設定](/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization)」を参照してください。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/advanced-security/custom-link-beta.md b/translations/ja-JP/data/reusables/advanced-security/custom-link-beta.md index a79fc2241749..030762649a53 100644 --- a/translations/ja-JP/data/reusables/advanced-security/custom-link-beta.md +++ b/translations/ja-JP/data/reusables/advanced-security/custom-link-beta.md @@ -1,5 +1,5 @@ {% note %} -**Note:** The ability to add resource links to blocked push messages is currently in public beta and subject to change. +**ノート:** ブロックされたプッシュメッセージにリソースリンクを追加する機能は、現在パブリックベータであり、変更されることがあります。 {% endnote %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/advanced-security/secret-scanning-push-protection-org.md b/translations/ja-JP/data/reusables/advanced-security/secret-scanning-push-protection-org.md index 0be0e528d085..a3af2685e30c 100644 --- a/translations/ja-JP/data/reusables/advanced-security/secret-scanning-push-protection-org.md +++ b/translations/ja-JP/data/reusables/advanced-security/secret-scanning-push-protection-org.md @@ -1,6 +1,6 @@ 1. "{% data variables.product.prodname_secret_scanning_caps %}"の下の"Push protection(プッシュ保護)"の下で、**Enable all(すべて有効化)**をクリックしてください。 ![任意のOrganizationで{% data variables.product.prodname_secret_scanning %}のプッシュ保護を有効化する方法を示しているスクリーンショット](/assets/images/help/organizations/secret-scanning-enable-push-protection.png) -1. Optionally, click "Automatically enable for private repositories added to {% data variables.product.prodname_secret_scanning %}."{% ifversion push-protection-custom-link-orgs %} -1. Optionally, to include a custom link in the message that members will see when they attempt to push a secret, select **Add a resource link in the CLI and web UI when a commit is blocked**, then type a URL, and click **Save link**. +1. あるいは、"Automatically enable for private repositories added to {% data variables.product.prodname_secret_scanning %}"をクリックしてください。{% ifversion push-protection-custom-link-orgs %} +1. あるいは、シークレットをプッシュしようとしたときにメンバーに表示されるメッセージにカスタムリンクを含めるには、**Add a resource link in the CLI and web UI when a commit is blocked(コミットがブロックされた場合CLIやWeb UIにリソースリンクを追加)**を選択し、続いてURLを入力し、**Save link(リンクを保存)**をクリックしてください。 {% ifversion push-protection-custom-link-orgs-beta %}{% indented_data_reference reusables.advanced-security.custom-link-beta spaces=3 %}{% endif %} - ![Screenshot showing checkbox and text field for enabling a custom link](/assets/images/help/organizations/secret-scanning-custom-link.png){% endif %} \ No newline at end of file + ![カスタムリンクを有効化するチェックボックスとテキストフィールドのスクリーンショット](/assets/images/help/organizations/secret-scanning-custom-link.png){% endif %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/billing/billing-hosted-runners.md b/translations/ja-JP/data/reusables/billing/billing-hosted-runners.md new file mode 100644 index 000000000000..288139688468 --- /dev/null +++ b/translations/ja-JP/data/reusables/billing/billing-hosted-runners.md @@ -0,0 +1 @@ +| Linux | 4 | $0.016 | | Linux | 8 | $0.032 | | Linux | 16 | $0.064 | | Linux | 32 | $0.128 | | Linux | 64 | $0.256 | | Windows | 8 | $0.064 | | Windows | 16 | $0.128 | | Windows | 32 | $0.256 | | Windows | 64 | $0.512 | \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/billing/billing-standard-runners.md b/translations/ja-JP/data/reusables/billing/billing-standard-runners.md new file mode 100644 index 000000000000..a31beb282d23 --- /dev/null +++ b/translations/ja-JP/data/reusables/billing/billing-standard-runners.md @@ -0,0 +1,5 @@ +| オペレーティングシステム | Cores | 分あたりの料金(米ドル) | +| ------------ | ----- | ------------ | +| Linux | 2 | $0.008 | +| macOS | 3 | $0.08 | +| Windows | 2 | $0.016 | diff --git a/translations/ja-JP/data/reusables/code-scanning/example-configuration-files.md b/translations/ja-JP/data/reusables/code-scanning/example-configuration-files.md index 18f4c8a7a0b4..00a1e2b31ba5 100644 --- a/translations/ja-JP/data/reusables/code-scanning/example-configuration-files.md +++ b/translations/ja-JP/data/reusables/code-scanning/example-configuration-files.md @@ -30,3 +30,22 @@ paths-ignore: - src/node_modules - '**/*.test.js' ``` + +{% ifversion code-scanning-exclude-queries-from-analysis %} + +以下の設定ファイルは、重要度がerrorのアラートを生成するクエリだけを実行します。 この設定は最初にすべてのデフォルトクエリ、`./my-queries`中のすべてのクエリ、`codeql/java-queries`中のデフォルトスイートを選択し、続いて警告や推奨事項を生成するすべてのクエリを除外します。 + +``` yaml +queries: + - name: Use an in-repository QL pack (run queries in the my-queries directory) + uses: ./my-queries +packs: + - codeql/java-queries +query-filters: +- exclude: + problem.severity: + - warning + - recommendation +``` + +{% endif %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/code-scanning/licensing-note.md b/translations/ja-JP/data/reusables/code-scanning/licensing-note.md index e48d3d1bfd92..a893b8832132 100644 --- a/translations/ja-JP/data/reusables/code-scanning/licensing-note.md +++ b/translations/ja-JP/data/reusables/code-scanning/licensing-note.md @@ -1,9 +1,9 @@ {% note %} -**Notes:** {% ifversion fpt %} -- The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories. {% data variables.product.prodname_codeql_cli %}は、{% data variables.product.prodname_ghe_cloud %}を使用し、{% data variables.product.prodname_GH_advanced_security %}のライセンスを持っているOrganizationが所有するプライベートリポジトリでも使用できます。 詳細については「[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %}の利用規約](https://securitylab.github.com/tools/codeql/license)」及び「[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)」を参照してください。 +**ノート:** {% ifversion fpt %} +- {% data variables.product.prodname_codeql_cli %}は、パブリックリポジトリでは無料で利用できます。 {% data variables.product.prodname_codeql_cli %}は、{% data variables.product.prodname_ghe_cloud %}を使用し、{% data variables.product.prodname_GH_advanced_security %}のライセンスを持っているOrganizationが所有するプライベートリポジトリでも使用できます。 詳細については「[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %}の利用規約](https://securitylab.github.com/tools/codeql/license)」及び「[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)」を参照してください。 {%- elsif ghec %} -- The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories that are maintained on {% data variables.product.prodname_dotcom_the_website %}, and available to use on private repositories that are owned by customers with an {% data variables.product.prodname_advanced_security %} license. 詳細については「[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %}の利用規約](https://securitylab.github.com/tools/codeql/license)」及び「[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)」を参照してください。 +- {% data variables.product.prodname_codeql_cli %}は{% data variables.product.prodname_dotcom_the_website %}でメンテナンスされているパブリックリポジトリでは無料で使用でき、{% data variables.product.prodname_advanced_security %}ライセンスを持っているお客様が所有するプライベートリポジトリでも使用できます。 詳細については「[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %}の利用規約](https://securitylab.github.com/tools/codeql/license)」及び「[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)」を参照してください。 {%- elsif ghes or ghae %} - {% data variables.product.prodname_codeql_cli %}は{% data variables.product.prodname_advanced_security %}ライセンスを持つお客様にご利用いただけます。 {% endif %} diff --git a/translations/ja-JP/data/reusables/code-scanning/non-glibc-linux-support.md b/translations/ja-JP/data/reusables/code-scanning/non-glibc-linux-support.md index 2a1c2a8e53b1..e53d59424f90 100644 --- a/translations/ja-JP/data/reusables/code-scanning/non-glibc-linux-support.md +++ b/translations/ja-JP/data/reusables/code-scanning/non-glibc-linux-support.md @@ -1 +1 @@ -The {% data variables.product.prodname_codeql_cli %} is currently not compatible with non-glibc Linux distributions such as (musl-based) Alpine Linux. \ No newline at end of file +{% data variables.product.prodname_codeql_cli %}は現時点で、(muslベースの)Alpine Linuxなどの非glibc Linuxディストリビューションとは互換性がありません。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/code-scanning/run-additional-queries.md b/translations/ja-JP/data/reusables/code-scanning/run-additional-queries.md index 3f25bd67d1b3..fddae57c6268 100644 --- a/translations/ja-JP/data/reusables/code-scanning/run-additional-queries.md +++ b/translations/ja-JP/data/reusables/code-scanning/run-additional-queries.md @@ -1,5 +1,13 @@ When you use {% data variables.product.prodname_codeql %} to scan code, the {% data variables.product.prodname_codeql %} analysis engine generates a database from the code and runs queries on it. {% data variables.product.prodname_codeql %} analysis uses a default set of queries, but you can specify more queries to run, in addition to the default queries. +{% ifversion code-scanning-exclude-queries-from-analysis %} +{% tip %} + +You can also specify the queries you want to exclude from analysis, or include in the analysis. This requires the use of a custom configuration file. For more information, see "[Using a custom configuration file](#using-a-custom-configuration-file)" and "[Excluding specific queries from analysis](#excluding-specific-queries-from-analysis) " below. + +{% endtip %} +{% endif %} + {% ifversion codeql-packs %} You can run extra queries if they are part of a {% data variables.product.prodname_codeql %} pack (beta) published to the {% data variables.product.company_short %} {% data variables.product.prodname_container_registry %} or a {% data variables.product.prodname_ql %} pack stored in a repository. For more information, see "[About {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql#about-codeql-queries)." diff --git a/translations/ja-JP/data/reusables/codespaces/codespaces-disabling-org-billing.md b/translations/ja-JP/data/reusables/codespaces/codespaces-disabling-org-billing.md index a3d7ca0c7a90..2f638bed7eb4 100644 --- a/translations/ja-JP/data/reusables/codespaces/codespaces-disabling-org-billing.md +++ b/translations/ja-JP/data/reusables/codespaces/codespaces-disabling-org-billing.md @@ -1,5 +1,5 @@ {% note %} -**Note**: If you disable billable codespaces use for your organization, anyone who can create codespaces as an individual user, and can clone a repository in your organization, will still be able to create a codespace for that repository. However, this will not incur any charge for your organization. For information about restricting access to a repository, see "[Managing teams and people with access to your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." +**ノート**: Organizationで課金されるcodespacesの利用を無効化した場合でも、個人ユーザとしてcodespacesを作成でき、Organization内のリポジトリをクローンできるユーザは、引き続きそのリポジトリに対してcodespaceを作成できます。 しかし、これによってOrganizationに対する課金が生じることはありません。 リポジトリへのアクセスの制限に関する情報については「[リポジトリへのアクセスを持つTeamや人の管理](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)」を参照してください。 {% endnote %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/codespaces/codespaces-org-policies-note.md b/translations/ja-JP/data/reusables/codespaces/codespaces-org-policies-note.md index 69e653079137..dc54b526de5d 100644 --- a/translations/ja-JP/data/reusables/codespaces/codespaces-org-policies-note.md +++ b/translations/ja-JP/data/reusables/codespaces/codespaces-org-policies-note.md @@ -1,5 +1,5 @@ {% note %} -**Note**: Organization policies you define for {% data variables.product.prodname_codespaces %} only apply to codespaces for which your organization will be billed. If an individual user creates a codespace for a repository in your organization, and the organization is not billed, then the codespace will not be bound by these policies. For information on how to choose who can create codespaces that are billed to your organization, see "[Enabling {% data variables.product.prodname_github_codespaces %} for your organization](https://docs-internal-29134-ad7bd8.preview.ghdocs.com/en/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization#choose-who-can-create-codespaces-that-are-billed-to-your-organization)." +**ノート**: {% data variables.product.prodname_codespaces %}に対して定義するOrganizationのポリシーは、そのOrganizationに対して課金されるcodespacesにのみ適用されます。 個人ユーザがOrganization内のリポジトリに対してcodespaceを作成し、Organizationが課金されない場合は、そのcodespaceはそれらのポリシーによる制約を受けません。 Organizationに課金されるcodespaceを作成できるユーザの選択方法に関する情報については「[Organizationでの{% data variables.product.prodname_github_codespaces %}の有効化](/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization#choose-who-can-create-codespaces-that-are-billed-to-your-organization)」を参照してください。 {% endnote %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/codespaces/codespaces-spending-limit-requirement.md b/translations/ja-JP/data/reusables/codespaces/codespaces-spending-limit-requirement.md index 5ab28a931087..8ead919affc5 100644 --- a/translations/ja-JP/data/reusables/codespaces/codespaces-spending-limit-requirement.md +++ b/translations/ja-JP/data/reusables/codespaces/codespaces-spending-limit-requirement.md @@ -1,9 +1,9 @@ {% note %} -**Note:** You must set a non-zero spending limit before you can use {% data variables.product.prodname_codespaces %}. +**ノート:** {% data variables.product.prodname_codespaces %}を利用するには、0ではない利用上限を設定しなければなりません。 {% endnote %} -By default, your organization or enterprise will have a {% data variables.product.prodname_github_codespaces %} spending limit of $0. This prevents new codespaces from being created, or existing codespaces from being opened, if this would incur a billable cost to your organization or enterprise. Organiationでユーザがcodespaceを作成できるようにするには、この上限を$0よりも大きな値に設定してください。 +デフォルトでは、OrganizationもしくはEnterpriseは、$0の{% data variables.product.prodname_github_codespaces %}利用上限を持ちます。 これによって、OrganizationやEntepriseへの課金が発生する場合に、新しいcodespaceが作成されたり、既存のcodespacesがオープンされることを防げます。 Organiationでユーザがcodespaceを作成できるようにするには、この上限を$0よりも大きな値に設定してください。 {% data reusables.billing.overages-billed-monthly %} diff --git a/translations/ja-JP/data/reusables/codespaces/open-codespace-from-template-repo.md b/translations/ja-JP/data/reusables/codespaces/open-codespace-from-template-repo.md new file mode 100644 index 000000000000..4e37ab72c2c2 --- /dev/null +++ b/translations/ja-JP/data/reusables/codespaces/open-codespace-from-template-repo.md @@ -0,0 +1,8 @@ +1. Select an owner for the new repository, enter a repository name, select your preferred privacy setting, and click **Create repository from template**. +1. On the main page of the newly created repository, click the **{% octicon "code" aria-label="The code icon" %} Code** button and select the **Codespaces** tab. + + ![[New codespace] ボタン](/assets/images/help/codespaces/new-codespace-button.png) + + If you don’t see this tab, {% data variables.product.prodname_github_codespaces %} isn't available for you. For more information about access to {% data variables.product.prodname_github_codespaces %}, see "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-github-codespaces)." + +1. On the **Codespaces** tab, click **Create codespace on main**. diff --git a/translations/ja-JP/data/reusables/codespaces/rebuild-command.md b/translations/ja-JP/data/reusables/codespaces/rebuild-command.md index 9e79fd326b4b..a2491badcfc7 100644 --- a/translations/ja-JP/data/reusables/codespaces/rebuild-command.md +++ b/translations/ja-JP/data/reusables/codespaces/rebuild-command.md @@ -1,5 +1,3 @@ -1. {% data variables.product.prodname_vscode_command_palette %}にアクセスし(Shift + Command + P / Ctrl + Shift + P)、"rebuild"と入力し始めてください。 **Codespaces: Rebuild Container(Codespaces: コンテナをリビルド)**を選択してください。 +1. Access the {% data variables.product.prodname_vscode_command_palette_shortname %} (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)), then start typing "rebuild". **Codespaces: Rebuild Container(Codespaces: コンテナをリビルド)**を選択してください。 ![コンテナリビルドの選択肢](/assets/images/help/codespaces/codespaces-rebuild.png) - - diff --git a/translations/ja-JP/data/reusables/codespaces/remote-explorer.md b/translations/ja-JP/data/reusables/codespaces/remote-explorer.md index c46ed9b53925..4a8ab876fd16 100644 --- a/translations/ja-JP/data/reusables/codespaces/remote-explorer.md +++ b/translations/ja-JP/data/reusables/codespaces/remote-explorer.md @@ -1,9 +1,9 @@ {% note %} -**Note**: If the Remote Explorer is not displayed in the Activity Bar: +**ノート**: Remote Explorerがアクティビティバーに表示されない場合: -1. Access the command palette. For example, by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux). -1. Type: `codespaces`. -1. Click **Codespaces: Details**. +1. Access the Command Palette. たとえばShift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linuxを押します。 +1. `codespaces`と入力してください。 +1. **Codespaces: Details(Codespacesの詳細)**をクリックしてください。 {% endnote %} diff --git a/translations/ja-JP/data/reusables/dependabot/dependabot-alerts-filters.md b/translations/ja-JP/data/reusables/dependabot/dependabot-alerts-filters.md index 7ef855394d13..f2e122293066 100644 --- a/translations/ja-JP/data/reusables/dependabot/dependabot-alerts-filters.md +++ b/translations/ja-JP/data/reusables/dependabot/dependabot-alerts-filters.md @@ -2,7 +2,7 @@ | オプション | 説明 | サンプル | |:------------ |:------------------------------------------------------------------------------------------------------------------------------------------------------------------ |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ecosystem` | 選択されたエコシステムのアラートを表示 | `ecosystem:npm`を使ってnpmの{% data variables.product.prodname_dependabot_alerts %}を表示 |{% ifversion fpt or ghec or ghes > 3.5 %} +| `ecosystem` | 選択されたエコシステムのアラートを表示 | `ecosystem:npm`を使ってnpmの{% data variables.product.prodname_dependabot_alerts %}を表示 |{% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-7891 %} | `has` | 選択されたフィルタ条件を満たすアラートを表示 | `has:patch`を使ってパッチを持つアドバイザリに関連したアラートを表示{% ifversion dependabot-alerts-vulnerable-calls %}
`has:vulnerable-calls`を使って脆弱性のある関数の呼び出しに関連したアラートを表示{% endif %} {% endif %} | `is` | 状態に基づいてアラートを表示 | `is:open`を使ってオープンなアラートを表示 | diff --git a/translations/ja-JP/data/reusables/dependency-review/dependency-review-action-beta-note.md b/translations/ja-JP/data/reusables/dependency-review/dependency-review-action-beta-note.md index 8d208218020c..b4c529258f25 100644 --- a/translations/ja-JP/data/reusables/dependency-review/dependency-review-action-beta-note.md +++ b/translations/ja-JP/data/reusables/dependency-review/dependency-review-action-beta-note.md @@ -2,4 +2,4 @@ **ノート**: {% data variables.product.prodname_dependency_review_action %}は現在パブリックベータであり、変更されることがあります。 -{% endnote %} +{% endnote %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/dependency-review/dependency-review-action-overview.md b/translations/ja-JP/data/reusables/dependency-review/dependency-review-action-overview.md index ce009a9d6c30..62a00d351503 100644 --- a/translations/ja-JP/data/reusables/dependency-review/dependency-review-action-overview.md +++ b/translations/ja-JP/data/reusables/dependency-review/dependency-review-action-overview.md @@ -1,3 +1,3 @@ {% data variables.product.prodname_dependency_review_action %}はPull Requestをスキャンして依存関係の変更を探し、脆弱性があることが知られている新しい依存関係があればエラーを発生させます。 このアクションは、2つのリビジョン間で依存関係を比較し、差異があれば報告するAPIエンドポイントによってサポートされています。 -このアクションとAPIエンドポイントに関する詳しい情報については、それぞれ「[依存関係レビューについて](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-reinforcement)」及びAPIドキュメンテーションの「[依存関係レビュー](/rest/dependency-graph/dependency-review)を参照してください。 +For more information about the action and the API endpoint, see the [`dependency-review-action`](https://github.com/actions/dependency-review-action) documentation, and "[Dependency review](/rest/dependency-graph/dependency-review)" in the API documentation. diff --git a/translations/ja-JP/data/reusables/enterprise-accounts/security-tab.md b/translations/ja-JP/data/reusables/enterprise-accounts/security-tab.md index 988743f80e9e..5eaf02ca1934 100644 --- a/translations/ja-JP/data/reusables/enterprise-accounts/security-tab.md +++ b/translations/ja-JP/data/reusables/enterprise-accounts/security-tab.md @@ -1,5 +1,5 @@ {%- ifversion ghec or ghes > 3.4 or ghae-issue-7875 %} -1. In the left sidebar, click **Authentication security**. +1. 左のサイドバーで**Authentication security(認証のセキュリティ)**をクリックしてください。 {% ifversion ghae %}![Security tab in the enterprise account settings sidebar](/assets/images/enterprise/github-ae/enterprise-account-settings-authentication-security-tab.png){% else %}![Security tab in the enterprise account settings sidebar](/assets/images/help/business-accounts/enterprise-account-settings-authentication-security-tab.png){% endif %} {%- else %} 1. 左のサイドバーで**Security(セキュリティ)**をクリックしてください。 diff --git a/translations/ja-JP/data/reusables/gated-features/hosted-runners.md b/translations/ja-JP/data/reusables/gated-features/hosted-runners.md new file mode 100644 index 000000000000..4f1e2137bbfb --- /dev/null +++ b/translations/ja-JP/data/reusables/gated-features/hosted-runners.md @@ -0,0 +1 @@ +The {% data variables.actions.hosted_runner %}s feature is currently in beta for organizations and enterprises using the {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %} plans, and is subject to change. \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/getting-started/bearer-vs-token.md b/translations/ja-JP/data/reusables/getting-started/bearer-vs-token.md new file mode 100644 index 000000000000..9dd0b62adaba --- /dev/null +++ b/translations/ja-JP/data/reusables/getting-started/bearer-vs-token.md @@ -0,0 +1 @@ +In most cases, you can use `Authorization: Bearer` or `Authorization: token` to pass a token. However, if you are passing a JSON web token (JWT), you must use `Authorization: Bearer`. \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/git/cache-on-repository-path.md b/translations/ja-JP/data/reusables/git/cache-on-repository-path.md index ced81ebbd9f5..cd19dc5b54e0 100644 --- a/translations/ja-JP/data/reusables/git/cache-on-repository-path.md +++ b/translations/ja-JP/data/reusables/git/cache-on-repository-path.md @@ -1,4 +1,4 @@ -1. To configure Git to cache credentials for each local directory where you clone a repository, enter the following command. +1. リポジトリをクローンしたそれぞれのローカルディレクトリに認証情報をキャッシュするようGitを設定するには、以下のコマンドを入力してください。 ```shell{:copy} git config --global credential.useHttpPath true diff --git a/translations/ja-JP/data/reusables/git/clear-stored-gcm-credentials.md b/translations/ja-JP/data/reusables/git/clear-stored-gcm-credentials.md index 04e3de748e0c..5c3f0886d4a9 100644 --- a/translations/ja-JP/data/reusables/git/clear-stored-gcm-credentials.md +++ b/translations/ja-JP/data/reusables/git/clear-stored-gcm-credentials.md @@ -1,4 +1,4 @@ -- If the output is `manager-core`, you're using Git Credential Manager. To clear the credentials, run the following command. +- 出力が`manager-core`であれば、Git Credential Managerが使われています。 認証情報をクリアするには、以下のコマンドを実行してください。 ```shell{:copy} git credential-manager reject https://github.com diff --git a/translations/ja-JP/data/reusables/git/clear-the-stored-credentials.md b/translations/ja-JP/data/reusables/git/clear-the-stored-credentials.md index f723d7ab9721..51ca4b48fff2 100644 --- a/translations/ja-JP/data/reusables/git/clear-the-stored-credentials.md +++ b/translations/ja-JP/data/reusables/git/clear-the-stored-credentials.md @@ -1 +1 @@ -1. If the output confirms that you're using a credential manager, clear the stored credentials for the credential manager. +1. 出力で認証情報マネージャーの利用が確認された場合、その認証情報マネージャーに保存された認証情報をクリアしてください。 diff --git a/translations/ja-JP/data/reusables/git/confirm-credential-manager.md b/translations/ja-JP/data/reusables/git/confirm-credential-manager.md index 68c6e9939728..dc2041121b45 100644 --- a/translations/ja-JP/data/reusables/git/confirm-credential-manager.md +++ b/translations/ja-JP/data/reusables/git/confirm-credential-manager.md @@ -1,4 +1,4 @@ -1. To confirm your use of a credential manager, enter the following command and note the output. +1. 認証情報マネージャーの利用を確認するには、以下のコマンドを入力し、出力を記録してください。 ```shell{:copy} git config --get credential.helper diff --git a/translations/ja-JP/data/reusables/git/no-credential-manager.md b/translations/ja-JP/data/reusables/git/no-credential-manager.md index fe79c2ff04be..88a8a8c5d9b0 100644 --- a/translations/ja-JP/data/reusables/git/no-credential-manager.md +++ b/translations/ja-JP/data/reusables/git/no-credential-manager.md @@ -1 +1 @@ -- If the output doesn't include the name of a credential manager, there is no credential manager configured, and you can proceed to the next step. \ No newline at end of file +- 出力に認証情報マネージャーの名前が含まれていない場合、認証情報マネージャーは設定されておらず、次のステップに進むことができます。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/git/provide-credentials.md b/translations/ja-JP/data/reusables/git/provide-credentials.md index 351a1e87d1d1..d395aafd3a1b 100644 --- a/translations/ja-JP/data/reusables/git/provide-credentials.md +++ b/translations/ja-JP/data/reusables/git/provide-credentials.md @@ -1,3 +1,3 @@ -1. The first time that you use Git to clone a repository or access data in a repository that you've already cloned, Git will request credentials. Provide the PAT for the account with access to the repository. +1. 初めてGitを使ってリポジトリをクローンしたり、クローンしたリポジトリ内のデータにアクセスしようとすると、Gitは認証情報を要求します。 リポジトリへのアクセスを持つアカウントのPATを提供してください。 - Git will cache the PAT for the directory you're in, and you'll be able to access and write repository data on {% data variables.product.product_location %} using the correct account. + Gitは現在のディレクトリにPATをキャッシュし、適切なアカウントを使って{% data variables.product.product_location %}上のリポジトリデータにアクセスし、書き込みできるようになります。 diff --git a/translations/ja-JP/data/reusables/gpg/configure-ssh-signing.md b/translations/ja-JP/data/reusables/gpg/configure-ssh-signing.md index f0f489a73ac7..04c9ba74dd97 100644 --- a/translations/ja-JP/data/reusables/gpg/configure-ssh-signing.md +++ b/translations/ja-JP/data/reusables/gpg/configure-ssh-signing.md @@ -1,4 +1,4 @@ -1. Configure Git to use SSH to sign commits and tags: +1. SHHを使ってコミットとタグに署名するようGitを設定してください。 ```bash $ git config --global gpg.format ssh ``` \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/gpg/copy-gpg-key-id.md b/translations/ja-JP/data/reusables/gpg/copy-gpg-key-id.md index 34b505fd16c3..75470758d698 100644 --- a/translations/ja-JP/data/reusables/gpg/copy-gpg-key-id.md +++ b/translations/ja-JP/data/reusables/gpg/copy-gpg-key-id.md @@ -1,9 +1,9 @@ 1. GPGキーのリストから、使いたいGPGキーIDの長い形式をコピーしてください。 この例では、GPG キー ID は `3AA5C34371567BD2` です。 - ```shell + ```shell{:copy} $ gpg --list-secret-keys --keyid-format=long /Users/hubot/.gnupg/secring.gpg ------------------------------------ sec 4096R/3AA5C34371567BD2 2016-03-10 [expires: 2017-03-10] uid Hubot ssb 4096R/42B317FD4BA89E7A 2016-03-10 - ``` + ``` diff --git a/translations/ja-JP/data/reusables/gpg/copy-ssh-public-key.md b/translations/ja-JP/data/reusables/gpg/copy-ssh-public-key.md index d2710a980717..30e0b44fb600 100644 --- a/translations/ja-JP/data/reusables/gpg/copy-ssh-public-key.md +++ b/translations/ja-JP/data/reusables/gpg/copy-ssh-public-key.md @@ -5,7 +5,7 @@ ```shell $ pbcopy < ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub - # Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard + # id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pubファイルの内容をクリップボードにコピー ``` {% tip %} @@ -18,7 +18,7 @@ ```shell $ clip < ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub - # Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard + # id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pubファイルの内容をクリップボードにコピー ``` {% tip %} @@ -31,13 +31,13 @@ ```shell $ cat ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub - # Then select and copy the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file - # displayed in the terminal to your clipboard + # 続いてターミナルに表示されたid_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub + # ファイルの内容を選択してコピー ``` {% tip %} - **Tip:** Alternatively, you can locate the hidden `.ssh` folder, open the file in your favorite text editor, and copy it to your clipboard. + **参考:** あるいは隠しフォルダの`.ssh`を見つけて、好きなテキストエディタでこのファイルを開き、クリップボードにコピーしてください。 {% endtip %} {% endlinux %} diff --git a/translations/ja-JP/data/reusables/gpg/list-keys-with-note.md b/translations/ja-JP/data/reusables/gpg/list-keys-with-note.md index 1a5a7f57291a..8243508393f7 100644 --- a/translations/ja-JP/data/reusables/gpg/list-keys-with-note.md +++ b/translations/ja-JP/data/reusables/gpg/list-keys-with-note.md @@ -1,10 +1,11 @@ - 1. 公開鍵と秘密鍵をどちらも持っているGPGキーの長い形式のリストを表示するには、 `gpg --list-secret-keys --keyid-format=long`コマンドを使ってください。 コミットやタグに署名するには秘密鍵が必要です。 - ```shell - $ gpg --list-secret-keys --keyid-format=long -``` - {% note %} - **ノート:**LinuxのGPG環境の中には、既存のキーのリストを表示させるために`gpg2 --list-keys --keyid-format LONG`としなければならないものもあります。 この場合、`git config --global gpg.program gpg2`と実行してGitが`gpg2`を使うように設定する必要もあります。 + ```shell{:copy} + $ gpg --list-secret-keys --keyid-format=long + ``` + + {% note %} + + **ノート:**LinuxのGPG環境の中には、既存のキーのリストを表示させるために`gpg2 --list-keys --keyid-format LONG`としなければならないものもあります。 この場合、`git config --global gpg.program gpg2`と実行してGitが`gpg2`を使うように設定する必要もあります。 - {% endnote %} + {% endnote %} diff --git a/translations/ja-JP/data/reusables/gpg/paste-ssh-public-key.md b/translations/ja-JP/data/reusables/gpg/paste-ssh-public-key.md index 1274a0acb5fa..f372e1a7fc9a 100644 --- a/translations/ja-JP/data/reusables/gpg/paste-ssh-public-key.md +++ b/translations/ja-JP/data/reusables/gpg/paste-ssh-public-key.md @@ -1,4 +1,4 @@ -1. To set your SSH signing key in Git, paste the text below, substituting the contents of your clipboard for the key you'd like to use. Since the key contains spaces, you must wrap it in quotes: +1. GitでSSH署名キーを設定するには、クリップボードの内容を使いたいキーに置き換えて以下のテキストを貼り付けてください。 キーは空白を含むので、引用符で囲まなければなりません。 ```bash $ git config --global user.signingkey 'ssh-ed25519 AAAAC3(...) user@example.com' ``` \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/gpg/ssh-git-version.md b/translations/ja-JP/data/reusables/gpg/ssh-git-version.md index 481a9df5b1da..0462816bbe7d 100644 --- a/translations/ja-JP/data/reusables/gpg/ssh-git-version.md +++ b/translations/ja-JP/data/reusables/gpg/ssh-git-version.md @@ -1,6 +1,6 @@ {% note %} -**Note:** SSH signature verification is available in Git 2.34 or later. Gitのバージョンをアップデートするには、[Git](https://git-scm.com/downloads)のWebサイトを参照してください。 +**ノート:** SSH署名検証は、Git 2.34以降で利用できます。 Gitのバージョンをアップデートするには、[Git](https://git-scm.com/downloads)のWebサイトを参照してください。 {% endnote %} diff --git a/translations/ja-JP/data/reusables/identity-and-permissions/about-adding-ip-allow-list-entries.md b/translations/ja-JP/data/reusables/identity-and-permissions/about-adding-ip-allow-list-entries.md index 772581f87a59..a5d586a9c3a0 100644 --- a/translations/ja-JP/data/reusables/identity-and-permissions/about-adding-ip-allow-list-entries.md +++ b/translations/ja-JP/data/reusables/identity-and-permissions/about-adding-ip-allow-list-entries.md @@ -1,3 +1,3 @@ -You can create an IP allow list by adding entries that each contain an IP address or address range.{% ifversion ip-allow-list-address-check %} After you finish adding entries, you can check whether a particular IP address would be allowed by any of the enabled entries in your list.{% endif %} +IPアドレスもしくはアドレスの範囲を含むエントリを追加することで、IP許可リストを作成できます。{% ifversion ip-allow-list-address-check %} エントリの追加を終えたら、特定のIPアドレスがリスト中の有効化エントリのいずれかによって許可されるかをチェックできます。{% endif %} -Before the list restricts access to {% ifversion ghae %}your enterprise{% else %}private assets owned by organizations in your enterprise{% endif %}, you must also enable allowed IP addresses. \ No newline at end of file +このリストが{% ifversion ghae %}Enterprise{% else %}Enterprise内のOrganizationが所有するプライベートアセット{% endif %}へのアクセスを制限する前に、許可IPアドレスも有効化しなければなりません。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/identity-and-permissions/about-checking-ip-address.md b/translations/ja-JP/data/reusables/identity-and-permissions/about-checking-ip-address.md index dfdc758f91d4..45ce5027d58d 100644 --- a/translations/ja-JP/data/reusables/identity-and-permissions/about-checking-ip-address.md +++ b/translations/ja-JP/data/reusables/identity-and-permissions/about-checking-ip-address.md @@ -1 +1 @@ -You can check whether a particular IP address would be allowed by any of the enabled entries in your IP allow list, even if the list is not currently enabled. \ No newline at end of file +IP許可リストが現在有効化されていなくても、特定の IPアドレスが IP許可リスト内の有効なエントリのいずれかによって許可されるかどうかを確認できます。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/identity-and-permissions/about-editing-ip-allow-list-entries.md b/translations/ja-JP/data/reusables/identity-and-permissions/about-editing-ip-allow-list-entries.md index d646e02ec5b9..9bc1526e4f7f 100644 --- a/translations/ja-JP/data/reusables/identity-and-permissions/about-editing-ip-allow-list-entries.md +++ b/translations/ja-JP/data/reusables/identity-and-permissions/about-editing-ip-allow-list-entries.md @@ -1,5 +1,5 @@ -You can edit an entry in your IP allow list. If you edit an enabled entry, changes are enforced immediately. +IP許可リスト内のエントリを編集できます。 有効化されたエントリを編集すると、変更はすぐに適用されます。 {% ifversion ip-allow-list-address-check %} -After you finish editing entries, you can check whether a particular IP address would be allowed by any of the enabled entries in your list. +エントリの編集が終わったら、特定のIPアドレスがリスト中の有効なエントリのいずれかによって許可されるかをチェックできます。 {% endif %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md b/translations/ja-JP/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md index f886df0690a3..b6aba096b3af 100644 --- a/translations/ja-JP/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md +++ b/translations/ja-JP/data/reusables/identity-and-permissions/about-enabling-allowed-ip-addresses.md @@ -1,5 +1,5 @@ -After you create an IP allow list, you can enable allowed IP addresses. When you enable allowed IP addresses, {% data variables.product.company_short %} immediately enforces any enabled entries in your IP allow list. +IP許可リストを作成したら、許可されたIPアドレスを有効化できます。 許可IPアドレスを有効化すると、{% data variables.product.company_short %}はIP許可リスト内のすべての有効なエントリを適用します。 {% ifversion ip-allow-list-address-check %} -Before you enable allowed IP addresses, you can check whether a particular IP address would be allowed by any of the enabled entries in your list. For more information, see "[Checking if an IP address is permitted](#checking-if-an-ip-address-is-permitted)." +許可されたIPアドレスを有効化する前に、特定のIPアドレスがリスト中の有効なエントリのいずれかによって許可されるかをチェックできます。 詳しい情報については「[IPアドレスが許可されているかのチェック](#checking-if-an-ip-address-is-permitted)」を参照してください。 {% endif %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/identity-and-permissions/check-ip-address-step.md b/translations/ja-JP/data/reusables/identity-and-permissions/check-ip-address-step.md index 5e73fdddcdbe..95e621b09aa4 100644 --- a/translations/ja-JP/data/reusables/identity-and-permissions/check-ip-address-step.md +++ b/translations/ja-JP/data/reusables/identity-and-permissions/check-ip-address-step.md @@ -1 +1 @@ -1. Under "Check your IP address", enter an IP address. ![Screenshot of the "Check IP address" text field](/assets/images/help/security/check-ip-address.png) \ No newline at end of file +1. "Check your IP address(IPアドレスをチェック)"の下で、IPアドレスを入力してください。 !["Check IP address"テキストフィールドのスクリーンショット](/assets/images/help/security/check-ip-address.png) \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/identity-and-permissions/check-ip-address.md b/translations/ja-JP/data/reusables/identity-and-permissions/check-ip-address.md index 9a187752d6a4..bcb3c65a6a11 100644 --- a/translations/ja-JP/data/reusables/identity-and-permissions/check-ip-address.md +++ b/translations/ja-JP/data/reusables/identity-and-permissions/check-ip-address.md @@ -1,3 +1,3 @@ {%- ifversion ip-allow-list-address-check %} -1. Optionally, check if a particular IP address would be allowed by any of the enabled entries in your list. For more information, see "[Checking if an IP address is permitted](#checking-if-an-ip-address-is-permitted)." +1. あるいは、特定のIPアドレスがリスト中の有効なエントリのいずれかによって許可されているかチェックしてください。 詳しい情報については「[IPアドレスが許可されているかのチェック](#checking-if-an-ip-address-is-permitted)」を参照してください。 {%- endif %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/identity-and-permissions/ip-allow-lists-enable.md b/translations/ja-JP/data/reusables/identity-and-permissions/ip-allow-lists-enable.md index 2547c2bd7cac..c86cfcea2e74 100644 --- a/translations/ja-JP/data/reusables/identity-and-permissions/ip-allow-lists-enable.md +++ b/translations/ja-JP/data/reusables/identity-and-permissions/ip-allow-lists-enable.md @@ -1,3 +1,3 @@ -To enforce the IP allow list, you must first add IP addresses to the list, then enable the IP allow list.{% ifversion ip-allow-list-address-check %} After you complete your list, you can check whether a particular IP address would be allowed by any of the enabled entries in the list.{% endif %} +IP許可リストを適用するには、まずIPアドレスをリストに追加し、続いてIP許可リストを有効化しなければなりません。{% ifversion ip-allow-list-address-check %}リストが完成したら、特定のIPアドレスがリスト中の有効なエントリのいずれかによって許可されるかをチェックできます。{% endif %} IP 許可リストを有効にするには、現在の IP アドレスまたは一致する範囲を追加する必要があります。 diff --git a/translations/ja-JP/data/reusables/identity-and-permissions/ipv6-allow-lists.md b/translations/ja-JP/data/reusables/identity-and-permissions/ipv6-allow-lists.md new file mode 100644 index 000000000000..db5045625d60 --- /dev/null +++ b/translations/ja-JP/data/reusables/identity-and-permissions/ipv6-allow-lists.md @@ -0,0 +1,7 @@ +{% ifversion fpt or ghec %} +{% note %} + +**ノート:** {% data variables.product.company_short %}は徐々にIPv6のサポートを展開していきます。 {% data variables.product.prodname_dotcom %}サービスがIPv6のサポートを追加していくにつれて、{% data variables.product.prodname_dotcom %}ユーザのIPv6アドレスの認識を開始していきます。 アクセスの中断を防ぐため、必要なIPv6のアドレスがIP許可リストに追加されていることを確認してください。 + +{% endnote %} +{% endif %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/organizations/about-following-organizations.md b/translations/ja-JP/data/reusables/organizations/about-following-organizations.md new file mode 100644 index 000000000000..49c10f428ff6 --- /dev/null +++ b/translations/ja-JP/data/reusables/organizations/about-following-organizations.md @@ -0,0 +1 @@ +{% data variables.product.product_name %}上のOrganizationをフォローすると、それらの{% ifversion fpt or ghec %}パブリックな{% endif %}アクティビティが個人ダッシュボードに表示されるようになります。 このアクティビティには、新しいディスカッション、スポンサーシップ、リポジトリが含まれます。 \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/organizations/follow-organizations-beta.md b/translations/ja-JP/data/reusables/organizations/follow-organizations-beta.md new file mode 100644 index 000000000000..99805293aec3 --- /dev/null +++ b/translations/ja-JP/data/reusables/organizations/follow-organizations-beta.md @@ -0,0 +1,5 @@ +{% note %} + +**ノート:** Organizationをフォローする機能は現在パブリックベータであり、変更されることがあります。 + +{% endnote %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/package_registry/authenticate-packages.md b/translations/ja-JP/data/reusables/package_registry/authenticate-packages.md index a766f6e96d9f..5ca4e91584b2 100644 --- a/translations/ja-JP/data/reusables/package_registry/authenticate-packages.md +++ b/translations/ja-JP/data/reusables/package_registry/authenticate-packages.md @@ -4,4 +4,4 @@ You can use a personal access token (PAT) to authenticate to {% data variables.p To authenticate to a {% data variables.product.prodname_registry %} registry within a {% data variables.product.prodname_actions %} workflow, you can use: - `GITHUB_TOKEN` to publish packages associated with the workflow repository. -- a PAT to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). +- a PAT with at least `packages:read` scope to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). diff --git a/translations/ja-JP/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md b/translations/ja-JP/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md deleted file mode 100644 index a54f9a084454..000000000000 --- a/translations/ja-JP/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md +++ /dev/null @@ -1,11 +0,0 @@ -{% ifversion fpt or ghec or ghes > 3.4 %} - -To authenticate to the {% data variables.product.prodname_container_registry %} within a {% data variables.product.prodname_actions %} workflow, use the `GITHUB_TOKEN` for the best security and experience. If your workflow is using a personal access token (PAT) to authenticate to `{% data reusables.package_registry.container-registry-hostname %}`, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. - -{% ifversion fpt or ghec %}For guidance on updating your workflows that authenticate to `{% data reusables.package_registry.container-registry-hostname %}` with a personal access token, see "[Upgrading a workflow that accesses `ghcr.io`](/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions#upgrading-a-workflow-that-accesses-ghcrio)."{% endif %} - -For more information about the `GITHUB_TOKEN`, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)." - -If you're using the {% data variables.product.prodname_container_registry %} in actions, follow our security best practices at "[Security hardening for GitHub Actions](/actions/getting-started-with-github-actions/security-hardening-for-github-actions#considering-cross-repository-access)." - -{% endif %} diff --git a/translations/ja-JP/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md b/translations/ja-JP/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md new file mode 100644 index 000000000000..abaf8530a739 --- /dev/null +++ b/translations/ja-JP/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md @@ -0,0 +1,7 @@ +ワークフローがレジストリでの認証のために個人アクセストークン(PAT)を使っているなら、`GITHUB_TOKEN`を使うようにワークフローを更新することを強くおすすめします。 + +{% ifversion fpt or ghec %}個人アクセストークンでレジストリの認証を受けるワークフローの更新に関するガイダンスとしては、「[レジストリにPATを使ってアクセスするワークフローのアップグレード](/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions#upgrading-a-workflow-that-accesses-a-registry-using-a-pat)」を参照してください。{% endif %} + +`GITHUB_TOKEN`に関する詳しい情報については「[ワークフロー中の認証](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)」を参照してください。 + +アクションでレジストリを使う際のベストプラクティスに関する詳しい情報については「[GitHub Actionsのセキュリティ強化](/actions/getting-started-with-github-actions/security-hardening-for-github-actions#considering-cross-repository-access)」を参照してください。 diff --git a/translations/ja-JP/data/reusables/package_registry/no-graphql-to-delete-packages.md b/translations/ja-JP/data/reusables/package_registry/no-graphql-to-delete-packages.md new file mode 100644 index 000000000000..d3e897adb6aa --- /dev/null +++ b/translations/ja-JP/data/reusables/package_registry/no-graphql-to-delete-packages.md @@ -0,0 +1 @@ +{% ifversion fpt or ghec %}{% data variables.product.prodname_registry %} GraphQL APIはパッケージ名前空間`https://ghcr.io/OWNER/PACKAGE-NAME`を使うコンテナあるいはDockerイメージ、あるいはパッケージ名前空間`https://npm.pkg.github.com/OWNER/PACKAGE-NAME`を使うnpmイメージをサポートしません。{% endif %} \ No newline at end of file diff --git a/translations/ja-JP/data/reusables/package_registry/packages-billing.md b/translations/ja-JP/data/reusables/package_registry/packages-billing.md index b88b95eb4430..598a7f7f2d9c 100644 --- a/translations/ja-JP/data/reusables/package_registry/packages-billing.md +++ b/translations/ja-JP/data/reusables/package_registry/packages-billing.md @@ -1 +1 @@ -{% data variables.product.prodname_registry %}の利用は、パブリックパッケージについては無料です。 For private packages, each account on {% data variables.product.product_location %} receives a certain amount of free storage and data transfer, depending on the product used with the account. 含まれる金額を超える利用については、支出制限によって管理されます。 +{% data variables.product.prodname_registry %}の利用は、パブリックパッケージについては無料です。 プライベートパッケージについては、{% data variables.product.product_location %}上の各アカウントは使用している製品に応じて一定量の無料ストレージとデータ転送を受け取ります。 含まれる金額を超える利用については、支出制限によって管理されます。 diff --git a/translations/ja-JP/data/reusables/package_registry/packages-spending-limit-brief.md b/translations/ja-JP/data/reusables/package_registry/packages-spending-limit-brief.md index 8fba661e5a1a..0bebf688c3b1 100644 --- a/translations/ja-JP/data/reusables/package_registry/packages-spending-limit-brief.md +++ b/translations/ja-JP/data/reusables/package_registry/packages-spending-limit-brief.md @@ -1 +1 @@ -If you are a monthly-billed customer, your account will have a default spending limit of 0 US dollars (USD), which prevents additional usage of storage or data transfer after you reach the included amounts. 請求書でアカウントの支払いを行う場合、アカウントのデフォルトの支払い制限は無制限になります。 +月額料金のお客様の場合、デフォルトではアカウントの料金の上限は0USドル(USD)になっており、含まれている量に達した後に追加でストレージやデータ転送が利用されないようになっています。 請求書でアカウントの支払いを行う場合、アカウントのデフォルトの支払い制限は無制限になります。 diff --git a/translations/ja-JP/data/reusables/package_registry/packages-spending-limit-detailed.md b/translations/ja-JP/data/reusables/package_registry/packages-spending-limit-detailed.md index 1e3465900c4b..e1ee7f9e0e76 100644 --- a/translations/ja-JP/data/reusables/package_registry/packages-spending-limit-detailed.md +++ b/translations/ja-JP/data/reusables/package_registry/packages-spending-limit-detailed.md @@ -1,5 +1,5 @@ {% data reusables.package_registry.packages-spending-limit-brief %} -If you have an unlimited spending limit or a spending limit set higher than $0 USD, you will be billed for any additional storage or data transfer, also called overages, up to your spending limit. アカウントのクーポンは、{% data variables.product.prodname_registry %}の過剰分には適用されません。 +利用上限を無制限としているか、$0 USD以上に利用上限を設定している場合、追加のストレージあるいはデータ転送には、利用上限まで課金されます。これは過剰分と呼ばれます。 アカウントのクーポンは、{% data variables.product.prodname_registry %}の過剰分には適用されません。 {% data reusables.billing.overages-billed-monthly %} diff --git a/translations/ja-JP/data/reusables/package_registry/verify_repository_field.md b/translations/ja-JP/data/reusables/package_registry/verify_repository_field.md index a698129aaade..7dfefe580e41 100644 --- a/translations/ja-JP/data/reusables/package_registry/verify_repository_field.md +++ b/translations/ja-JP/data/reusables/package_registry/verify_repository_field.md @@ -1 +1 @@ -1. プロジェクトの*package.json*中の`repository`フィールドを検証してください。 `repository`フィールドは、{% data variables.product.prodname_dotcom %}リポジトリのURLと一致していなければなりません。 For example, if your repository URL is `github.com/my-org/test` then the repository field should be `https://github.com/my-org/test.git`. +1. プロジェクトの*package.json*中の`repository`フィールドを検証してください。 `repository`フィールドは、{% data variables.product.prodname_dotcom %}リポジトリのURLと一致していなければなりません。 たとえば、あなたのリポジトリのURLが`github.com/my-org/test`なら、repositoryフィールドは`https://github.com/my-org/test.git`でなければなりません。 diff --git a/translations/ja-JP/data/reusables/package_registry/visibility-and-access-permissions.md b/translations/ja-JP/data/reusables/package_registry/visibility-and-access-permissions.md index 2e0980c99e3a..b4f8c05e500c 100644 --- a/translations/ja-JP/data/reusables/package_registry/visibility-and-access-permissions.md +++ b/translations/ja-JP/data/reusables/package_registry/visibility-and-access-permissions.md @@ -2,7 +2,7 @@ あなたが管理者であれば、Organization レベルおよびリポジトリレベルに設定した権限とは別に、コンテナイメージに対してアクセス権限を付与することもできます。 -For container images published and owned by a personal account, you can give any person an access role. Organization が所有し公開しているコンテナイメージには、Organization 内の任意の Team にアクセスロールを付与できます。 +個人アカウントが公開し、所有しているコンテナイメージに対しては、誰にでもアクセスロールを付与できます。 Organization が所有し公開しているコンテナイメージには、Organization 内の任意の Team にアクセスロールを付与できます。 | 権限 | アクセス権の内容 | | ----- | ---------------------------------------------------------------------------------------------------- | diff --git a/translations/ja-JP/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md b/translations/ja-JP/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md index 65e43b5b60df..02dc2de4c3a0 100644 --- a/translations/ja-JP/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md +++ b/translations/ja-JP/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md @@ -1,16 +1,16 @@ -{% ifversion ghes > 3.1 or ghes < 3.5 %} +{% ifversion ghes < 3.5 %} -In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server 3.5 or later may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 when you upgrade from an earlier release to 3.5 or later. A fix for 3.5 and later will be available in an upcoming patch release. +In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server 3.5 or later may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 when you upgrade from an earlier release to 3.5 or later. A fix is available in the [3.5.5](/enterprise-server@3.5/admin/release-notes#3.5.5) and [3.6.1](/enterprise-server@3.6/admin/release-notes#3.6.1) patch releases. -To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). [Updated: 2022-08-16] +To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). [Updated: 2022-09-01] -{% elsif ghes > 3.4 or ghes < 3.7 %} +{% elsif ghes = 3.5 or ghes = 3.6 %} -In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server {{ currentVersion }} may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 as you upgrade to the latest release. To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). +In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server {{ allVersions[currentVersion].currentRelease }} may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 as you upgrade to the latest release. To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). - To display the missing alerts for all repositories owned by an organization, organization owners can navigate to the organization's **Code security and analysis** settings, then click **Enable all** for secret scanning. 詳しい情報については、「[Organization のセキュリティおよび分析設定を管理する](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-existing-repositories)」を参照してください。 - To display the missing alerts for an individual repository, people with admin access to the repository can disable then enable secret scanning for the repository. 詳しい情報については「[リポジトリのセキュリティ及び分析の設定の管理](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)」を参照してください。 -A fix will be available in an upcoming patch release. [Updated: 2022-08-16] +A fix is available in the {% ifversion ghes = 3.5 %}[3.5.5](/admin/release-notes#3.5.5){% elsif ghes = 3.6 %}[3.6.1](/admin/release-notes#3.6.1){% endif %} patch release. [Updated: 2022-09-01] {% endif %} diff --git a/translations/ja-JP/data/variables/actions.yml b/translations/ja-JP/data/variables/actions.yml index 756188416423..0cf389344306 100644 --- a/translations/ja-JP/data/variables/actions.yml +++ b/translations/ja-JP/data/variables/actions.yml @@ -1,2 +1,3 @@ --- azure_portal: 'Azure Portal' +hosted_runner: 'larger runner' diff --git a/translations/ja-JP/data/variables/product.yml b/translations/ja-JP/data/variables/product.yml index 6fbf7da46099..50b0c6e46bb5 100644 --- a/translations/ja-JP/data/variables/product.yml +++ b/translations/ja-JP/data/variables/product.yml @@ -112,6 +112,10 @@ prodname_registry: 'GitHub Packages' prodname_container_registry: 'コンテナレジストリ' prodname_docker_registry_namespace: '{% ifversion fpt or ghec %}`docker.pkg.github.com`{% elsif ghes or ghae %}docker.HOSTNAME{% endif %}' prodname_container_registry_namespace: '{% ifversion fpt or ghec %}`ghcr.io`{% elsif ghes or ghae %}containers.HOSTNAME{% endif %}' +prodname_npm_registry: 'npmレジストリ' +prodname_ghcr_and_npm_registry: '{% data variables.product.prodname_container_registry %}{% ifversion packages-npm-v2 %} and {% data variables.product.prodname_npm_registry %}{% endif %}' +prodname_ghcr_or_npm_registry: '{% data variables.product.prodname_container_registry %}{% ifversion packages-npm-v2 %} or {% data variables.product.prodname_npm_registry %}{% endif %}' +prodname_ghcr_and_npm_registry_full: '{% data variables.product.prodname_container_registry %} (`ghcr.io`){% ifversion packages-npm-v2 %} and {% data variables.product.prodname_npm_registry %} (`npm.pkg.github.com`){% endif %}' #GitHub Insights prodname_insights: 'GitHub Insights' #GitHub Sponsors diff --git a/translations/log/cn-resets.csv b/translations/log/cn-resets.csv index ebbec426ca25..09288b3a635a 100644 --- a/translations/log/cn-resets.csv +++ b/translations/log/cn-resets.csv @@ -20,6 +20,7 @@ translations/zh-CN/content/actions/learn-github-actions/usage-limits-billing-and translations/zh-CN/content/actions/managing-workflow-runs/removing-workflow-artifacts.md,broken liquid tags translations/zh-CN/content/actions/managing-workflow-runs/reviewing-deployments.md,Listed in localization-support#489 translations/zh-CN/content/actions/security-guides/security-hardening-for-github-actions.md,broken liquid tags +translations/zh-CN/content/actions/using-github-hosted-runners/using-larger-runners.md,rendering error translations/zh-CN/content/actions/using-workflows/reusing-workflows.md,rendering error translations/zh-CN/content/actions/using-workflows/storing-workflow-data-as-artifacts.md,broken liquid tags translations/zh-CN/content/actions/using-workflows/using-github-cli-in-workflows.md,broken liquid tags @@ -203,7 +204,6 @@ translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/ins translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/setting-up-github-desktop.md,broken liquid tags translations/zh-CN/content/desktop/installing-and-configuring-github-desktop/overview/creating-your-first-repository-using-github-desktop.md,broken liquid tags translations/zh-CN/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md,broken liquid tags -translations/zh-CN/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md,broken liquid tags translations/zh-CN/content/developers/apps/getting-started-with-apps/about-apps.md,broken liquid tags translations/zh-CN/content/developers/apps/getting-started-with-apps/migrating-oauth-apps-to-github-apps.md,broken liquid tags translations/zh-CN/content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md,broken liquid tags @@ -289,7 +289,6 @@ translations/zh-CN/content/rest/activity/events.md,broken liquid tags translations/zh-CN/content/rest/apps/marketplace.md,broken liquid tags translations/zh-CN/content/rest/enterprise-admin/index.md,broken liquid tags translations/zh-CN/content/rest/guides/basics-of-authentication.md,Listed in localization-support#489 -translations/zh-CN/content/rest/guides/getting-started-with-the-checks-api.md,broken liquid tags translations/zh-CN/content/rest/overview/other-authentication-methods.md,Listed in localization-support#489 translations/zh-CN/content/rest/overview/other-authentication-methods.md,broken liquid tags translations/zh-CN/content/rest/overview/resources-in-the-rest-api.md,Listed in localization-support#489 @@ -379,9 +378,9 @@ translations/zh-CN/data/reusables/enterprise-accounts/emu-short-summary.md,rende translations/zh-CN/data/reusables/enterprise-licensing/verified-domains-license-sync.md,broken liquid tags translations/zh-CN/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md,broken liquid tags translations/zh-CN/data/reusables/enterprise_management_console/badge_indicator.md,broken liquid tags -translations/zh-CN/data/reusables/enterprise_user_management/consider-usernames-for-external-authentication.md,broken liquid tags +translations/zh-CN/data/reusables/enterprise_user_management/consider-usernames-for-external-authentication.md,rendering error translations/zh-CN/data/reusables/gated-features/codespaces-classroom-articles.md,broken liquid tags -translations/zh-CN/data/reusables/gated-features/enterprise-accounts.md,broken liquid tags +translations/zh-CN/data/reusables/gated-features/enterprise-accounts.md,rendering error translations/zh-CN/data/reusables/gated-features/packages.md,broken liquid tags translations/zh-CN/data/reusables/gated-features/secret-scanning-partner.md,broken liquid tags translations/zh-CN/data/reusables/gated-features/secret-scanning.md,broken liquid tags @@ -395,16 +394,15 @@ translations/zh-CN/data/reusables/notifications/vulnerable-dependency-notificati translations/zh-CN/data/reusables/organizations/team-synchronization.md,broken liquid tags translations/zh-CN/data/reusables/package_registry/authenticate-packages.md,broken liquid tags translations/zh-CN/data/reusables/package_registry/authenticate-to-container-registry-steps.md,broken liquid tags -translations/zh-CN/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md,broken liquid tags translations/zh-CN/data/reusables/package_registry/docker_registry_deprecation_status.md,Listed in localization-support#489 translations/zh-CN/data/reusables/package_registry/next-steps-for-packages-enterprise-setup.md,broken liquid tags translations/zh-CN/data/reusables/package_registry/packages-cluster-support.md,broken liquid tags translations/zh-CN/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md,broken liquid tags translations/zh-CN/data/reusables/repositories/enable-security-alerts.md,broken liquid tags translations/zh-CN/data/reusables/repositories/select-marketplace-apps.md,broken liquid tags -translations/zh-CN/data/reusables/saml/saml-session-oauth.md,broken liquid tags +translations/zh-CN/data/reusables/saml/saml-session-oauth.md,rendering error translations/zh-CN/data/reusables/saml/you-must-periodically-authenticate.md,Listed in localization-support#489 -translations/zh-CN/data/reusables/saml/you-must-periodically-authenticate.md,broken liquid tags +translations/zh-CN/data/reusables/saml/you-must-periodically-authenticate.md,rendering error translations/zh-CN/data/reusables/scim/after-you-configure-saml.md,broken liquid tags translations/zh-CN/data/reusables/secret-scanning/enterprise-enable-secret-scanning.md,broken liquid tags translations/zh-CN/data/reusables/secret-scanning/partner-program-link.md,broken liquid tags diff --git a/translations/log/es-resets.csv b/translations/log/es-resets.csv index d561a0b00ff6..277582da38a4 100644 --- a/translations/log/es-resets.csv +++ b/translations/log/es-resets.csv @@ -29,6 +29,7 @@ translations/es-ES/content/actions/quickstart.md,Listed in localization-support# translations/es-ES/content/actions/security-guides/automatic-token-authentication.md,Listed in localization-support#489 translations/es-ES/content/actions/using-github-hosted-runners/about-github-hosted-runners.md,Listed in localization-support#489 translations/es-ES/content/actions/using-github-hosted-runners/customizing-github-hosted-runners.md,Listed in localization-support#489 +translations/es-ES/content/actions/using-github-hosted-runners/using-larger-runners.md,rendering error translations/es-ES/content/actions/using-workflows/workflow-syntax-for-github-actions.md,broken liquid tags translations/es-ES/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance.md,broken liquid tags translations/es-ES/content/admin/configuration/configuring-github-connect/managing-github-connect.md,broken liquid tags diff --git a/translations/log/ja-resets.csv b/translations/log/ja-resets.csv index 3d698baaeeee..adcd5f479c33 100644 --- a/translations/log/ja-resets.csv +++ b/translations/log/ja-resets.csv @@ -214,6 +214,7 @@ translations/ja-JP/content/rest/activity/events.md,broken liquid tags translations/ja-JP/content/rest/apps/oauth-applications.md,broken liquid tags translations/ja-JP/content/rest/enterprise-admin/index.md,broken liquid tags translations/ja-JP/content/rest/guides/getting-started-with-the-rest-api.md,broken liquid tags +translations/ja-JP/content/rest/quickstart.md,broken liquid tags translations/ja-JP/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md,broken liquid tags translations/ja-JP/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md,broken liquid tags translations/ja-JP/content/support/learning-about-github-support/about-github-premium-support.md,broken liquid tags @@ -330,7 +331,6 @@ translations/ja-JP/data/reusables/marketplace/install-buy.md,broken liquid tags translations/ja-JP/data/reusables/organizations/team-synchronization.md,broken liquid tags translations/ja-JP/data/reusables/package_registry/authenticate-packages.md,broken liquid tags translations/ja-JP/data/reusables/package_registry/authenticate-to-container-registry-steps.md,broken liquid tags -translations/ja-JP/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md,broken liquid tags translations/ja-JP/data/reusables/package_registry/container-registry-ghes-beta.md,broken liquid tags translations/ja-JP/data/reusables/package_registry/container-registry-migration-namespaces.md,broken liquid tags translations/ja-JP/data/reusables/package_registry/next-steps-for-packages-enterprise-setup.md,broken liquid tags diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md index 05d5314ecf16..f934ef389ca1 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md @@ -93,7 +93,7 @@ Como alternativa, se você quiser usar o protocolo HTTPS para ambas as contas, v Se você quiser usar o protocolo SSH para ambas as contas, você poderá usar chaves SSH diferentes para cada conta. Para obter mais informações sobre como usar SSH, consulte "[Conectando a {% data variables.product.prodname_dotcom %} com SSH](/authentication/connecting-to-github-with-ssh)". -To use a different SSH key for different repositories that you clone to your workstation, you must write a shell wrapper function for Git operations. A função deve executar as seguintes etapas. +Para usar uma chave SSH diferente para diferentes repositórios que você clonar na sua estação de trabalho, você deve escrever uma função de wrapper do shell para operações do Git. A função deve executar as seguintes etapas. 1. Determine o nome completo do repositório com proprietário, usando um comando como `git config --get remote.origin.url`. 2. Escolha a chave SSH correta para autenticação. 3. Modifique `GIT_SSH_COMMAND` apropriadamente. Para obter mais informações sobre `GIT_SSH_COMMAND`, consulte [Variáveis de Ambiente](https://git-scm.com/docs/git#Documentation/git.txt-codeGITSSHCOMMANDcode) na documentação do Git. diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md index b7f575a12a3b..aab9ad3b60ca 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md @@ -14,7 +14,7 @@ versions: ghec: '*' topics: - Accounts -shortTitle: Merge multiple accounts +shortTitle: Fazer merge de múltiplas contas --- {% tip %} diff --git a/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md b/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md index 248947bb43d9..869340012d82 100644 --- a/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md +++ b/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md @@ -147,11 +147,11 @@ Com o OIDC, um fluxo de trabalho de {% data variables.product.prodname_actions % As reivindicações de Audiência e Assunto são normalmente usadas em combinação, ao definir as condições da função/recursos em nuvem para definir o escopo do seu acesso aos fluxos de trabalho do GitHub. - **Audiência**: Por padrão, esse valor usa a URL do proprietário da organização ou do repositório. Isto pode ser usado para definir uma condição para que apenas os fluxos de trabalho na organização específica possam acessar a função da nuvem. -- **Assunto**: Tem um formato predefinido e é uma concatenação de alguns dos metadados da chave sobre o fluxo de trabalho como, por exemplo, a organização, repositório, branch de {% data variables.product.prodname_dotcom %} ou [`trabalho`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idenvironment) associado. Consulte "[Exemplo de assunto reivindica](#example-subject-claims)" para ver como a reivindicação de assunto é montada a partir de metadados concatenados. +- **Subject**: By default, has a predefined format and is a concatenation of some of the key metadata about the workflow, such as the {% data variables.product.prodname_dotcom %} organization, repository, branch, or associated [`job`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idenvironment) environment. Consulte "[Exemplo de assunto reivindica](#example-subject-claims)" para ver como a reivindicação de assunto é montada a partir de metadados concatenados. -Há também muitas reivindicações adicionais compatíveis com o token do OIDC que também podem ser usadas para definir essas condições. +If you need more granular trust conditions, you can customize the issuer (`iss`) and subject (`sub`) claims that are included with the JWT. For more information, see "[Customizing the token claims](#customizing-the-token-claims)". -Além disso, seu provedor de nuvem poderia permitir que você atribuísse uma função aos tokens de acesso, permitindo que você especifique ainda mais permissões granulares. +There are also many additional claims supported in the OIDC token that can be used for setting these conditions. Além disso, seu provedor de nuvem poderia permitir que você atribuísse uma função aos tokens de acesso, permitindo que você especifique ainda mais permissões granulares. {% note %} @@ -245,9 +245,13 @@ curl -H "Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" "$ACTIONS_ID_TOK {% ifversion actions-oidc-hardening-config %} ## Personalizando as reivindicações de token -Você pode garantir a segurança da sua configuração do OIDC personalizando as reivindicações incluídas com a JWT. Isso permite que seu provedor de nuvem aplique mais condições de confiança granular ao determinar se concede acesso a seus recursos. Por exemplo, {% ifversion ghec %}você pode personalizar que o a reivindicação do emissor (`iss`) para apenas permitir acesso a uma URL corporativa específica e {% endif %}é possível personalizar o valor do assunto (`sub`) para exigir que as solicitações sejam originárias de um repositório específico, fluxo de trabalho reutilizável ou outra fonte. +Você pode garantir a segurança da sua configuração do OIDC personalizando as reivindicações incluídas com a JWT. These customisations allow you to define more granular trust conditions on your cloud roles when allowing your workflows to access resources hosted in the cloud: -Para configurar as condições de reivindicação em {% data variables.product.prodname_dotcom %}, você pode usar os pontos de extremidade da REST API descritos nas seguintes seções. +{% ifversion ghec %} - For an additional layer of security, you can append the `issuer` url with your enterprise slug. This lets you set conditions on the issuer (`iss`) claim, configuring it to only accept JWT tokens from a unique `issuer` URL that must include your enterprise slug.{% endif %} +- You can standardize your OIDC configuration by setting conditions on the subject (`sub`) claim that require JWT tokens to originate from a specific repository, reusable workflow, or other source. +- You can define granular OIDC policies by using additional OIDC token claims, such as `repository_id` and `repo_visibility`. Para obter mais informações, consulte "[Compreendendo o token do OIDC](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#understanding-the-oidc-token)". + +To customize these claim formats, organization and repository admins can use the REST API endpoints described in the following sections. {% ifversion ghec %} @@ -282,19 +286,21 @@ Depois que esta configuração for aplicada, o JWT conterá o valor atualizado d Para configurar a segurança, conformidade e padronização em toda a organização, você pode personalizar as reivindicações padrão que atendem às suas condições de acesso necessárias. Se seu provedor de nuvem é compatível com condições para reivindicações de objetos, você pode criar uma condição que verifica se o valor `sub` corresponde ao caminho do fluxo de trabalho reutilizável, como `"job_workflow_ref: "octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main""`. O formato exato irá variar dependendo da configuração do OIDC do seu provedor de nuvem. Para configurar a condição de correspondência em {% data variables.product.prodname_dotcom %}, você pode usar a API REST para exigir que a reivindicação do `sub` deva sempre incluir uma reivindicação personalizada, como `job_workflow_ref`. Para obter mais informações, consulte "[Definir o modelo de personalização para uma reivindicação de assunto do OIDC para uma organização](/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization)". +Customizing the claims results in a new format for the entire `sub` claim, which replaces the default predefined `sub` format in the token described in "[Example subject claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims)." + Os modelos de exemplo a seguir demonstram várias maneiras de personalizar a reivindicação de assunto. Para configurar estas configurações em {% data variables.product.prodname_dotcom %}, os administradores da organização usam a API REST para especificar uma lista de reclamações que devem ser incluídas no assunto (`sub`) da reclamação. {% data reusables.actions.use-request-body-api %} -Para personalizar suas reivindicações de assunto, você deve primeiro criar uma condição de correspondência na configuração do OIDC do seu provedor de nuvem, antes de adicionar a configuração usando a API REST. Uma vez que a configuração estiver concluída, cada vez que um novo trabalho for executado, o token do OIDC gerado durante aquele trabalho seguirá o novo modelo de personalização. Se a condição de correspondência não existir na configuração do OIDC do provedor de nuvem antes de o trabalho ser executado, o token gerado poderá não ser aceito pelo provedor da nuvem, já que as condições da nuvem podem não ser sincronizadas. +To customize your subject claims, you should first create a matching condition in your cloud provider's OIDC configuration, before customizing the configuration using the REST API. Uma vez que a configuração estiver concluída, cada vez que um novo trabalho for executado, o token do OIDC gerado durante aquele trabalho seguirá o novo modelo de personalização. Se a condição de correspondência não existir na configuração do OIDC do provedor de nuvem antes de o trabalho ser executado, o token gerado poderá não ser aceito pelo provedor da nuvem, já que as condições da nuvem podem não ser sincronizadas. {% note %} -**Observação**: Quando o modelo de organização é aplicado, ele não afetará nenhum repositório existente que já usa o OIDC. Para novos repositórios criados depois que o modelo for aplicado, o proprietário do repositório deverá optar por receber esta configuração. Para obter mais informações, consulte "[Definir o sinalizador da opção de participação da personalização da reivindicação de assunto do OIDC para um repositório](/rest/actions/oidc#set-the-opt-in-flag-of-an-oidc-subject-claim-customization-for-a-repository)". +**Observação**: Quando o modelo de organização é aplicado, ele não afetará nenhum repositório existente que já usa o OIDC. For existing repositories, as well as any new repositories that are created after the template has been applied, the repository owner will need to opt-in to receive this configuration. Para obter mais informações, consulte "[Definir o sinalizador da opção de participação da personalização da reivindicação de assunto do OIDC para um repositório](/rest/actions/oidc#set-the-opt-in-flag-of-an-oidc-subject-claim-customization-for-a-repository)". {% endnote %} #### Exemplo: Permitir o repositório com base na visibilidade e no proprietário -Este modelo de exemplo habilita o acesso de nuvem com base na visibilidade e proprietário do repositório, permitindo que você restrinja o acesso a repositórios privados em uma organização ou empresa. {% data reusables.actions.use-request-body-api %} +This example template allows the `sub` claim to have a new format, using `repository_owner` and `repository_visibility`: ```json { @@ -305,11 +311,11 @@ Este modelo de exemplo habilita o acesso de nuvem com base na visibilidade e pro } ``` -Na configuração OIDC do seu provedor de nuvem, configure a condição `sub` para exigir que as reivindicações inculam valores específicos para `repository_owner` e `repository_visibility`. Por exemplo: `"repository_owner: "monalisa":repository_visibility:private"`. +Na configuração OIDC do seu provedor de nuvem, configure a condição `sub` para exigir que as reivindicações inculam valores específicos para `repository_owner` e `repository_visibility`. Por exemplo: `"repository_owner: "monalisa":repository_visibility:private"`. The approach lets you restrict cloud role access to only private repositories within an organization or enterprise. #### Exemplo: Permitir acesso a todos os repositórios com um proprietário específico -Este modelo de exemplo concede acesso a todos os repositórios com um repositório `repository_owner` especificado. {% data reusables.actions.use-request-body-api %} +This example template enables the `sub` claim to have a new format with only the value of `repository_owner`. {% data reusables.actions.use-request-body-api %} ```json { @@ -324,7 +330,9 @@ Na configuração OIDC do seu provedor de nuvem, configure a condição `sub` pa #### Exemplo: Exigindo um fluxo de trabalho reutilizável -Este modelo de exemplo exige um fluxo de trabalho reutilizável específico em uma reivindicação, permitindo que uma empresa implique implantações consistentes em suas empresas, organizações e repositórios. {% data reusables.actions.use-request-body-api %} +This example template allows the `sub` claim to have a new format that contains the value of the `job_workflow_ref` claim. This enables an enterprise to use [reusable workflows](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims) to enforce consistent deployments across its organizations and repositories. + +{% data reusables.actions.use-request-body-api %} ```json { @@ -338,7 +346,9 @@ Na configuração OIDC do seu provedor de nuvem, configure a condição `sub` pa #### Exemplo: Exigindo um fluxo de trabalho reutilizável e outras reivindicações -Este modelo de exemplo combina o requisito de um fluxo de trabalho específico reutilizável com reclamações adicionais. {% data reusables.actions.use-request-body-api %} +The following example template combines the requirement of a specific reusable workflow with additional claims. {% data reusables.actions.use-request-body-api %} + +This example also demonstrates how to use `"context"` to define your conditions. This is the part that follows the repository in the [default `sub` format](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims). For example, when the job references an environment, the context contains: `environment:`. ```json { @@ -352,6 +362,8 @@ Este modelo de exemplo combina o requisito de um fluxo de trabalho específico r Na configuração OIDC do seu provedor de nuvem, configure a condição `sub` para exigir que as reivindicações inculam valores específicos para `repo`, `context` e `job_workflow_ref`. +This customization template requires that the `sub` uses the following format: `repo::environment::job_workflow_ref:`. For example: `"sub": "repo:octo-org/octo-repo:environment:prod:job_workflow_ref:octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main"` + #### Exemplo: Conceder acesso a um repositório específico Este modelo de exemplo permite conceder acesso na nuvem a todos os fluxos de trabalho em um repositório específico, em todos os branches, tags e ambientes. Para ajudar a melhorar a segurança, combine este modelo com a URL do emissor personalizado descrita em "[Personalizando a URL do token para uma empresa](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-url-for-an-enterprise)." diff --git a/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md b/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md index 92913fb61b0a..4d4813187108 100644 --- a/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md +++ b/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md @@ -23,11 +23,18 @@ topics: Em vez de copiar e colar trabalhos de implantação de um fluxo de trabalho para outro, é possível criar um fluxo de trabalho reutilizável que executa as etapas de implantação. Um fluxo de trabalho reutilizável pode ser usado por outro fluxo de trabalho se ele cumprir um dos requisitos de acesso descritos em "[Reutilizando os fluxos de trabalho](/actions/learn-github-actions/reusing-workflows#access-to-reusable-workflows)". -Quando combinado com o OpenID Connect (OIDC), os fluxos de trabalho reutilizáveis permitem que você aplique implantações consistentes no seu repositório, organização ou empresa. Você pode fazer isso definindo condições de confiança nas funções da nuvem com base em fluxos de trabalho reutilizáveis. +You should be familiar with the concepts described in "\[Reusing workflows\](/actions/learn-github-actions/reusing-workflows" and "[About security hardening with OpenID Connect](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)." -Para criar condições de confiança com base em fluxos de trabalho reutilizáveis, o seu provedor de nuvem deve ser compatível com reivindicações personalizadas para `job_workflow_ref`. Isso permite que seu provedor de nuvem identifique de qual repositório veio originalmente. Se o seu provedor de nuvem é compatível apenas as reivindicações padrão (_audiência_ e _assunto_), não poderá determinar que o trabalho teve origem no repositório do fluxo de trabalho reutilizável. Os provedores de nuvem que sao compatíveis com `job_workflow_ref` incluem Google Cloud Platform e HashiCorp Vault. +## Defining the trust conditions -Antes de prosseguir, você deve estar familiarizado com os conceitos de [fluxos de trabalho reutilizáveis](/actions/learn-github-actions/reusing-workflows) e [OpenID Connect](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect). +Quando combinado com o OpenID Connect (OIDC), os fluxos de trabalho reutilizáveis permitem que você aplique implantações consistentes no seu repositório, organização ou empresa. Você pode fazer isso definindo condições de confiança nas funções da nuvem com base em fluxos de trabalho reutilizáveis. The available options will vary depending on your cloud provider: + +- **Using `job_workflow_ref`**: + - To create trust conditions based on reusable workflows, your cloud provider must support custom claims for `job_workflow_ref`. Isso permite que seu provedor de nuvem identifique de qual repositório veio originalmente. + - For clouds that only support the standard claims (audience (`aud`) and subject (`sub`)), you can use the API to customize the `sub` claim to include `job_workflow_ref`. For more information, see "[Customizing the token claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-claims)". Support for custom claims is currently available for Google Cloud Platform and HashiCorp Vault. + +- **Customizing the token claims**: + - You can configure more granular trust conditions by customizing the issuer (`iss`) and subject (`sub`) claims included with the JWT. For more information, see "[Customizing the token claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-claims)". ## Como o token funciona com fluxos de trabalho reutilizáveis diff --git a/translations/pt-BR/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md b/translations/pt-BR/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md index 6cfca875f74c..b6f83dd5c5b9 100644 --- a/translations/pt-BR/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md +++ b/translations/pt-BR/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md @@ -18,15 +18,23 @@ shortTitle: Executar o executor ao iniciar {% capture service_first_step %}1. Pare o aplicativo do executor auto-hospedado se estiver em execução no momento.{% endcapture %} {% capture service_non_windows_intro_shell %}Na máquina, abra um shell no diretório onde você instalou o aplicativo do executor auto-hospedado. Use os comandos abaixo para instalar e gerenciar o serviço do executor auto-hospedado.{% endcapture %} -{% capture service_nonwindows_intro %}Você deve adicionar um executor a {% data variables.product.product_name %} antes de poder configurar o aplicativo do executor auto-hospedado um serviço. Para obter mais informações, consulte "[Adicionando executores auto-hospedados](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)".{% endcapture %} -{% capture service_win_name %}actions.runner.*{% endcapture %} +{% capture service_nonwindows_intro %} + +{% note %} + +**Observação:** Você precisa adicionar um executor a {% data variables.product.product_name %} antes de poder configurar o aplicativo do executor auto-hospedado como um serviço. Para obter mais informações, consulte "[Adicionando executores auto-hospedados](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)". + +{% endnote %} +{% endcapture %} + +{% capture service_win_name %}actions.runner.*{% endcapture %} {% linux %} {{ service_nonwindows_intro }} -Para os sistemas Linux que usam o `systemd`, você pode usar o script `svc. h` distribuído com o aplicativo do executor auto-hospedado para instalação e gerenciamento usando o aplicativo como um serviço. +Para sistemas Linux que usam `systemd`, você pode usar o `svc.sh` que é criado após adicionar com sucesso o executor para instalar e gerenciar usar o aplicativo como um serviço. {{ service_non_windows_intro_shell }} diff --git a/translations/pt-BR/content/actions/learn-github-actions/contexts.md b/translations/pt-BR/content/actions/learn-github-actions/contexts.md index c690946514d6..9be283a94da3 100644 --- a/translations/pt-BR/content/actions/learn-github-actions/contexts.md +++ b/translations/pt-BR/content/actions/learn-github-actions/contexts.md @@ -39,7 +39,7 @@ Você pode acessar contextos usando a sintaxe da expressão. Para obter mais inf | `env` | `objeto` | Contém variáveis de ambiente definidas em um fluxo de trabalho, trabalho ou etapa. Para obter mais informações, consulte o contexto [`env`](#env-context). | | `trabalho` | `objeto` | Informações sobre o trabalho atualmente em execução. Para obter mais informações, consulte [contexto `trabalho`](#job-context). | {%- ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} -| `jobs` | `object` | Para apenas para fluxos de trabalho reutilizáveis, contém saídas de trabalhos do fluxo de trabalho reutilizável. For more information, see [`jobs` context](#jobs-context). |{% endif %} | `steps` | `object` | Information about the steps that have been run in the current job. Para obter mais informações, consulte [contexto `etapas`](#steps-context). | | `runner` | `object` | Information about the runner that is running the current job. Para obter mais informações, consulte [`runner` context](#runner-context). | | `secrets` | `object` | Contains the names and values of secrets that are available to a workflow run. Para obter mais informações, consulte o contexto [`segredos`](#secrets-context). | | `strategy` | `object` | Information about the matrix execution strategy for the current job. Para obter mais informações, consulte o contexto [`estratégia`](#strategy-context). | | `matrix` | `object` | Contains the matrix properties defined in the workflow that apply to the current job. Para obter mais informações, consulte o contexto [`matriz`](#matrix-context). | | `needs` | `object` | Contains the outputs of all jobs that are defined as a dependency of the current job. Para obter mais informações, consulte o contexto [`needs`](#needs-context). | +| `jobs` | `object` | Para apenas para fluxos de trabalho reutilizáveis, contém saídas de trabalhos do fluxo de trabalho reutilizável. Para obter mais informações, consulte [contexto `trabalhos`](#jobs-context). |{% endif %} | `steps` | `object` | Informações sobre as etapas que foram executadas no trabalho atual. Para obter mais informações, consulte [contexto `etapas`](#steps-context). | | `runner` | `object` | Informações sobre o executor que está executando o trabalho atual. Para obter mais informações, consulte [`runner` context](#runner-context). | | `segredos` | `objeto` | Contém os nomes e valores dos segredos que estão disponíveis para uma execução de fluxo de trabalho. Para obter mais informações, consulte o contexto [`segredos`](#secrets-context). | | `strategy` | `object` | Informações sobre a estratégia de execução da matriz para o trabalho atual. Para obter mais informações, consulte o contexto [`estratégia`](#strategy-context). | | `strategy` | `object` | Contém as propriedades da matriz definidas no fluxo de trabalho que se aplicam ao trabalho atual. Para obter mais informações, consulte o contexto [`matriz`](#matrix-context). | | `needs` | `object` | Contém os resultados de todos os trabalhos que são definidos como uma dependência do trabalho atual. Para obter mais informações, consulte o contexto [`needs`](#needs-context). | {%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-4757 %} | `entradas` | `objeto` | Contém as entradas de {% ifversion actions-unified-inputs %} reutilizável ou um fluxo de travalho acionado {% endif %} manualmente. Para obter mais informações, consulte o contexto [`entradas`](#inputs-context). |{% endif %} @@ -388,20 +388,20 @@ jobs: {% ifversion fpt or ghes > 3.3 or ghae-issue-4757 or ghec %} -## `jobs` context +## contexto `trabalhos` -The `jobs` context is only available in reusable workflows, and can only be used to set outputs for a reusable workflow. Para obter mais informações, consulte "[Reutilizando fluxos de trabalho](/actions/using-workflows/reusing-workflows#using-outputs-from-a-reusable-workflow)". +O contexto `trabalhos` só está disponível em fluxos de trabalho reutilizáveis e só pode ser usado para definir saídas para um fluxo de trabalho reutilizável. Para obter mais informações, consulte "[Reutilizando fluxos de trabalho](/actions/using-workflows/reusing-workflows#using-outputs-from-a-reusable-workflow)". -| Nome da propriedade | Tipo | Descrição | -| ------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `jobs` | `objeto` | This is only available in reusable workflows, and can only be used to set outputs for a reusable workflow. Este objeto contém todas as propriedades listadas abaixo. | -| `jobs..result` | `string` | The result of a job in the reusable workflow. Os valores possíveis são: `sucesso`, `falha`, `cancelado`ou `ignorado`. | -| `jobs..outputs` | `objeto` | The set of outputs of a job in a reusable workflow. | -| `jobs..outputs.` | `string` | The value of a specific output for a job in a reusable workflow. | +| Nome da propriedade | Tipo | Descrição | +| ------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `jobs` | `objeto` | Isso só está disponível em fluxos de trabalho reutilizáveis e só pode ser usado para definir saídas para um fluxo de trabalho reutilizável. Este objeto contém todas as propriedades listadas abaixo. | +| `jobs..result` | `string` | O resultado de um trabalho no fluxo de trabalho reutilizável. Os valores possíveis são: `sucesso`, `falha`, `cancelado`ou `ignorado`. | +| `jobs..outputs` | `objeto` | O conjunto de resultados de um trabalho em um fluxo de trabalho reutilizável. | +| `jobs..outputs.` | `string` | O valor de uma saída específica para um trabalho em um fluxo de trabalho reutilizável. | -### Example contents of the `jobs` context +### Exemplo de conteúdo do contexto `trabalhos` -This example `jobs` context contains the result and outputs of a job from a reusable workflow run. +Este exemplo do contexto `trabalhos` contém o resultado e as saídas de um trabalho de uma execução reutilizável. ```json { @@ -415,9 +415,9 @@ This example `jobs` context contains the result and outputs of a job from a reus } ``` -### Example usage of the `jobs` context +### Exemplo de uso do contexto `trabalhos` -This example reusable workflow uses the `jobs` context to set outputs for the reusable workflow. Note how the outputs flow up from the steps, to the job, then to the `workflow_call` trigger. Para obter mais informações, consulte "[Reutilizando fluxos de trabalho](/actions/using-workflows/reusing-workflows#using-outputs-from-a-reusable-workflow)". +Este exemplo de fluxo de trabalho reutilizável usa o contexto `trabalhos` para definir saídas para o fluxo de trabalho reutilizável. Observe como as saídas fluem das etapas, para o trabalho, e depois para o gatilho `workflow_call`. Para obter mais informações, consulte "[Reutilizando fluxos de trabalho](/actions/using-workflows/reusing-workflows#using-outputs-from-a-reusable-workflow)". {% raw %} ```yaml{:copy} diff --git a/translations/pt-BR/content/actions/learn-github-actions/environment-variables.md b/translations/pt-BR/content/actions/learn-github-actions/environment-variables.md index 44424bb14bff..e09c667b33a4 100644 --- a/translations/pt-BR/content/actions/learn-github-actions/environment-variables.md +++ b/translations/pt-BR/content/actions/learn-github-actions/environment-variables.md @@ -155,7 +155,7 @@ As variáveis de ambiente padrão que os conjuntos de {% data variables.product. {%- ifversion actions-runner-arch-envvars %} | `RUNNER_ARCH` | {% data reusables.actions.runner-arch-description %} {%- endif %} -| `RUNNER_DEBUG` | {% data reusables.actions.runner-debug-description %} | | `RUNNER_NAME` | {% data reusables.actions.runner-name-description %} For example, `Hosted Agent` | | `RUNNER_OS` | {% data reusables.actions.runner-os-description %} For example, `Windows` | | `RUNNER_TEMP` | {% data reusables.actions.runner-temp-directory-description %} For example, `D:\a\_temp` | +| `RUNNER_DEBUG` | {% data reusables.actions.runner-debug-description %} | | `RUNNER_NAME` | {% data reusables.actions.runner-name-description %} Por exemplo, `Hosted Agent` | | `RUNNER_OS` | {% data reusables.actions.runner-os-description %} Por exemplo, `Windows` | | `RUNNER_TEMP` | {% data reusables.actions.runner-temp-directory-description %} Por exemplo, `D:\a\_temp` | {% ifversion not ghae %}| `RUNNER_TOOL_CACHE` | {% data reusables.actions.runner-tool-cache-description %} For example, `C:\hostedtoolcache\windows` |{% endif %} {% note %} diff --git a/translations/pt-BR/content/actions/publishing-packages/publishing-nodejs-packages.md b/translations/pt-BR/content/actions/publishing-packages/publishing-nodejs-packages.md index fe4d0d6280e1..4a255f1e276c 100644 --- a/translations/pt-BR/content/actions/publishing-packages/publishing-nodejs-packages.md +++ b/translations/pt-BR/content/actions/publishing-packages/publishing-nodejs-packages.md @@ -98,9 +98,9 @@ Cada vez que você criar uma nova versão, você poderá acionar um fluxo de tra ### Configurar o repositório de destino -Se você não fornecer a chave do `repositório` no seu arquivo *package.json*, {% data variables.product.prodname_registry %} irá publicar um pacote no repositório de {% data variables.product.prodname_dotcom %} especificado no campo `nome` do arquivo *package.json*. Por exemplo, um pacote denominado `@my-org/test` é publicado no `my-org/test` repositório de {% data variables.product.prodname_dotcom %}. +Vincular o seu pacote ao {% data variables.product.prodname_registry %} usando a chave do repositório `` é opcional. Se você optar por não fornecer a chave do `repositório` no seu arquivo *package.json*, {% data variables.product.prodname_registry %} irá publicar um pacote no repositório de {% data variables.product.prodname_dotcom %} especificado no campo `nome` do arquivo *package.json*. Por exemplo, um pacote denominado `@my-org/test` é publicado no `my-org/test` repositório de {% data variables.product.prodname_dotcom %}. Se a `url` especificada na chave do `repositório` é inválida, seu pacote ainda poderá ser publicado. No entanto ele não será vinculado à fonte do repositório, como esperado. -No entanto, se você fornecer a chave `repositório`, o repositório nessa chave será usado como o registro de npm de destino para {% data variables.product.prodname_registry %}. Por exemplo, publicar os resultados *package.json* abaixo em um pacote denominado `my-amazing-package` publicado no repositório `octocat/meu-repo` de {% data variables.product.prodname_dotcom %}. +Se você fornecer a chave do `repositório` no seu arquivo *package.json*, posteriormente, o repositório nessa chave será usado como registro npm de destino para {% data variables.product.prodname_registry %}. Por exemplo, publicar os resultados *package.json* abaixo em um pacote denominado `my-amazing-package` publicado no repositório `octocat/meu-repo` de {% data variables.product.prodname_dotcom %}. Uma vez publicada, apenas a fonte do repositório é atualizada, e o pacote não herda nenhuma permissão do repositório de destino. ```json { diff --git a/translations/pt-BR/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md b/translations/pt-BR/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md index 50c035a24144..be0cae175a14 100644 --- a/translations/pt-BR/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md +++ b/translations/pt-BR/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md @@ -51,7 +51,7 @@ Para obter mais informações sobre artefatos da execução do fluxo de trabalho Um fluxo de trabalho pode acessar e restaurar um cache criado no branch atual, no branch de base (incluindo branches base de repositórios bifurcados) ou no branch-padrão (geralmente `principal`). Por exemplo, um cache criado no branch-padrão pode ser acessado a partir de qualquer pull request. Além disso, se o branch `feature-b` tiver o branch de base `feature-a`, um fluxo de trabalho acionado em `feature-b` teria acesso a caches criados no branch-padrão (`principal`), `feature-a` e `feature-b`. -As restrições de acesso fornecem o isolamento da cache e a segurança ao criar um limite lógico entre os diferentes branches. Por exemplo, um cache criado para o branch `feature-a` (com a base no `principal`) não seria acessível para um pull request para o branch `feature-b` (com a base no `principal`). +Access restrictions provide cache isolation and security by creating a logical boundary between different branches or tags. Por exemplo, um cache criado para o branch `feature-a` (com a base no `principal`) não seria acessível para um pull request para o branch `feature-b` (com a base no `principal`). On similar lines, a cache created for the tag `release-a` (from the base `main`) would not be accessible to a workflow triggered for the tag `release-b` (with the base `main`). Vários fluxos de trabalho dentro de um repositório compartilham entradas de cache. Uma cache criada para um branch de um fluxo de trabalho pode ser acessada e restaurada a partir de outro fluxo de trabalho para o mesmo repositório e branch. diff --git a/translations/pt-BR/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md b/translations/pt-BR/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md index aeaa44588ddc..6bad5f0002e5 100644 --- a/translations/pt-BR/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md +++ b/translations/pt-BR/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md @@ -44,7 +44,8 @@ Você configurou o fluxo do log de auditoria em {% data variables.product.produc - [Amazon S3](#setting-up-streaming-to-amazon-s3) - [Armazenamento do Azure Blob](#setting-up-streaming-to-azure-blob-storage) -- [Centros de evento do Azure](#setting-up-streaming-to-azure-event-hubs) +- [Azure Event Hubs](#setting-up-streaming-to-azure-event-hubs){% ifversion streaming-datadog %} +- [Datadog](#setting-up-streaming-to-datadog){% endif %} - [Armazenamento do Google Cloud](#setting-up-streaming-to-google-cloud-storage) - [Splunk](#setting-up-streaming-to-splunk) @@ -231,6 +232,32 @@ Você precisa de duas informações sobre seu centro de eventos: o nome da sua i {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} +{% ifversion streaming-datadog %} +### Setting up streaming to Datadog + +To set up streaming to Datadog, you must create a client token or an API key in Datadog, then configure audit log streaming in {% data variables.product.product_name %} using the token for authentication. You do not need to create a bucket or other storage container in Datadog. + +After you set up streaming to Datadog, you can see your audit log data by filtering by "github.audit.streaming." For more information, see [Log Management](https://docs.datadoghq.com/logs/). + +1. If you don't already have a Datadog account, create one. +1. In Datadog, generate a client token or an API key, then click **Copy key**. For more information, see [API and Application Keys](https://docs.datadoghq.com/account_management/api-app-keys/) in Datadog Docs. +{% data reusables.enterprise.navigate-to-log-streaming-tab %} +1. Select the **Configure stream** dropdown menu and click **Datadog**. + + ![Screenshot of the "Configure stream" dropdown menu with "Datadog" highlighted](/assets/images/help/enterprises/audit-stream-choice-datadog.png) +1. Under "Token", paste the token you copied earlier. + + ![Screenshot of the "Token" field](/assets/images/help/enterprises/audit-stream-datadog-token.png) +1. Select the "Site" dropdown menu and click your Datadog site. To determine your Datadog site, compare your Datadog URL to the table in [Datadog sites](https://docs.datadoghq.com/getting_started/site/) in Datadog Docs. + + ![Screenshot of the "Site" dropdown menu](/assets/images/help/enterprises/audit-stream-datadog-site.png) +1. To verify that {% data variables.product.prodname_dotcom %} can connect and write to the Datadog endpoint, click **Check endpoint**. + + ![Verificar o ponto de extremidade](/assets/images/help/enterprises/audit-stream-check.png) +{% data reusables.enterprise.verify-audit-log-streaming-endpoint %} +1. After a few minutes, confirm that audit log data is appearing on the **Logs** tab in Datadog. If audit log data is not appearing, confirm that your token and site are correct in {% data variables.product.prodname_dotcom %}. +{% endif %} + ### Configurando a transmissão para o Google Cloud Storage Para configurar a transmissão para o Google Cloud Storage, você deve criar uma conta de serviço no Google Cloud com as credenciais e permissões apropriadas e, em seguida, configurar a transmissão do log de auditoria em {% data variables.product.product_name %} usando as credenciais da conta de serviço para autenticação. @@ -291,6 +318,10 @@ Para transmitir os logs de auditoria para o Coletor de Eventos HTTP (HEC) do Spl A pausa da transmissão permite que você execute a manutenção no aplicativo de recebimento sem perder dados de auditoria. Os logs de auditoria são armazenados por até sete dias em {% data variables.product.product_location %} e, em seguida, são exportados quando você suspender a pausa da transmissão. +{% ifversion streaming-datadog %} +Datadog only accepts logs from up to 18 hours in the past. If you pause a stream to a Datadog endpoint for more than 18 hours, you risk losing logs that Datadog won't accept after you resume streaming. +{% endif %} + {% data reusables.enterprise.navigate-to-log-streaming-tab %} 1. Clique **Pausar transmissão**. diff --git a/translations/pt-BR/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md b/translations/pt-BR/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md index 1ef90d2220e1..9a1c399fb294 100644 --- a/translations/pt-BR/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md +++ b/translations/pt-BR/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md @@ -79,6 +79,8 @@ Você também pode configurar endereços IP permitidos para uma organização in {% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %} +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} diff --git a/translations/pt-BR/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md b/translations/pt-BR/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md index a4af5448ea3e..37449ac202b6 100644 --- a/translations/pt-BR/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md +++ b/translations/pt-BR/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md @@ -29,11 +29,11 @@ topics: {% data reusables.command_line.open_the_multi_os_terminal %} 3. Gere um par de chaves GPG. Já que existem várias versões do GPG, é possível que você tenha de consultar a [_página man_](https://en.wikipedia.org/wiki/Man_page) relevante para encontrar o comando de geração de chaves apropriado. A sua chave deve usar RSA. - Se a sua versão for 2.1.17 ou posterior, cole o texto abaixo para gerar um par de chaves GPG. - ```shell + ```shell{:copy} $ gpg --full-generate-key ``` - Se a sua versão não for 2.1.17 ou posterior, o comando `gpg --full-generate-key` não funcionará. Cole o texto abaixo e passe para a etapa 6. - ```shell + ```shell{:copy} $ gpg --default-new-key-algo rsa4096 --gen-key ``` 4. Mediante instrução, especifique o tipo de tecla que você deseja ou pressione `Enter` para aceitar o padrão. @@ -52,10 +52,10 @@ topics: {% data reusables.gpg.list-keys-with-note %} {% data reusables.gpg.copy-gpg-key-id %} 10. Cole o texto abaixo, substituindo o ID da chave GPG que você quer usar. Neste exemplo, o ID da chave GPG é `3AA5C34371567BD2`: - ```shell - $ gpg --armor --export 3AA5C34371567BD2 - # Prints the GPG key ID, in ASCII armor format - ``` + ```shell{:copy} + $ gpg --armor --export 3AA5C34371567BD2 + # Prints the GPG key ID, in ASCII armor format + ``` 11. Copie sua chave GPG, que inicia com `-----BEGIN PGP PUBLIC KEY BLOCK-----` e termina com `-----END PGP PUBLIC KEY BLOCK-----`. 12. [Adicione a chave GPG à sua conta GitHub](/articles/adding-a-gpg-key-to-your-github-account). diff --git a/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md b/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md index 8fc13a6f2009..3584f1e3280b 100644 --- a/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md +++ b/translations/pt-BR/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md @@ -148,7 +148,7 @@ Quando os trabalhos de {% data variables.product.prodname_code_scanning %} forem {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-7095 %} {% elsif ghes < 3.5 or ghae %} -If you used a pull request to add {% data variables.product.prodname_code_scanning %} to the repository, you will initially see {% ifversion ghes > 3.2 or ghae %}an "Analysis not found"{% elsif ghes = 3.2 %}a "Missing analysis"{% endif %} message when you click **Details** on the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" check. +Se você usou um pull request para adicionar {% data variables.product.prodname_code_scanning %} ao repositório, inicialmente você verá uma mensagem de {% ifversion ghes > 3.2 or ghae %} "Análise não encontrada"{% elsif ghes = 3.2 %}"Análise ausente"{% endif %} ao clicar em **Detalhes** na verificação de "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME". {% ifversion ghes > 3.2 or ghae %} ![Análise não encontrada para mensagem de commit](/assets/images/enterprise/3.4/repository/code-scanning-analysis-not-found.png) @@ -165,7 +165,7 @@ Por exemplo, na captura de tela acima, {% data variables.product.prodname_code_s ### Motivos para a mensagem "Análise ausente" {% endif %} -Depois que {% data variables.product.prodname_code_scanning %} analisou o código em um pull request, ele precisa comparar a análise do branch de tópico (o branch que você usou para criar o pull request) com a análise do branch de base (o branch no qual você deseja mesclar o pull request). Isso permite que {% data variables.product.prodname_code_scanning %} calcule quais alertas foram recém-introduzidos pelo pull request, que alertas já estavam presentes no branch de base e se alguns alertas existentes são corrigidos pelas alterações no pull request. Inicialmente, se você usar um pull request para adicionar {% data variables.product.prodname_code_scanning %} a um repositório, o branch de base ainda não foi analisado. Portanto, não é possível computar esses detalhes. In this case, when you click through from the results check on the pull request you will see the {% ifversion ghes > 3.2 or ghae %}"Analysis not found"{% elsif ghes = 3.2 %}"Missing analysis for base commit SHA-HASH"{% endif %} message. +Depois que {% data variables.product.prodname_code_scanning %} analisou o código em um pull request, ele precisa comparar a análise do branch de tópico (o branch que você usou para criar o pull request) com a análise do branch de base (o branch no qual você deseja mesclar o pull request). Isso permite que {% data variables.product.prodname_code_scanning %} calcule quais alertas foram recém-introduzidos pelo pull request, que alertas já estavam presentes no branch de base e se alguns alertas existentes são corrigidos pelas alterações no pull request. Inicialmente, se você usar um pull request para adicionar {% data variables.product.prodname_code_scanning %} a um repositório, o branch de base ainda não foi analisado. Portanto, não é possível computar esses detalhes. Neste caso, quando você clicar nos resultados verificando o pull request você verá a mensagem {% ifversion ghes > 3.2 or ghae %}"Análise não encontrada"{% elsif ghes = 3.2 %}"Análise ausente do commit base SHA-HASH"{% endif %}. Há outras situações em que não pode haver análise para o último commit do branch de base para um pull request. Isso inclui: @@ -193,7 +193,7 @@ Após configurar a opção {% data variables.product.prodname_code_scanning %}, - Visualizar todos os alertas de {% data variables.product.prodname_code_scanning %} gerados para este repositório. Para obter mais informações, consulte "[Gerenciar alertas de {% data variables.product.prodname_code_scanning %} para o seu repositório](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)". - Visualizar todos os alertas gerados para um pull request enviado após configurar {% data variables.product.prodname_code_scanning %}. Para obter mais informações, consulte "[Triar alertas de {% data variables.product.prodname_code_scanning %} em pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)". -- Configurar notificações para execuções concluídas. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#github-actions-notification-options)." +- Configurar notificações para execuções concluídas. Para obter mais informações, consulte “[Configurar notificações](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#github-actions-notification-options)". - Visualizar os logs gerados pela análise do {% data variables.product.prodname_code_scanning %}. Para obter mais informações, consulte "[Visualizar registros de {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs)". -- Investigue todos os problemas que ocorrerem com a configuração inicial de {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}. For more information, see "[Troubleshooting the {% data variables.product.prodname_codeql %} workflow](/code-security/secure-coding/troubleshooting-the-codeql-workflow)." +- Investigue todos os problemas que ocorrerem com a configuração inicial de {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}. Para obter mais informações, consulte "[Solucionar problemas no fluxo de trabalho de {% data variables.product.prodname_codeql %}](/code-security/secure-coding/troubleshooting-the-codeql-workflow)". - Personalize como {% data variables.product.prodname_code_scanning %} faz a varredura de código no seu repositório. Para obter mais informações, consulte "[Configurando {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/configuring-code-scanning)." diff --git a/translations/pt-BR/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md b/translations/pt-BR/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md index daeb17e4833c..74df7049d25c 100644 --- a/translations/pt-BR/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md +++ b/translations/pt-BR/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md @@ -45,9 +45,15 @@ If you upload a second SARIF file for a commit with the same category and from t If you're new to SARIF and want to learn more, see Microsoft's [`SARIF tutorials`](https://github.com/microsoft/sarif-tutorials) repository. -## Preventing duplicate alerts using fingerprints +## Providing data to track {% data variables.product.prodname_code_scanning %} alerts across runs -Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the right line of code when files are edited. +Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the correct line of code when files are edited. The `ruleID` for a result has to be the same across analysis. + +### Reporting consistent filepaths + +The filepath has to be consistent across the runs to enable a computation of a stable fingerprint. If the filepaths differ for the same result, each time there is a new analysis a new alert will be created, and the old one will be closed. This will cause having multiple alerts for the same result. + +### Including data for fingerprint generation {% data variables.product.prodname_dotcom %} uses the `partialFingerprints` property in the OASIS standard to detect when two results are logically identical. For more information, see the "[partialFingerprints property](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012611)" entry in the OASIS documentation. @@ -77,6 +83,12 @@ You can check a SARIF file is compatible with {% data variables.product.prodname If you use a code analysis engine other than {% data variables.product.prodname_codeql %}, you can review the supported SARIF properties to optimize how your analysis results will appear on {% data variables.product.prodname_dotcom %}. +{% note %} + +**Note:** You must supply an explicit value for any property marked as "required". The empty string is not supported for required properties. + +{% endnote %} + Any valid SARIF 2.1.0 output file can be uploaded, however, {% data variables.product.prodname_code_scanning %} will only use the following supported properties. ### `sarifLog` object @@ -138,7 +150,7 @@ Each `result` object contains details for one alert in the codebase. Within the | `level`| **Optional.** The severity of the result. This level overrides the default severity defined by the rule. {% data variables.product.prodname_code_scanning_capc %} uses the level to filter results by severity on {% data variables.product.prodname_dotcom %}. | `message.text`| **Required.** A message that describes the result. {% data variables.product.prodname_code_scanning_capc %} displays the message text as the title of the result. Only the first sentence of the message will be displayed when visible space is limited. | `locations[]`| **Required.** The set of locations where the result was detected up to a maximum of 10. Only one location should be included unless the problem can only be corrected by making a change at every specified location. **Note:** At least one location is required for {% data variables.product.prodname_code_scanning %} to display a result. {% data variables.product.prodname_code_scanning_capc %} will use this property to decide which file to annotate with the result. Only the first value of this array is used. All other values are ignored. -| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Preventing duplicate alerts using fingerprints](#preventing-duplicate-alerts-using-fingerprints)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. +| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Providing data to track code scanning alerts across runs](#providing-data-to-track-code-scanning-alerts-across-runs)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. | `codeFlows[].threadFlows[].locations[]`| **Optional.** An array of `location` objects for a `threadFlow` object, which describes the progress of a program through a thread of execution. A `codeFlow` object describes a pattern of code execution used to detect a result. If code flows are provided, {% data variables.product.prodname_code_scanning %} will expand code flows on {% data variables.product.prodname_dotcom %} for the relevant result. For more information, see the [`location` object](#location-object). | `relatedLocations[]`| A set of locations relevant to this result. {% data variables.product.prodname_code_scanning_capc %} will link to related locations when they are embedded in the result message. For more information, see the [`location` object](#location-object). @@ -204,7 +216,7 @@ These example SARIF output files show supported properties and example values. ### Example with minimum required properties -This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties or don't include values, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. +This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties, omit values, or use an empty string, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. ```json { diff --git a/translations/pt-BR/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md b/translations/pt-BR/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md index 1e03a239f38e..193ee54f5aa9 100644 --- a/translations/pt-BR/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md +++ b/translations/pt-BR/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md @@ -58,7 +58,7 @@ For more information see the [`upload-sarif` action](https://github.com/github/c The `upload-sarif` action can be configured to run when the `push` and `scheduled` event occur. For more information about {% data variables.product.prodname_actions %} events, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." -If your SARIF file doesn't include `partialFingerprints`, the `upload-sarif` action will calculate the `partialFingerprints` field for you and attempt to prevent duplicate alerts. {% data variables.product.prodname_dotcom %} can only create `partialFingerprints` when the repository contains both the SARIF file and the source code used in the static analysis. For more information about preventing duplicate alerts, see "[About SARIF support for code scanning](/code-security/secure-coding/sarif-support-for-code-scanning#preventing-duplicate-alerts-using-fingerprints)." +If your SARIF file doesn't include `partialFingerprints`, the `upload-sarif` action will calculate the `partialFingerprints` field for you and attempt to prevent duplicate alerts. {% data variables.product.prodname_dotcom %} can only create `partialFingerprints` when the repository contains both the SARIF file and the source code used in the static analysis. For more information about preventing duplicate alerts, see "[About SARIF support for code scanning](/code-security/secure-coding/sarif-support-for-code-scanning#providing-data-to-track-code-scanning-alerts-across-runs)." {% data reusables.code-scanning.upload-sarif-alert-limit %} diff --git a/translations/pt-BR/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md b/translations/pt-BR/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md index 48938d0775c8..19d4b047263b 100644 --- a/translations/pt-BR/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md +++ b/translations/pt-BR/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md @@ -416,7 +416,7 @@ updates: ### `open-pull-requests-limit` -Por padrão, {% data variables.product.prodname_dependabot %} abre um máximo de cinco pull requests para atualizações de versão. Once there are five open pull requests from {% data variables.product.prodname_dependabot %}, {% data variables.product.prodname_dependabot %} will not open any new requests until some of those open requests are merged or closed. Use `open-pull-requests-limit` para alterar este limite. Isto também fornece uma maneira simples de desativar temporariamente as atualizações de versão para um gerenciador de pacotes. +Por padrão, {% data variables.product.prodname_dependabot %} abre um máximo de cinco pull requests para atualizações de versão. Como há cinco pull requests em aberto de {% data variables.product.prodname_dependabot %}, {% data variables.product.prodname_dependabot %} não abrirá nenhuma nova solicitação até que algumas das solicitações abertas sejam mescladas ou fechadas. Use `open-pull-requests-limit` para alterar este limite. Isto também fornece uma maneira simples de desativar temporariamente as atualizações de versão para um gerenciador de pacotes. Esta opção não tem impacto em atualizações de segurança, que têm um limite interno separado de dez pull requests abertas. diff --git a/translations/pt-BR/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md b/translations/pt-BR/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md index 4f53f1678bac..4fcbd86a0932 100644 --- a/translations/pt-BR/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md +++ b/translations/pt-BR/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md @@ -12,25 +12,25 @@ shortTitle: Registro de imagem privada ## Sobre registros de imagens privadas e {% data variables.product.prodname_github_codespaces %} -Um registro é um espaço seguro para armazenar, gerenciar e buscar imagens privadas de contêineres. Você pode usar uma para armazenar uma ou mais imagens. Existem muitos exemplos de registros, como {% data variables.product.prodname_dotcom %} registro do contêiner, registro de contêiner do Azure ou DockerHub. +Um registro é um espaço seguro para armazenar, gerenciar e buscar imagens privadas de contêineres. Você pode usar uma para armazenar uma ou mais imagens. Existem muitos exemplos de registros, como {% data variables.product.prodname_container_registry %}, {% data variables.product.prodname_npm_registry %}, Azure Container Registry ou DockerHub. -O registro do contêiner de {% data variables.product.prodname_dotcom %} pode ser configurado para puxar imagens container sem precisar fornecer qualquer credencial para {% data variables.product.prodname_github_codespaces %}. Para outros registros de imagem, você deve criar segredos em {% data variables.product.prodname_dotcom %} para armazenar os detalhes de acesso, o que permitirá que {% data variables.product.prodname_codespaces %} acesse imagens armazenadas nesse registro. +{% data variables.product.prodname_ghcr_and_npm_registry %} pode ser configurado para permitir que as imagens do contêiner sejam enviadas perfeitamente para {% data variables.product.prodname_github_codespaces %} durante a criação do codespace sem ter que fornecer nenhuma credencial de autenticação. Para outros registros de imagem, você deve criar segredos em {% data variables.product.prodname_dotcom %} para armazenar os detalhes de acesso, o que permitirá que {% data variables.product.prodname_codespaces %} acesse imagens armazenadas nesse registro. -## Acessando imagens armazenadas no registro do contêiner de {% data variables.product.prodname_dotcom %} +## Acessando imagens armazenadas em {% data variables.product.prodname_ghcr_and_npm_registry %} -O registro de contêiner de {% data variables.product.prodname_dotcom %} é a maneira mais fácil de {% data variables.product.prodname_codespaces %} de consumir imagens de contêiner de desenvolvimento. +{% data variables.product.prodname_ghcr_and_npm_registry %} fornece a maneira mais fácil para {% data variables.product.prodname_codespaces %} consumir imagens de contêiner de desenvolvimento. -Para obter mais informações, consulte "[Trabalhando com o registro do contêiner](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)". +Para obter mais informações, consulte "[Trabalhando com o Registro do Contêiner](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)" e "[Trabalhando com o registro npm](/packages/working-with-a-github-packages-registry/working-with-the-npm-registry)". ### Acessar uma imagem publicada no mesmo repositório que o codespace -Se você publicar uma imagem de contêiner do {% data variables.product.prodname_dotcom %} no mesmo repositório em que o codespace está sendo lançado, você poderá de buscar automaticamente essa imagem na criação de um codespace. Você não terá que fornecer qualquer credencial adicional, a menos a opção **Herdar acesso do repositório** tenha sido desmarcada quando a imagem do contêiner foi publicada. +Se você publicar uma imagem do {% data variables.product.prodname_ghcr_or_npm_registry %} no mesmo repositório em que o codespace está sendo lançado, você poderá de buscar automaticamente essa imagem na criação de um codespace. Você não terá que fornecer qualquer credencial adicional, a menos a opção **Herdar acesso do repositório** tenha sido desmarcada quando a imagem do contêiner foi publicada. #### Herdando acesso a partir do repositório no qual uma imagem foi publicada -Por padrão, quando você publica uma imagem de contêiner no registro do contêiner de {% data variables.product.prodname_dotcom %}, a imagem herda a configuração de acesso do repositório no qual a imagem foi publicada. Por exemplo, se o repositório for público, a imagem também é pública. Se o repositório for privado, a imagem também é privada, mas pode ser acessada a partir do repositório. +Por padrão, ao publicar uma imagem de contêiner para {% data variables.product.prodname_ghcr_or_npm_registry %}, a imagem herda a configuração de acesso do repositório do qual a imagem foi publicada. Por exemplo, se o repositório for público, a imagem também é pública. Se o repositório for privado, a imagem também é privada, mas pode ser acessada a partir do repositório. -Este comportamento é controlado pela opção de **Herdar acesso do repositório**. O **Acesso herdado do repo** é selecionado por padrão ao publicar {% data variables.product.prodname_actions %}, mas não ao publicar diretamente no registro do contêiner de {% data variables.product.prodname_dotcom %} usando um Token de Acesso Pessoal (PAT). +Este comportamento é controlado pela opção de **Herdar acesso do repositório**. O **Acesso herdado do repo** é selecionado por padrão ao publicar {% data variables.product.prodname_actions %}, mas não ao publicar diretamente no {% data variables.product.prodname_ghcr_or_npm_registry %} usando um Token de Acesso Pessoal (PAT). Se a opção **Herdar acesso do repositório** não foi selecionada quando a imagem foi publicada, você pode adicionar o repositório manualmente aos controles de acesso da imagem de contêiner. Para obter mais informações, consulte "[Configurar o controle de acesso e visibilidade de um pacote](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#inheriting-access-for-a-container-image-from-a-repository)". @@ -46,13 +46,13 @@ Se você deseja permitir que um subconjunto de repositórios de uma organizaçã ### Publicando uma imagem de contêiner a partir de um codespace -O acesso seguro a partir de um codespace para o registro de um contêiner de {% data variables.product.prodname_dotcom %} é limitado à extração de imagens de contêineres. Se você deseja publicar a imagem de um contêiner de dentro de um codespace, você deve usar um token de acesso pessoal (PAT) com o escopo `write:packages`. +O acesso seguro a partir de um codespace para o {% data variables.product.prodname_ghcr_or_npm_registry %} é limitado à extração de imagens de contêineres. Se você deseja publicar a imagem de um contêiner de dentro de um codespace, você deve usar um token de acesso pessoal (PAT) com o escopo `write:packages`. -Recomendamos publicar imagens via {% data variables.product.prodname_actions %}. Para obter mais informações, consulte "[Publicar imagens Docker](/actions/publishing-packages/publishing-docker-images)". +Recomendamos publicar imagens via {% data variables.product.prodname_actions %}. Para obter mais informações, consulte "[Publicando imagens do Docker](/actions/publishing-packages/publishing-docker-images)" e "[Publicando pacotes do Node.js](/actions/publishing-packages/publishing-nodejs-packages)". ## Acessando as imagens armazenadas em outros registros de contêiner -Se você estiver acessando um contêiner a partir de um registro que não é registro de contêiner de {% data variables.product.prodname_dotcom %}, {% data variables.product.prodname_codespaces %} irá verificar a presença de três segredos, que define o nome de servidor, nome de usuário, e token de acesso pessoal (PAT) para um registro de contêiner. Se estes segredos forem encontrados, {% data variables.product.prodname_github_codespaces %} disponibilizará o registro dentro do seu codespace. +Se você estiver acessando uma imagem de contêiner de um registro que não é {% data variables.product.prodname_ghcr_or_npm_registry %}, {% data variables.product.prodname_codespaces %} verifica a presença de três segredos, que define o nome de servidor, nome de usuário e token de acesso pessoal (PAT) para um registro de contêiner. Se estes segredos forem encontrados, {% data variables.product.prodname_github_codespaces %} disponibilizará o registro dentro do seu codespace. - `<*>_CONTAINER_REGISTRY_SERVER` - `<*>_CONTAINER_REGISTRY_USER` diff --git a/translations/pt-BR/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md b/translations/pt-BR/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md index ed2425e1faa2..d24d81783f66 100644 --- a/translations/pt-BR/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md +++ b/translations/pt-BR/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md @@ -23,6 +23,8 @@ Quando uma organização tem uma lista de autorizações, aplicativos de terceir ## Adicionando uma lista de endereços IP permitidos para {% data variables.product.prodname_github_app %} +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.apps.settings-step %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} diff --git a/translations/pt-BR/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md b/translations/pt-BR/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md index f476d28b5ab1..7a9ef814bc60 100644 --- a/translations/pt-BR/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md +++ b/translations/pt-BR/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md @@ -47,7 +47,7 @@ Os limites de taxa para {% data variables.product.prodname_github_apps %} e {% d {% ifversion fpt or ghec %} -{% data variables.product.prodname_github_apps %} que estão instalados em uma organização ou um repositório dentro de uma empresa no {% data variables.product.product_location %} estão sujeitos a um limite de 15.000 solicitações por hora. +{% data variables.product.prodname_github_apps %} that are installed on an organization within an enterprise on {% data variables.product.product_location %} are subject to a limit of 15,000 requests per hour per organization that has installed the app. {% endif %} diff --git a/translations/pt-BR/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md b/translations/pt-BR/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md index 99b6df1b917f..10cec6059423 100644 --- a/translations/pt-BR/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md +++ b/translations/pt-BR/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md @@ -37,12 +37,12 @@ $ export SECRET_TOKEN=your_token ## Validar cargas do GitHub -Quando seu token secreto está definido, {% data variables.product.product_name %} o utiliza para criar uma assinatura de hash com cada carga. Esta assinatura de hash está incluída com os cabeçalhos de cada solicitação como `X-Hub-Signature-256`. +Quando seu token secreto está definido, {% data variables.product.product_name %} o utiliza para criar uma assinatura de hash com cada carga. Esta assinatura hash está incluída nos cabeçalhos de cada solicitação como `x-hub-signature-256`. {% ifversion fpt or ghes or ghec %} {% note %} -**Observação:** Para compatibilidade com versões anteriores, também incluímos o cabeçalho `X-Hub-Signature` gerado usando a função de hash SHA-1. Se possível, recomendamos que você use o cabeçalho `X-Hub-Signature-256` para melhorar a segurança. O exemplo abaixo demonstra o uso do cabeçalho `X-Hub-Signature-256`. +**Observação:** Para compatibilidade regressiva, também incluímos o cabeçalho `x-hub-signature` que é gerado usando a função hash SHA-1. Se possível, recomendamos que você use o cabeçalho `x-hub-signature-256` para melhorar a segurança. O exemplo abaixo demonstra o uso do cabeçalho `x-hub-sigre-256`. {% endnote %} {% endif %} diff --git a/translations/pt-BR/content/get-started/exploring-projects-on-github/following-organizations.md b/translations/pt-BR/content/get-started/exploring-projects-on-github/following-organizations.md index 08d5275d94ac..2be75167219d 100644 --- a/translations/pt-BR/content/get-started/exploring-projects-on-github/following-organizations.md +++ b/translations/pt-BR/content/get-started/exploring-projects-on-github/following-organizations.md @@ -11,7 +11,7 @@ topics: ## Sobre seguidores em {% data variables.product.product_name %} -{% data reusables.organizations.about-following-organizations %} For more information, see "[About your personal dashboard](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard#staying-updated-with-activity-from-the-community)." +{% data reusables.organizations.about-following-organizations %} Para obter mais informações, consulte "[Sobre o seu painel pessoal](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard#staying-updated-with-activity-from-the-community)." Você pode deixar de seguir uma organização se você não quiser ver sua atividade {% ifversion fpt or ghec %}pública {% endif %} em {% data variables.product.product_name %}. diff --git a/translations/pt-BR/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md b/translations/pt-BR/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md index fdf091ea0782..edd0827449a1 100644 --- a/translations/pt-BR/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md +++ b/translations/pt-BR/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md @@ -57,15 +57,15 @@ Se você tiver código-fonte ou repositórios armazenados localmente no computad 1. [Crie um repositório ](/repositories/creating-and-managing-repositories/creating-a-new-repository) no {% data variables.product.product_location %}. Para evitar erros, não inicialize o novo repositório com os arquivos *README*, de licença ou `gitignore`. É possível adicionar esses arquivos após push do projeto no {% data variables.product.product_name %}. ![Menu suspenso Create New Repository (Criar novo repositório)](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. Altere o diretório de trabalho atual referente ao seu projeto local. -4. Use the `init` command to initialize the local directory as a Git repository. By default, the initial branch is called `master`. +4. Use o comando `init` para inicializar o diretório local como um repositório do Git. Por padrão, o branch inicial é denominado `mestre`. - If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using `-b`. + Se você estiver usando o Git 2.28.0 ou uma versão posterior, você poderá definir o nome do branch padrão usando `-b`. ``` shell $ git init -b main ``` - If you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using `&& git branch -m`. + Se estiver usando o Git 2.27. ou versão anterior, você poderá definir o nome do branch padrão usando `&& git branch -m`. ``` shell $ git init && git branch -m main @@ -102,15 +102,15 @@ Se você tiver código-fonte ou repositórios armazenados localmente no computad 1. [Crie um repositório ](/articles/creating-a-new-repository) no {% data variables.product.product_location %}. Para evitar erros, não inicialize o novo repositório com os arquivos *README*, de licença ou `gitignore`. É possível adicionar esses arquivos após push do projeto no {% data variables.product.product_name %}. ![Menu suspenso Create New Repository (Criar novo repositório)](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. Altere o diretório de trabalho atual referente ao seu projeto local. -4. Use the `init` command to initialize the local directory as a Git repository. By default, the initial branch is called `master`. +4. Use o comando `init` para inicializar o diretório local como um repositório do Git. Por padrão, o branch inicial é denominado `mestre`. - If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using `-b`. + Se você estiver usando o Git 2.28.0 ou uma versão posterior, você poderá definir o nome do branch padrão usando `-b`. ``` shell $ git init -b main ``` - If you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using `&& git branch -m`. + Se estiver usando o Git 2.27. ou versão anterior, você poderá definir o nome do branch padrão usando `&& git branch -m`. ``` shell $ git init && git branch -m main @@ -146,15 +146,15 @@ Se você tiver código-fonte ou repositórios armazenados localmente no computad 1. [Crie um repositório ](/articles/creating-a-new-repository) no {% data variables.product.product_location %}. Para evitar erros, não inicialize o novo repositório com os arquivos *README*, de licença ou `gitignore`. É possível adicionar esses arquivos após push do projeto no {% data variables.product.product_name %}. ![Menu suspenso Create New Repository (Criar novo repositório)](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. Altere o diretório de trabalho atual referente ao seu projeto local. -4. Use the `init` command to initialize the local directory as a Git repository. By default, the initial branch is called `master`. +4. Use o comando `init` para inicializar o diretório local como um repositório do Git. Por padrão, o branch inicial é denominado `mestre`. - If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using `-b`. + Se você estiver usando o Git 2.28.0 ou uma versão posterior, você poderá definir o nome do branch padrão usando `-b`. ``` shell $ git init -b main ``` - If you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using `&& git branch -m`. + Se estiver usando o Git 2.27. ou versão anterior, você poderá definir o nome do branch padrão usando `&& git branch -m`. ``` shell $ git init && git branch -m main diff --git a/translations/pt-BR/content/get-started/quickstart/be-social.md b/translations/pt-BR/content/get-started/quickstart/be-social.md index 3fd158baf0d8..a15b60e3808e 100644 --- a/translations/pt-BR/content/get-started/quickstart/be-social.md +++ b/translations/pt-BR/content/get-started/quickstart/be-social.md @@ -66,11 +66,11 @@ No painel de controle, clique no menu suspenso do seu nome de usuário no lado e {% data reusables.organizations.about-following-organizations %} -To follow an organization, in the header of the organization's page, click **Follow**. +Para seguir uma organização, no cabeçalho da página, clique em **Seguir**. ![Captura de tela do cabeçalho da organização, com o botão seguir destacado](/assets/images/help/profile/organization-profile-following.png) -For more information, see "[Following organizations](/get-started/exploring-projects-on-github/following-organizations)." +Para obter mais informações, consulte "[Seguindo as organizações](/get-started/exploring-projects-on-github/following-organizations)". {% endif %} diff --git a/translations/pt-BR/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md b/translations/pt-BR/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md index b80b65ad12d3..63a1fa18a9de 100644 --- a/translations/pt-BR/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md +++ b/translations/pt-BR/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md @@ -24,7 +24,7 @@ Para transferir um problema aberto para outro repositório, é preciso ter acess {% endnote %} -Ao transferir um problema, os comentários, etiquetas e responsáveis são mantidos. Os marcos do problema não são mantidos. Esse problema permanecerá em qualquer quadro de projeto pertencente ao usuário ou à organização e será removido dos quadros de projeto de todos os repositórios. Para obter mais informações, consulte "[Sobre quadros de projeto](/articles/about-project-boards)". +Quando você transfere um problema, os comentários e responsáveis são mantidos. Labels and milestones are also retained if they're present in the target repository, with labels matching by name and milestones matching by both name and due date. Esse problema permanecerá em qualquer quadro de projeto pertencente ao usuário ou à organização e será removido dos quadros de projeto de todos os repositórios. Para obter mais informações, consulte "[Sobre quadros de projeto](/articles/about-project-boards)". As pessoas ou equipes mencionadas no problema receberão uma notificação informando que o problema foi transferido para um novo repositório. O URL original redirecionará para o novo URL do problema. As pessoas que não tenham permissões de leitura no novo repositório verão um banner informando que o problema foi transferido para um novo repositório ao qual elas não têm acesso. diff --git a/translations/pt-BR/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md b/translations/pt-BR/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md index 6e6899ce60ea..8a5a45ffb372 100644 --- a/translations/pt-BR/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md +++ b/translations/pt-BR/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md @@ -38,6 +38,8 @@ Você também pode configurar endereços IP permitidos para as organizações em {% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %} +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} diff --git a/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization.md b/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization.md index aeb7f893f7cc..28d0f764cfab 100644 --- a/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization.md +++ b/translations/pt-BR/content/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization.md @@ -24,7 +24,7 @@ Existem três níveis de permissões para um {% data variables.projects.projects {% data reusables.project-management.project-board-permissions %} -Organization owners and people with admin permissions can give a person access to an organization {% data variables.projects.projects_v1_board %} individually, as an outside collaborator or organization member, or through their membership in a team or organization. Um colaborador externo é uma pessoa que não é integrante da organização mas recebeu permissões para colaborar na organização. +Os proprietários da organização e pessoas com permissões de administrador podem dar acesso a uma organização de {% data variables.projects.projects_v1_board %} individualmente, como colaborador ou integrante da organização externo, ou por meio de sua associação a uma equipe ou organização. Um colaborador externo é uma pessoa que não é integrante da organização mas recebeu permissões para colaborar na organização. Os proprietários da organização e as pessoas com permissões de administradores em um {% data variables.projects.projects_v1_board %} também podem: - Definir permissões de quadro de projeto padrão para todos os integrantes da organização. diff --git a/translations/pt-BR/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md b/translations/pt-BR/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md index 902aa6d34bbf..cb8263d2da3c 100644 --- a/translations/pt-BR/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md +++ b/translations/pt-BR/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md @@ -1,6 +1,6 @@ --- title: Habilitando ou desabilitando as discussões no GitHub para uma organização -intro: 'Você pode usar o {% data variables.product.prodname_discussions %} em uma organização como um local para a sua organização ter conversas que não são específicas para um único repositório dentro da sua organização.' +intro: 'You can use {% data variables.product.prodname_discussions %} in an organization as a place for your organization to have conversations that aren''t specific to a single repository within your organization.' permissions: 'Organization owners can enable {% data variables.product.prodname_discussions %} for their organization.' versions: feature: discussions diff --git a/translations/pt-BR/content/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization.md b/translations/pt-BR/content/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization.md index 8fb3705d3e5a..b4333ec865b7 100644 --- a/translations/pt-BR/content/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization.md +++ b/translations/pt-BR/content/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization.md @@ -13,7 +13,7 @@ shortTitle: Gerenciar a política de aprovação de commit Para afirmar que um commit está de acordo com as regras e licenciamento de um repositório, muitas organizações exigem que os desenvolvedores assinem em todos os commits. Se sua organização requer assinaturas do commit, você pode tornar a assinatura de uma parte ininterrupta do processo de commit, permitindo a aprovação obrigatória de commits para os usuários que fizerem commit da interface web de {% data variables.product.product_name %}. Após habilitar as assinaturas de commit obrigatórias para uma organização, cada commit criado nos repositórios dessa organização por meio da interface web de {% data variables.product.product_name %} será automaticamente assinado pelo autor do commit. -Pessoas com acesso de administrador a um repositório também podem habilitar assinaturas de commit obrigatórias no nível de repositório. For more information, see "[Managing the commit signoff policy for your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository)." +Pessoas com acesso de administrador a um repositório também podem habilitar assinaturas de commit obrigatórias no nível de repositório. Para obter mais informações, consulte "[Gerenciando a política de assinatura de commit para o seu repositório](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository)". {% data reusables.repositories.commit-signoffs %} diff --git a/translations/pt-BR/content/packages/index.md b/translations/pt-BR/content/packages/index.md index d18a8e456e37..44f13ee989e9 100644 --- a/translations/pt-BR/content/packages/index.md +++ b/translations/pt-BR/content/packages/index.md @@ -18,6 +18,7 @@ featuredLinks: guideCards: - '{% ifversion docker-ghcr-enterprise-migration %}/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry{% endif %}' - '{% ifversion fpt or ghec or ghes > 3.4 %}/packages/working-with-a-github-packages-registry/working-with-the-container-registry{% else %}/packages/working-with-a-github-packages-registry/working-with-the-docker-registry{% endif %}' + - '{% ifversion packages-npm-v2 %}/packages/working-with-a-github-packages-registry/working-with-the-npm-registry{% endif %}' - /packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry changelog: label: packages diff --git a/translations/pt-BR/content/packages/learn-github-packages/about-permissions-for-github-packages.md b/translations/pt-BR/content/packages/learn-github-packages/about-permissions-for-github-packages.md index dfdb7479e2be..f999a3d477d5 100644 --- a/translations/pt-BR/content/packages/learn-github-packages/about-permissions-for-github-packages.md +++ b/translations/pt-BR/content/packages/learn-github-packages/about-permissions-for-github-packages.md @@ -18,20 +18,22 @@ As permissões para pacotes são do escopo do repositório ou do escopo de usuá Um pacote com escopo de repositório herda as permissões e visibilidade do repositório que possui o pacote. Você pode encontrar um escopo de pacote para um repositório, acessando a página principal do repositório e clicando no link **Pacotes** à direita da página. {% ifversion fpt or ghec %}Para obter mais informações, consulte "[Conectar um repositório a um pacote](/packages/learn-github-packages/connecting-a-repository-to-a-package)."{% endif %} -Os {% data variables.product.prodname_registry %} registros abaixo usam permissões com escopo do repositório: +Os registros de {% data variables.product.prodname_registry %} abaixo de **apenas** usam permissões com escopo do repositório: {% ifversion not fpt or ghec %}- Docker registry (`docker.pkg.github.com`){% endif %} - - Registro de npm + {% ifversion packages-npm-v2 %}{% else %}- npm registry{% endif %} - Registro do Rubygems - Registro do Apache Maven - Registro do NuGet +{% ifversion packages-npm-v2 %}Para {% data variables.product.prodname_ghcr_and_npm_registry %}, você pode optar por permitir que os pacotes tenham o escopo definido para um usuário, uma organização ou vinculados a um repositório.{% endif %} + {% ifversion fpt or ghec %} ## Permissões granulares para pacotes com escopo de usuário/organização Pacotes com permissões granulares são escopos para uma conta de usuário pessoal ou de organização. Você pode alterar o controle de acesso e a visibilidade do pacote separadamente de um repositório que está conectado (ou vinculado) a um pacote. -Atualmente, apenas o {% data variables.product.prodname_container_registry %} oferece permissões granulares para os seus pacotes de imagem de contêiner. +Atualmente, o {% data variables.product.prodname_ghcr_and_npm_registry %} oferece permissões granulares para seus pacotes de imagens de contêiner. ## Visibilidade e permissões de acesso para imagens de contêiner diff --git a/translations/pt-BR/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md b/translations/pt-BR/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md index 14006d07de50..b8da0d51e558 100644 --- a/translations/pt-BR/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md +++ b/translations/pt-BR/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md @@ -16,7 +16,7 @@ shortTitle: Controle de acesso & visibilidade Pacotes com permissões granulares são escopos para uma conta de usuário pessoal ou de organização. Você pode alterar o controle de acesso e a visibilidade de um pacote separadamente do repositório ao qual ele está conectado (ou vinculado). -Atualmente, você só pode usar permissões granulares com o {% data variables.product.prodname_container_registry %}. As oermissões granulares não são compatíveis com os nossos registros de pacotes, como o registro npm.{% ifversion docker-ghcr-enterprise-migration %} Para mais informações sobre a migração para o {% data variables.product.prodname_container_registry %}, consulte "[Migrando para o {% data variables.product.prodname_container_registry %} do registro Docker](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry).{% endif %} +Atualmente, você só pode usar permissões granulares com o {% data variables.product.prodname_ghcr_and_npm_registry %}. As oermissões granulares não são compatíveis com os nossos registros de pacotes, como o registro do RubyGems.{% ifversion docker-ghcr-enterprise-migration %} Para mais informações sobre a migração para o {% data variables.product.prodname_container_registry %}, consulte "[Migrando para o {% data variables.product.prodname_container_registry %} do registro Docker](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry).{% endif %} Para obter mais informações sobre permissões para pacotes com escopo de repositório, escopos relacionados aos pacotes para PATs, ou gerenciar permissões para seus fluxos de trabalho de ações, consulte "[Sobre permissões para os Pacotes GitHub](/packages/learn-github-packages/about-permissions-for-github-packages)". @@ -95,7 +95,7 @@ Para personalizar ainda mais o acesso à sua imagem de contêiner, consulte "[Co {% ifversion fpt or ghec %} ## Assegurando acesso de {% data variables.product.prodname_codespaces %} ao seu pacote -Por padrão, um codespace pode acessar perfeitamente certos pacotes no Registro Contêiner de{% data variables.product.prodname_dotcom %} como, por exemplo, aqueles publicados no mesmo repositório com a opção **herdar acesso** selecionada. Para obter mais informações sobre o qual o acesso é automaticamente configurado, consulte "[Acessando imagens armazenadas no registro de contêiner de {% data variables.product.prodname_dotcom %}](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry#accessing-images-stored-in-github-container-registry)". +Por padrão, um codespac pode acessar perfeitamente certos pacotes em {% data variables.product.prodname_ghcr_and_npm_registry %}, como aqueles publicados no mesmo repositório com a opção **Herdar acesso** selecionada. Para obter mais informações sobre as quais o acesso é configurado automaticamente, consulte "[Permitindo que o seu codespace acesse um registro de imagens privadas](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry#accessing-images-stored-in-container-registry-and-npm-registry)". Caso contrário, para garantir que um código tenha acesso ao seu pacote, você deverá conceder acesso ao repositório onde o codespace está sendo iniciado. diff --git a/translations/pt-BR/content/packages/learn-github-packages/deleting-and-restoring-a-package.md b/translations/pt-BR/content/packages/learn-github-packages/deleting-and-restoring-a-package.md index 80123fc3a031..02ae35eeecef 100644 --- a/translations/pt-BR/content/packages/learn-github-packages/deleting-and-restoring-a-package.md +++ b/translations/pt-BR/content/packages/learn-github-packages/deleting-and-restoring-a-package.md @@ -23,12 +23,12 @@ Em {% data variables.product.prodname_dotcom %} se você tiver o acesso necessá - um pacote privado inteiro - um pacote público inteiro, se não houver mais de 5000 downloads de qualquer versão do pacote - uma versão específica de um pacote privado -- uma versão específica de um pacote público, se a versão do pacote não tiver mais de 5000 downloads +- uma versão específica de um pacote público, se a versão do pacote não tiver mais de 5,000 downloads {% note %} **Observação:** -- Você não pode excluir um pacote público se uma versão do pacote tiver mais de 5000 downloads. Neste caso, entre em contato com o [suporte do GitHub](https://support.github.com/contact?tags=docs-packages) para obter mais assistência. +- Você não pode excluir um pacote público se uma versão do pacote tiver mais de 5,000 downloads. Neste caso, entre em contato com o [suporte do GitHub](https://support.github.com/contact?tags=docs-packages) para obter mais assistência. - Ao excluir pacotes públicos, esteja ciente de que você pode quebrar projetos que dependem do seu pacote. {% endnote %} @@ -46,7 +46,7 @@ Você pode usar a API REST para gerenciar seus pacotes. Para obter mais informa {% endif %} -Para pacotes que herdam suas permissões e acesso dos repositórios, você pode usar o GraphQL para excluir uma versão específica de pacotes.{% ifversion fpt or ghec %} A API do GraphQL de {% data variables.product.prodname_registry %} não é compatível com contêineres ou imagens Docker que usam o namespace `https://ghcr. o/OWNER/PACKAGE-NAME`.{% endif %} Para obter mais informações sobre o suporte do GraphQL, consulte "[Excluindo uma versão de um pacote com escopo de repositório com o GraphQL](#deleting-a-version-of-a-repository-scoped-package-with-graphql)". +Para pacotes que herdam suas permissões e acesso dos repositórios, você pode usar o GraphQL para excluir uma versão específica de pacotes.{% data reusables.package_registry.no-graphql-to-delete-packages %} Para obter mais informações sobre o suporte do GraphQL, consulte "[Excluindo uma versão de um pacote com escopo de repositório com GraphQL](#deleting-a-version-of-a-repository-scoped-package-with-graphql)". {% endif %} @@ -54,17 +54,19 @@ Para pacotes que herdam suas permissões e acesso dos repositórios, você pode Para pacotes que herdam as permissões de acesso dos repositórios, é possível excluir um pacote se você tiver permissões de administrador para o repositório. -Os pacotes com escopo de repositório em {% data variables.product.prodname_registry %} incluem estes pacotes: -- npm -- RubyGems -- maven -- Gradle -- NuGet -{% ifversion not fpt or ghec %}- Imagens do Docker em `docker.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`{% endif %} +Os registros de {% data variables.product.prodname_registry %} abaixo de **apenas** usam permissões com escopo do repositório: + + {% ifversion not fpt or ghec %}- Imagens do Docker em `docker.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`{% endif %} + {% ifversion packages-npm-v2 %}{% else %}- npm{% endif %} + - Registro do Rubygems + - Registro do Apache Maven + - Registro do NuGet + +{% ifversion packages-npm-v2 %}Para {% data variables.product.prodname_ghcr_and_npm_registry %}, você pode optar por permitir que os pacotes tenham o escopo definido para um usuário, uma organização ou vinculados a um repositório.{% endif %} {% ifversion fpt or ghec %} -Para excluir um pacote que tem permissões granulares separadas de um repositório, como imagens de contêiner armazenadas em `https://ghcr.io/OWNER/PACKAGE-NAME`, você deverá ter acesso de administrador ao pacote. Para obter mais informações, consulte "[Sobre permissões para {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)". +Para excluir um pacote que tem permissões granulares separadas de um repositório, como imagens de contêiner armazenadas em `https://ghcr. o/OWNER/PACKAGE-NAME` ou `https://npm.pkg.github.com/OWNER/PACKAGE-NAME`, você deve ter acesso de administrador ao pacote. Para obter mais informações, consulte "[Sobre permissões para {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)". {% endif %} @@ -86,11 +88,9 @@ Para excluir uma versão de um pacote com escopo do repositório, você deve ter Para pacotes que herdam suas permissões e acesso dos repositórios, você pode usar o GraphQL para excluir uma versão específica de pacotes. -{% ifversion fpt or ghec %} -Para contêineres ou imagens do Docker em `ghcr.io`, o GraphQL não é compatível, mas você pode usar a API REST. Para obter mais informações, consulte o "[API de {% data variables.product.prodname_registry %}](/rest/reference/packages)". -{% endif %} +{% data reusables.package_registry.no-graphql-to-delete-packages %}{% ifversion fpt or ghec %} Você pode usar a API REST. Para obter mais informações, consulte a "[API de {% data variables.product.prodname_registry %}](/rest/reference/packages)."{% endif %} -Use a mutação `deletePackageVersion` na API do GraphQL. Você deve usar um token com os escopos `read:packages`, `delete:packages` e `repo`. For more information about tokens, see "[About {% data variables.product.prodname_registry %}](/packages/publishing-and-managing-packages/about-github-packages#about-tokens)." +Use a mutação `deletePackageVersion` na API do GraphQL. Você deve usar um token com os escopos `read:packages`, `delete:packages` e `repo`. Para obter mais informações sobre tokens, consulte "[Sobre {% data variables.product.prodname_registry %}](/packages/publishing-and-managing-packages/about-github-packages#authenticating-to-github-packages)." O exemplo a seguir demonstra como excluir uma versão do pacote, usando um `packageVersionId` de `MDIyOlJlZ2lzdHJ5UGFja2FnZVZlcnNpb243MTExNg`. diff --git a/translations/pt-BR/content/packages/learn-github-packages/introduction-to-github-packages.md b/translations/pt-BR/content/packages/learn-github-packages/introduction-to-github-packages.md index fc5090006ea3..5450ffcff9f3 100644 --- a/translations/pt-BR/content/packages/learn-github-packages/introduction-to-github-packages.md +++ b/translations/pt-BR/content/packages/learn-github-packages/introduction-to-github-packages.md @@ -51,7 +51,7 @@ For more information about the configuration of {% data variables.product.prodna | | | |--------------------|--------------------| -| Permissions | {% ifversion fpt or ghec %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_container_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted.

For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} | +| Permissions | {% ifversion fpt or ghec %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_ghcr_and_npm_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted.

For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} | | Visibility | {% data reusables.package_registry.public-or-private-packages %} | For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)." @@ -101,7 +101,9 @@ For more information about Docker and the {% data variables.product.prodname_con ## Managing packages {% ifversion fpt or ghec %} -You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. For more information, see the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." +You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." + +{% data reusables.package_registry.no-graphql-to-delete-packages %} {% endif %} {% ifversion ghes %} @@ -112,7 +114,9 @@ You can delete a private or public package in the {% data variables.product.prod You can delete a version of a package in the {% data variables.product.product_name %} user interface or using the GraphQL API. {% endif %} -When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and "[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." +When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. + +For more information, see {% ifversion ghes or ghae %}"[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and {% endif %}"[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." You can configure webhooks to subscribe to package-related events, such as when a package is published or updated. For more information, see the "[`package` webhook event](/webhooks/event-payloads/#package)." diff --git a/translations/pt-BR/content/packages/learn-github-packages/viewing-packages.md b/translations/pt-BR/content/packages/learn-github-packages/viewing-packages.md index 845f2eb3f8c1..ef4a284ecabd 100644 --- a/translations/pt-BR/content/packages/learn-github-packages/viewing-packages.md +++ b/translations/pt-BR/content/packages/learn-github-packages/viewing-packages.md @@ -23,15 +23,15 @@ versions: A sua capacidade de visualizar um pacote depende de vários fatores. Por padrão, você pode visualizar todos os pacotes que você publicou. -Pacotes com escopo de repositórios herdam suas permissões e visibilidade do repositório que possui o pacote. Os registros abaixo usam este tipo de permissões:{% ifversion not fpt or ghec %} +Pacotes com escopo de repositórios herdam suas permissões e visibilidade do repositório que possui o pacote. Os registros abaixo **apenas** usam este tipo de permissões:{% ifversion not fpt or ghec %} - Registro Docker (`docker.pkg.github.com`){% endif %} -- Registro de npm +{% ifversion packages-npm-v2 %}{% else %}- npm registry{% endif %} - Registro do Rubygems - Registro do Apache Maven - Registro do NuGet {% ifversion fpt or ghec %} -O registro do contêiner oferece a opção de permissões e configurações de visibilidade granulares que podem ser personalizadas para cada pacote de propriedade de um usuário pessoal ou de uma conta de organização. Você pode optar por usar permissões granulares ou conectar o pacote a um repositório e herdar suas permissões. Para obter mais informações, consulte "[Conectar um repositório a um pacote](/packages/learn-github-packages/connecting-a-repository-to-a-package)". +O {% data variables.product.prodname_ghcr_and_npm_registry %} oferece a opção de permissões e configurações de visibilidade granulares que podem ser personalizadas para cada pacote de propriedade de uma conta pessoal ou da conta de uma organização. Você pode optar por usar permissões granulares ou conectar o pacote a um repositório e herdar suas permissões. Para obter mais informações, consulte "[Conectar um repositório a um pacote](/packages/learn-github-packages/connecting-a-repository-to-a-package)". {% endif %} Para obter mais informações consulte "[Sobre permissões para o GitHub Packages](/packages/learn-github-packages/about-permissions-for-github-packages){% ifversion fpt or ghec %}" e[Configurando controle de acesso e visibilidade de um pacote](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility){% endif %}." diff --git a/translations/pt-BR/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md b/translations/pt-BR/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md index f5ee7683459e..7f62a92fb03b 100644 --- a/translations/pt-BR/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md +++ b/translations/pt-BR/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md @@ -24,9 +24,9 @@ shortTitle: Publicar & instalar com ações Você pode estender os recursos de CI e CD do seu repositório publicando ou instalando pacotes como parte do seu fluxo de trabalho. {% ifversion fpt or ghec %} -### Efetuar a autenticação no {% data variables.product.prodname_container_registry %} +### Efetuar a autenticação no {% data variables.product.prodname_ghcr_and_npm_registry %} -{% data reusables.package_registry.authenticate_with_pat_for_container_registry %} +{% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} {% endif %} @@ -40,7 +40,7 @@ Você pode fazer referência ao `GITHUB_TOKEN` no seu arquivo de fluxo de trabal {% note %} -**Observação:** Os pacotes que possuem repositórios incluem RubyGems, npm, Apache Maven, NuGet, {% ifversion fpt or ghec %}e Gradle. {% else %}Os pacotes do Gradle e Docker que usam o pacote namespace `docker.pkg.github.com`.{% endif %} +**Observação:** Alguns registros, como RubyGems, {% ifversion packages-npm-v2 %}{% else %}npm, {% endif %}Apache Maven, NuGet, {% ifversion fpt or ghec %}e Gradle{% else %}Gradle e pacotes Docker que usam o namespace `docker.pkg.github.com`{% endif %}, só permitem pacotes propriedade de repositório. Com {% data variables.product.prodname_ghcr_and_npm_registry_full %} você pode optar por permitir que os pacotes sejam propriedade de um usuário, organização ou vinculados a um repositório. {% endnote %} @@ -49,11 +49,11 @@ Quando você habilita o GitHub Actions, o GitHub instala um aplicativo GitHub no {% data variables.product.prodname_registry %} permite que você faça push e pull de pacotes por meio do `GITHUB_TOKEN` disponível para um fluxo de trabalho de {% data variables.product.prodname_actions %}. {% ifversion fpt or ghec %} -## Sobre permissões e acesso de pacote para {% data variables.product.prodname_container_registry %} +## Sobre permissões e acesso de pacote para {% data variables.product.prodname_ghcr_and_npm_registry %} -O {% data variables.product.prodname_container_registry %} (`ghcr.io`) permite aos usuários criar e administrar contêineres como recursos independentes no nível da organização. Os contêineres podem pertencer a uma conta pessoal ou organização e você pode personalizar o acesso a cada um dos seus contêineres separadamente das permissões de repositório. +O {% data variables.product.prodname_ghcr_and_npm_registry_full %} permite aos usuários criar e administrar pacotes como recursos independentes no nível da organização. Os pacotes podem pertencer a uma conta organizacional ou pessoal e você pode personalizar o acesso a cada um dos seus pacotes separadamente das permissões de repositório. -Todos os workflows que acessam o {% data variables.product.prodname_container_registry %} devem usar o `GITHUB_TOKEN` em vez de um token de acesso pessoal. Para obter mais informações sobre as melhores práticas de segurança, consulte "[Enrijecimento de segurança para o GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)". +Todos os workflows que acessam o {% data variables.product.prodname_ghcr_and_npm_registry %} devem usar o `GITHUB_TOKEN` em vez de um token de acesso pessoal. Para obter mais informações sobre as melhores práticas de segurança, consulte "[Enrijecimento de segurança para o GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)". ## Configurações padrão de permissões e acesso para contêineres modificados por meio de fluxos de trabalho @@ -484,9 +484,9 @@ A instalação de pacotes hospedados pelo {% data variables.product.prodname_reg {% data reusables.package_registry.actions-configuration %} {% ifversion fpt or ghec %} -## Atualizando um fluxo de trabalho que acessa `ghcr.io` +## Atualizando um fluxo de trabalho que acessa um registro usando um PAT -O {% data variables.product.prodname_container_registry %} é compatível com `GITHUB_TOKEN` para autenticação fácil e segura nos seus fluxos de trabalho. Se seu fluxo de trabalho estiver usando um token de acesso pessoal (PAT) para efetuar a autenticação com `ghcr.io`, é altamente recomendável atualizar o seu fluxo de trabalho para usar o `GITHUB_TOKEN`. +O {% data variables.product.prodname_ghcr_and_npm_registry %} é compatível com `GITHUB_TOKEN` para autenticação fácil e segura nos seus fluxos de trabalho. Se seu fluxo de trabalho estiver usando um token de acesso pessoal (PAT) para efetuar a autenticação no registro, é altamente recomendável atualizar o seu fluxo de trabalho para usar o `GITHUB_TOKEN`. Para obter mais informações sobre o `GITHUB_TOKEN`, consulte "[Autenticação em um fluxo de trabalho](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)". @@ -501,9 +501,9 @@ O uso do `GITHUB_TOKEN` em vez de um PAT, que inclui o escopo do `repositório` {% endnote %} 1. Opcionalmente, usando o menu suspenso "função", selecione o nível de acesso padrão que você gostaria que o repositório tivesse na imagem do seu contêiner. ![Níveis de acesso permitidos para repositórios](/assets/images/help/package-registry/repository-permission-options-for-package-access-through-actions.png) -1. Abra o arquivo do seu fluxo de trabalho. Na linha em que você efetua o login em `ghcr.io`, substitua seu PAT por {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. +1. Abra o arquivo do seu fluxo de trabalho. Na linha em que você fez login no registro, substitua o seu PAT por {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. -Por exemplo, este fluxo de trabalho publica um imagem do Docker usando {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} para efetuar a autenticação. +Por exemplo, este fluxo de trabalho publica uma imagem Docker para {% data variables.product.prodname_container_registry %} e usa {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} para efetuar a autenticação. ```yaml{:copy} name: Demo Push diff --git a/translations/pt-BR/content/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry.md b/translations/pt-BR/content/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry.md index 44177e2e461b..e8cb93cd54fb 100644 --- a/translations/pt-BR/content/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry.md +++ b/translations/pt-BR/content/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry.md @@ -1,6 +1,6 @@ --- title: Fazendo a migração para o Registro do Contêiner a partir do Registro Docker -intro: '{% ifversion docker-ghcr-enterprise-migration %}An enterprise owner can{% else %}{% data variables.product.company_short %} will{% endif %} migrate Docker images previously stored in the Docker registry on {% data variables.product.product_location %} to the {% data variables.product.prodname_container_registry %}.' +intro: '{% ifversion docker-ghcr-enterprise-migration %}O proprietário de uma empresa pode{% else %}{% data variables.product.company_short %} irá{% endif %} migrar imagens do Docker previamente armazenadas no registro do Docker em {% data variables.product.product_location %} para o {% data variables.product.prodname_container_registry %}.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /packages/getting-started-with-github-container-registry/migrating-to-github-container-registry-for-docker-images @@ -25,26 +25,26 @@ topics: ## Sobre a migração do registro do Docker -{% data reusables.package_registry.container-registry-replaces-docker-registry %} If you've stored Docker images in the Docker registry, {% ifversion docker-ghcr-enterprise-migration %}an enterprise owner{% else %}{% data variables.product.company_short %}{% endif %} will gradually migrate the images to the {% data variables.product.prodname_container_registry %}. No action is required on your part. +{% data reusables.package_registry.container-registry-replaces-docker-registry %} Se você armazenou imagens do Docker no registro do Docker, {% ifversion docker-ghcr-enterprise-migration %} o proprietário de uma empresa{% else %}{% data variables.product.company_short %}{% endif %} irá transferir gradualmente as imagens para o {% data variables.product.prodname_container_registry %}. Nenhuma ação é necessária de sua parte. {% ifversion docker-ghcr-enterprise-migration %} {% note %} -**Note**: {% data reusables.package_registry.container-registry-ghes-migration-availability %} For more information about finding the version of {% data variables.product.product_name %} that you use, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs#github-enterprise-server)." +**Observação**: {% data reusables.package_registry.container-registry-ghes-migration-availability %} Para mais informações sobre como encontrar a versão de {% data variables.product.product_name %} que você usa, consulte "[Sobre as versões de {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs#github-enterprise-server)". {% endnote %} {% endif %} -After a Docker image has been migrated to the {% data variables.product.prodname_container_registry %}, you'll see the following changes to the details for the package. +Depois que a imagem de um Docker foi transferida para {% data variables.product.prodname_container_registry %}, você verá as seguintes alterações nos detalhes do pacote. -- The icon will be the {% data variables.product.prodname_container_registry %} logo instead of the Docker logo. -- The domain in the pull URL will be {% data variables.product.prodname_container_registry_namespace %} instead of {% data variables.product.prodname_docker_registry_namespace %}. +- O ícone será o logotipo de {% data variables.product.prodname_container_registry %} ao invés do logo do Docker. +- O domínio na URL do pull será {% data variables.product.prodname_container_registry_namespace %} em vez de {% data variables.product.prodname_docker_registry_namespace %}. {% ifversion fpt or ghec %} -![Screenshot of a Docker image migrated to the {% data variables.product.prodname_container_registry %}](/assets/images/help/package-registry/container-registry-details-page.png) +![Captura de tela de uma imagem do Docker transferida para {% data variables.product.prodname_container_registry %}](/assets/images/help/package-registry/container-registry-details-page.png) {% endif %} @@ -52,11 +52,11 @@ After a Docker image has been migrated to the {% data variables.product.prodname {% ifversion fpt or ghec %} -After migration, you'll no longer be able to use the GraphQL API to query for packages with a `PackageType` of "DOCKER". Instead, you can use the REST API to query for packages with a `package_type` of "container". For more information, see "[Packages](/rest/reference/packages)" in the REST API documentation. +Após a migração, você não poderá mais usar o API do GraphQL para consultar pacotes com um `tipo de pacote` do "DOCKER". Em vez disso, você pode usar a API REST para consultar pacotes com um `package_type` de "contêiner". Para obter mais informações, consulte "[Pacotes](/rest/reference/packages)" na documentação da API REST. ## Sobre a cobrança do {% data variables.product.prodname_container_registry %} -For more information about billing for the {% data variables.product.prodname_container_registry %}, see "[About billing for {% data variables.product.prodname_registry %}](/billing/managing-billing-for-github-packages/about-billing-for-github-packages)." +Para obter mais informações sobre a cobrança para o {% data variables.product.prodname_container_registry %}, consulte "[Sobre a cobrança para {% data variables.product.prodname_registry %}](/billing/managing-billing-for-github-packages/about-billing-for-github-packages). {% endif %} @@ -64,6 +64,6 @@ For more information about billing for the {% data variables.product.prodname_co ## Leia mais -- "[Migrating your enterprise to the {% data variables.product.prodname_container_registry %} from the Docker registry](/admin/packages/migrating-your-enterprise-to-the-container-registry-from-the-docker-registry)" +- "[Fazendo a migração da sua empresa para {% data variables.product.prodname_container_registry %} do registro Docker](/admin/packages/migrating-your-enterprise-to-the-container-registry-from-the-docker-registry)" {% endif %} diff --git a/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md b/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md index e11f7e735051..d9cf56e750aa 100644 --- a/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md +++ b/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md @@ -42,7 +42,9 @@ Ao instalar ou publicar uma imagem Docker, a {% data variables.product.prodname_ ## Efetuar a autenticação no {% data variables.product.prodname_container_registry %} -{% data reusables.package_registry.authenticate_with_pat_for_container_registry %} +{% ifversion fpt or ghec or ghes > 3.4 %} +Para efetuar a autenticação no {% data variables.product.prodname_container_registry %} (`ghcr.io`) dentro de um fluxo de trabalho de {% data variables.product.prodname_actions %}, use o `GITHUB_TOKEN` para uma melhor segurança e experiência. {% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} +{% endif %} {% ifversion ghes %}Certifique-se de substituir o `HOSTNAME` pelo nome do host {% data variables.product.product_location_enterprise %} ou endereço IP nos exemplos abaixo.{% endif %} diff --git a/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md b/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md index 993e933de3bb..8007cd2b6f96 100644 --- a/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md +++ b/translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md @@ -21,6 +21,8 @@ shortTitle: npm registry {% data reusables.package_registry.admins-can-configure-package-types %} +{% ifversion packages-npm-v2 %} +{% else %} ## Limits for published npm versions If you publish over 1,000 npm package versions to {% data variables.product.prodname_registry %}, you may see performance issues and timeouts occur during usage. @@ -28,12 +30,17 @@ If you publish over 1,000 npm package versions to {% data variables.product.prod In the future, to improve performance of the service, you won't be able to publish more than 1,000 versions of a package on {% data variables.product.prodname_dotcom %}. Any versions published before hitting this limit will still be readable. If you reach this limit, consider deleting package versions or contact Support for help. When this limit is enforced, our documentation will be updated with a way to work around this limit. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" or "[Contacting Support](/packages/learn-github-packages/about-github-packages#contacting-support)." +{% endif %} ## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} -{% data reusables.package_registry.authenticate-packages-github-token %} +{% ifversion packages-npm-v2 %} +{% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} + +You can also choose to give access permissions to packages independently for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_actions %}. For more information, see "[Ensuring Codespaces access to your package](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-codespaces-access-to-your-package) and [Ensuring workflow access to your package](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-workflow-access-to-your-package)." +{% endif %} ### Authenticating with a personal access token @@ -94,12 +101,24 @@ $ npm login --scope=@OWNER --registry=https://HOSTNAME/_regist {% endnote %} +{% ifversion packages-npm-v2 %} +The {% data variables.product.prodname_registry %} registry stores npm packages within your organization or personal account, and allows you to associate a package with a repository. You can choose whether to inherit permissions from a repository, or set granular permissions independently of a repository. +{% endif %} + By default, {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the name field of the *package.json* file. For example, you would publish a package named `@my-org/test` to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. If you're running [npm v8.5.3](https://github.com/npm/cli/releases/tag/v8.5.3) or later, you can add a summary for the package listing page by including a *README.md* file in your package directory. For more information, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" and "[How to create Node.js Modules](https://docs.npmjs.com/getting-started/creating-node-modules)" in the npm documentation. You can publish multiple packages to the same {% data variables.product.prodname_dotcom %} repository by including a `URL` field in the *package.json* file. For more information, see "[Publishing multiple packages to the same repository](#publishing-multiple-packages-to-the-same-repository)." +{% ifversion fpt or ghec %} +When a package is published, it isn't automatically linked to a repository. You can however choose to link your published package to a repository using the user interface or command line. For more information, see "[Connecting a repository to a package](/packages/learn-github-packages/connecting-a-repository-to-a-package)." +{% endif %} + You can set up the scope mapping for your project using either a local *.npmrc* file in the project or using the `publishConfig` option in the *package.json*. {% data variables.product.prodname_registry %} only supports scoped npm packages. Scoped packages have names with the format of `@owner/name`. Scoped packages always begin with an `@` symbol. You may need to update the name in your *package.json* to use the scoped name. For example, `"name": "@codertocat/hello-world-npm"`. +{% ifversion packages-npm-v2 %} +When you first publish a package, the default visibility is private. When a package is linked to repository, the package visibility is dependent on the repository's visibility. To change the visibility or set access permissions, see "[Configuring a package's access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." +{% endif %} + {% data reusables.package_registry.viewing-packages %} ### Publishing a package using a local *.npmrc* file diff --git a/translations/pt-BR/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md b/translations/pt-BR/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md index e1e26ceaa4e4..74f7f172d5a9 100644 --- a/translations/pt-BR/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md +++ b/translations/pt-BR/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md @@ -46,7 +46,7 @@ Para configurar um `www` ou um subdomínio personalizado como, por exemplo, `www {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} 4. Em "Domínio personalizado,", digite o seu domínio personalizado e clique em **Salvar**. Se você estiver publicando seu site a partir de um branch, isso irá criar um commit que adiciona um arquivo `CNAME` à raiz do seu branch de origem. Se você publicar o seu site com um fluxo de trabalho de {% data variables.product.prodname_actions %} personalizado, não será criado nenhum arquivo `CNAME`. Para obter mais informações sobre a fonte de publicação, consulte "[Configurando uma fonte de publicação para o site do GitHub Pages](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)". ![Botão Salvar domínio personalizado](/assets/images/help/pages/save-custom-subdomain.png) -5. Navegue até o provedor DNS e crie um registro `CNAME` que aponte seu subdomínio para o domínio padrão do seu site. Por exemplo, se você quiser usar o subdomínio `www.example.com` para seu site de usuário, crie um registro `CNAME` que aponte `www.example.com` para `.github.io`. Se você desejar usar o subdomínio `www.anotherexample.com` no seu site da organização, crie um registro `CNAME` que aponte `www. notherexample.com` para `.github.io`. O registro `CNAME` sempre deve apontar para `.github.io` ou `.github.io`, excluindo o nome do repositório. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} +5. Navegue até o provedor DNS e crie um registro `CNAME` que aponte seu subdomínio para o domínio padrão do seu site. Por exemplo, se você quiser usar o subdomínio `www.example.com` para seu site de usuário, crie um registro `CNAME` que aponte `www.example.com` para `.github.io`. If you want to use the subdomain `another.example.com` for your organization site, create a `CNAME` record that points `another.example.com` to `.github.io`. O registro `CNAME` sempre deve apontar para `.github.io` ou `.github.io`, excluindo o nome do repositório. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} {% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %} {% data reusables.command_line.open_the_multi_os_terminal %} diff --git a/translations/pt-BR/content/pages/getting-started-with-github-pages/about-github-pages.md b/translations/pt-BR/content/pages/getting-started-with-github-pages/about-github-pages.md index 74e75dee5d2e..ec3d264fe794 100644 --- a/translations/pt-BR/content/pages/getting-started-with-github-pages/about-github-pages.md +++ b/translations/pt-BR/content/pages/getting-started-with-github-pages/about-github-pages.md @@ -1,6 +1,6 @@ --- title: Sobre o GitHub Pages -intro: 'Você pode usar {% data variables.product.prodname_pages %} para hospedar um site sobre você, sua organização, ou seu projeto diretamente a partir de um repositório em {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}.' +intro: 'Você pode usar {% data variables.product.prodname_pages %} para hospedar um site sobre você, sua organização, ou seu projeto diretamente a partir de um repositório no {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}.' redirect_from: - /articles/what-are-github-pages - /articles/what-is-github-pages @@ -75,7 +75,7 @@ Para obter mais informações, consulte "[Habilitar isolamento de subdomínio](/ {% data reusables.pages.pages-about-publishing-source %} -For more information, see "[Configuring a publishing source for your GitHub Pages site](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." +Para obter mais informações, consulte "[Configurando uma fonte de publicação para o site do GitHub Pages](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)". {% ifversion ghec %} ## Limitações para {% data variables.product.prodname_emus %} @@ -93,9 +93,9 @@ O {% data variables.product.prodname_pages %} publica qualquer arquivo estático {% ifversion pages-custom-workflow %} -If you use a custom build process or a static site generator other than Jekyll, you can write a {% data variables.product.prodname_actions %} to build and publish your site. {% data variables.product.product_name %} provides starter workflows for several static site generators. For more information, see "[Configuring a publishing source for your GitHub Pages site](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." +Se você usar um processo de compilação personalizado ou um gerador de site estático diferente do Jekyll, você poderá escrever um {% data variables.product.prodname_actions %} para criar e publicar seu site. O {% data variables.product.product_name %} fornece fluxos de trabalho iniciais para vários geradores de site estáticos. Para obter mais informações, consulte "[Configurando uma fonte de publicação para o site do GitHub Pages](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)". -If you publish your site from a source branch, {% data variables.product.prodname_pages %} will use Jekyll to build your site by default. If you want to use a static site generator other than Jekyll, we recommend that you write a {% data variables.product.prodname_actions %} to build and publish your site instead. Otherwise, disable the Jekyll build process by creating an empty file called `.nojekyll` in the root of your publishing source, then follow your static site generator's instructions to build your site locally. +Se você publicar seu site a partir de um branch fonte, o {% data variables.product.prodname_pages %} usará o Jekyll para criar seu site por padrão. Se quiser usar um gerador de site estático diferente do Jekyll, recomendamos que você escreva um {% data variables.product.prodname_actions %} para criar e publicar seu site. Caso contrário, desabilite o processo de compilação do Jekyll criando um arquivo vazio denominado `.nojekyll` na raiz da fonte de publicação e, em seguida, siga as instruções do gerador de site estático para criar seu site localmente. {% else %} @@ -125,8 +125,8 @@ Os sites do {% data variables.product.prodname_pages %} estão sujeitos ao segui - Os sites do {% data variables.product.prodname_pages %} publicados não podem ter mais de 1 GB. {% ifversion fpt or ghec %} - Sites de {% data variables.product.prodname_pages %} têm um limite de banda larga *flexível* de 100 GB por mês. - - {% data variables.product.prodname_pages %} sites have a *soft* limit of 10 builds per hour.{% ifversion pages-custom-workflow %} This limit does not apply if you build and publish your site with a custom {% data variables.product.prodname_actions %} workflow {% endif %} - - In order to provide consistent quality of service for all {% data variables.product.prodname_pages %} sites, rate limits may apply. These rate limits are not intended to interfere with legitimate uses of {% data variables.product.prodname_pages %}. If your request triggers rate limiting, you will receive an appropriate response with an HTTP status code of `429`, along with an informative HTML body. + - Os sites de {% data variables.product.prodname_pages %} têm um limite de *soft* de 10 compilações por hora.{% ifversion pages-custom-workflow %} Esse limite não se aplica se você criar e publicar seu site com um fluxo de trabalho personalizado de {% data variables.product.prodname_actions %} {% endif %} + - Para fornecer uma qualidade consistente de serviço para todos os sites de {% data variables.product.prodname_pages %}, é possível que se apliquem limites de taxa. Esses limites de taxa não são destinados a interferir nos usos legítimos de {% data variables.product.prodname_pages %}. Se o seu pedido acionar limites de taxa, você receberá uma resposta apropriada com um código de status HTTP de `429`, junto com um texto HTML informativo. Se o seu site exceder essas cotas de uso, talvez não possamos atender a ele ou você receba um e-mail formal do {% data variables.contact.contact_support %} sugerindo estratégias para reduzir o impacto do site em nossos servidores, como colocar uma rede de distribuição de conteúdo (CDN, Content Distribution Network) de terceiros na frente do site, usar outros recursos do {% data variables.product.prodname_dotcom %}, como versões, ou migrar para outro serviço de hospedagem que possa atender melhor às suas necessidades. diff --git a/translations/pt-BR/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md b/translations/pt-BR/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md index 5543fb7bdda8..47ad696404fb 100644 --- a/translations/pt-BR/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md +++ b/translations/pt-BR/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md @@ -1,6 +1,6 @@ --- title: Configurar uma fonte de publicação para o site do GitHub Pages -intro: '{% ifversion pages-custom-workflow %}You can configure your {% data variables.product.prodname_pages %} site to publish when changes are pushed to a specific branch, or you can write a {% data variables.product.prodname_actions %} workflow to publish your site.{% else%}If you use the default publishing source for your {% data variables.product.prodname_pages %} site, your site will publish automatically. You can also choose to publish your site from a different branch or folder.{% endif %}' +intro: '{% ifversion pages-custom-workflow %}Você pode configurar seu site de {% data variables.product.prodname_pages %} para publicar quando as alterações são enviadas para um branch específico ou você pode escrever um fluxo de trabalho de {% data variables.product.prodname_actions %} para publicar seu site.{% else%}Se você usar a fonte de publicação padrão do seu site de {% data variables.product.prodname_pages %}, seu site será publicado automaticamente. Você também pode optar por publicar o seu site a partir de um branch ou uma pasta diferente.{% endif %}' redirect_from: - /articles/configuring-a-publishing-source-for-github-pages - /articles/configuring-a-publishing-source-for-your-github-pages-site @@ -17,21 +17,21 @@ topics: shortTitle: Configurar fonte de publicação --- -## About publishing sources +## Sobre as fontes de publicação {% data reusables.pages.pages-about-publishing-source %} {% data reusables.pages.private_pages_are_public_warning %} -## Publishing from a branch +## Publicando a partir de um branch -1. Make sure the branch you want to use as your publishing source already exists in your repository. +1. Certifique-se de que o branch que você deseja usar como fonte de publicação já existe no repositório. {% data reusables.pages.navigate-site-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} {% ifversion pages-custom-workflow %} -1. Under "Build and deployment", under "Source", select **Deploy from a branch**. -1. Under "Build and deployment", under "Branch", use the **None** or **Branch** drop-down menu and select a publishing source. +1. Em "Compilação e implantação", em "Fonte", selecione **Implantar a partir de um branch**. +1. Em "Compilação e implantação", em "Branch", use o menu suspenso **Nenhum** ou **Branch** e selecione uma fonte de publicação. ![Menu suspenso para selecionar uma fonte de publicação](/assets/images/help/pages/publishing-source-drop-down.png) {% else %} @@ -40,7 +40,7 @@ shortTitle: Configurar fonte de publicação 4. Opcionalmente, use o menu suspenso para selecionar uma pasta para sua fonte de publicação. ![Menu suspenso para selecionar uma pasta para a fonte de publicação](/assets/images/help/pages/publishing-source-folder-drop-down.png) 5. Clique em **Salvar**. ![Botão para salvar alterações nas configurações da fonte de publicação](/assets/images/help/pages/publishing-source-save.png) -### Troubleshooting publishing from a branch +### Solucionar problemas de publicação a partir de um branch {% data reusables.pages.admin-must-push %} @@ -56,42 +56,42 @@ Para encontrar possíveis erros com a compilação ou implantação, você pode {% ifversion pages-custom-workflow %} -## Publishing with a custom {% data variables.product.prodname_actions %} workflow +## Publicação com um fluxo de trabalho de {% data variables.product.prodname_actions %} personalizado {% data reusables.pages.pages-custom-workflow-beta %} -To configure your site to publish with {% data variables.product.prodname_actions %}: +Para configurar seu site para publicar com {% data variables.product.prodname_actions %}: {% data reusables.pages.navigate-site-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} -1. Under "Build and deployment", under "Source", select **GitHub Actions**. -1. {% data variables.product.product_name %} will suggest several starter workflows. If you already have a workflow to publish your site, you can skip this step. Otherwise, choose one of the options to create a {% data variables.product.prodname_actions %} workflow. For more information about creating your custom workflow, see "[Creating a custom {% data variables.product.prodname_actions %} workflow to publish your site](#creating-a-custom-github-actions-workflow-to-publish-your-site)." +1. Em "Compilação e implantação", em "Fonte", selecione **GitHub Actions**. +1. {% data variables.product.product_name %} irá sugerir vários fluxos de trabalho iniciais. Se você já tem um fluxo de trabalho para publicar o site, você pode pular esta etapa. Caso contrário, escolha uma das opções para criar um fluxo de trabalho de {% data variables.product.prodname_actions %}. Para obter mais informações sobre a criação de seu fluxo de trabalho personalizado, consulte "[Criando um fluxo de trabalho de {% data variables.product.prodname_actions %} personalizado para publicar seu site](#creating-a-custom-github-actions-workflow-to-publish-your-site)". - {% data variables.product.prodname_pages %} does not associate a specific workflow to the {% data variables.product.prodname_pages %} settings. However, the {% data variables.product.prodname_pages %} settings will link to the workflow run that most recently deployed your site. + {% data variables.product.prodname_pages %} não associa um fluxo de trabalho específico às configurações de {% data variables.product.prodname_pages %}. No entanto, as configurações do {% data variables.product.prodname_pages %} serão ligadas à execução do fluxo de trabalho que o seu site implantou mais recentemente. -### Creating a custom {% data variables.product.prodname_actions %} workflow to publish your site +### Criar um fluxo de trabalhode {% data variables.product.prodname_actions %} personalizado para publicar seu site -For more information about {% data variables.product.prodname_actions %}, see "[Actions](/actions)." +Para obter mais informações sobre {% data variables.product.prodname_actions %}, consulte "[Actions](/actions)." -When you configure your site to publish with {% data variables.product.prodname_actions %}, {% data variables.product.product_name %} will suggest starter workflows for common publishing scenarios. The general flow of a workflow is to: +Ao configurar seu site para publicar com {% data variables.product.prodname_actions %}, {% data variables.product.product_name %} irá sugerir fluxos de trabalho iniciantes para cenários de publicação comuns. O fluxo de trabalho geral é: -1. Trigger whenever there is a push to the default branch of the repository or whenever a pull request that targets the default branch is opened, reopened, or updated. -1. Use the [`actions/checkout`](https://github.com/actions/checkout) action to check out the repository contents. -1. If required by your site, build any static site files. -1. Use the [`actions/upload-pages-artifact`](https://github.com/actions/upload-pages-artifact) action to upload the static files as an artifact. -1. If the workflow was triggered by a push to the default branch, use the [`actions/deploy-pages`](https://github.com/actions/deploy-pages) action to deploy the artifact. This step is skipped if the workflow was triggered by a pull request. +1. Acionar sempre que houver um push para o branch padrão do repositório ou sempre que um pull request que apontar para o branch padrão for aberto, reaberto ou atualizado. +1. Use a ação [`ações/checkout`](https://github.com/actions/checkout) para conferir o conteúdo do repositório. +1. Se o seu site exigir, crie qualquer arquivo de site estático. +1. Use a ação [`actions/upload-pages-artifact`](https://github.com/actions/upload-pages-artifact) para fazer upload dos arquivos estáticos como um artefato. +1. Se o fluxo de trabalho foi acionado por um push para o branch padrão, use a ação [`actions/deploy-pages`](https://github.com/actions/deploy-pages) para implantar o artefato. Esta etapa é ignorada se o fluxo de trabalho foi acionado por um pull request. -The starter workflows use a deployment environment called `github-pages`. If your repository does not already include an environment called `github-pages`, the environment will be created automatically. We recommend that you add an environment protection rule so that only the default branch can deploy to this environment. Para obter mais informações, consulte "[Usando ambientes para implantação](/actions/deployment/targeting-different-environments/using-environments-for-deployment)". +Os fluxos de trabalho iniciais usam um ambiente de implantação denominado `github-pages`. Se seu repositório ainda não incluir um ambiente denominado `github-pages`, o ambiente será criado automaticamente. Recomendamos que você adicione uma regra de proteção de ambiente para que apenas o branch padrão possa fazer a implantação nesse ambiente. Para obter mais informações, consulte "[Usando ambientes para implantação](/actions/deployment/targeting-different-environments/using-environments-for-deployment)". {% note %} -**Note**: A `CNAME` file in your repository file does not automatically add or remove a custom domain. Instead, you must configure the custom domain through your repository settings or through the API. For more information, see "[Managing a custom domain for your GitHub Pages site](/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site#configuring-a-subdomain)" and the [Pages API reference documentation](/rest/pages#update-information-about-a-github-pages-site). +**Observação**: Um arquivo `CNAME` no seu arquivo de repositório não adiciona ou remove automaticamente um domínio personalizado. Em vez disso, você deve configurar o domínio personalizado por meio das configurações do repositório ou da API. Para obter mais informações, consulte "[Gerenciando um domínio personalizado para o seu site do GitHub Pages](/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site#configuring-a-subdomain) e [a documentação de referência da API do Pages](/rest/pages#update-information-about-a-github-pages-site). {% endnote %} -### Troubleshooting publishing with a custom {% data variables.product.prodname_actions %} workflow +### Solucionar problemas de publicação com um fluxo de trabalho personalizado de {% data variables.product.prodname_actions %} -For information about how to troubleshoot your {% data variables.product.prodname_actions %} workflow, see "[About monitoring and troubleshooting](/actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting)." +Para obter informações sobre como solucionar seu fluxo de trabalho de {% data variables.product.prodname_actions %}, consulte "[Sobre o monitoramento e solução de problemas](/actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting)." {% endif %} diff --git a/translations/pt-BR/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md b/translations/pt-BR/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md index c09c2a7f84ba..53a77c58fb3e 100644 --- a/translations/pt-BR/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md +++ b/translations/pt-BR/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md @@ -45,7 +45,7 @@ shortTitle: Criar um site do GitHub Pages {% ifversion pages-custom-workflow %}Se sua fonte de publicação for um branch e uma psata, o arquivo de entrada deverá estar no nível superior da pasta de origem no branch de origem. Por exemplo, se a fonte de publicação for a pasta `/docs` no branch principal`, o arquivo de postagem deverá estar localizado na pasta /docs` em um branch denominado `principal`. - Se sua fonte de publicação for um fluxo de trabalho de {% data variables.product.prodname_actions %}, o artefato de que você implantar deverá incluir o arquivo de entrada no nível superior do artefato. Instead of adding the entry file to your repository, you may choose to have your {% data variables.product.prodname_actions %} workflow generate your entry file when the workflow runs.{% else %} The entry file must be at the top level of your chosen publishing source. For example, if your publishing source is the `/docs` folder on the `main` branch, your entry file must be located in the `/docs` folder on a branch called `main`.{% endif %} + Se sua fonte de publicação for um fluxo de trabalho de {% data variables.product.prodname_actions %}, o artefato de que você implantar deverá incluir o arquivo de entrada no nível superior do artefato. Em vez de adicionar o arquivo de entrada ao seu repositório, você pode optar por fazer com que o seu fluxo de trabalho {% data variables.product.prodname_actions %} gere o arquivo de entrada quando o fluxo de trabalho é executado.{% else %} O arquivo de entrada deve estar no nível superior da fonte de publicação escolhida. Por exemplo, se a fonte de publicação for a pasta `/docs` no branch principal`, o arquivo de postagem deverá estar localizado na pasta /docs` em um branch denominado `principal`.{% endif %} {% data reusables.pages.configure-publishing-source %} {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} @@ -59,7 +59,7 @@ shortTitle: Criar um site do GitHub Pages Você pode adicionar mais páginas ao seu site criando novos arquivos. Cada arquivo ficará disponível no site na mesma estrutura de diretórios que a fonte de publicação. Por exemplo, se a fonte de publicação do site de projeto for o branch `gh-pages` e você criar um arquivo chamado `/about/contact-us.md` no branch `gh-pages`, o arquivo novo ficará disponível em {% ifversion fpt or ghec %}`https://.github.io//{% else %}`http(s):///pages///{% endif %}about/contact-us.html`. -Também é possível adicionar um tema para personalizar a aparência do site. For more information, see "[Adding a theme to your {% data variables.product.prodname_pages %} site using Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)". +Também é possível adicionar um tema para personalizar a aparência do site. Para obter mais informações, consulte "[Adicionar um tema ao site do {% data variables.product.prodname_pages %} usando o Jekyll](/articles/adding-a-theme-to-your-github-pages-site-using-jekyll)". Para personalizar seu site ainda mais, você pode usar o Jekyll, um gerador de site estático com suporte integrado para o {% data variables.product.prodname_pages %}. Para obter mais informações, consulte "[Sobre {% data variables.product.prodname_pages %} e o Jekyll](/articles/about-github-pages-and-jekyll)". diff --git a/translations/pt-BR/content/pages/quickstart.md b/translations/pt-BR/content/pages/quickstart.md index ec69da6fa9b8..c2c223e7e2e1 100644 --- a/translations/pt-BR/content/pages/quickstart.md +++ b/translations/pt-BR/content/pages/quickstart.md @@ -26,11 +26,11 @@ Este guia irá orientar você com relação à criação de um site em `username 1. Digite `username.github.io` como nome do repositório. Substitua `nome de usuário` pelo seu nome de usuário de {% data variables.product.prodname_dotcom %}. Por exemplo, se seu nome de usuário for `octocat`, o nome do repositório deverá ser `octocat.github.io`. ![Campo nome do repositório](/assets/images/help/pages/create-repository-name-pages.png) {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} -1. Under "Build and deployment", under "Source", select **Deploy from a branch**. -1. Under "Build and deployment", under "Branch", use the **None** or **Branch** drop-down menu and select a publishing source. +1. Em "Compilação e implantação", em "Fonte", selecione **Implantar a partir de um branch**. +1. Em "Compilação e implantação", em "Branch", use o menu suspenso **Nenhum** ou **Branch** e selecione uma fonte de publicação. ![Menu suspenso para selecionar uma fonte de publicação](/assets/images/help/pages/publishing-source-drop-down.png) -1. Optionally, open the `README.md` file of your repository. O arquivo `README.md` é onde você escreverá o conteúdo do seu site. Você pode editar o arquivo ou manter o conteúdo padrão por enquanto. +1. Opcionalmente, abra o arquivo `README.md` do seu repositório. O arquivo `README.md` é onde você escreverá o conteúdo do seu site. Você pode editar o arquivo ou manter o conteúdo padrão por enquanto. 1. Acesse `username.github.io` para ver seu novo site. **Observação:** podem ser necessários até 10 minutos para que as alterações no site sejam publicadas após o push delas no {% data variables.product.product_name %}. ## Alterando o título e a descrição diff --git a/translations/pt-BR/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md b/translations/pt-BR/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md index 298d1675f073..e3427823f81a 100644 --- a/translations/pt-BR/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md +++ b/translations/pt-BR/content/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites.md @@ -19,7 +19,7 @@ shortTitle: Erros de criação do Jekyll para as páginas ## Sobre erros de criação do Jekyll -{% ifversion pages-custom-workflow %}If you are publishing from a branch, sometimes{% else %}Sometimes,{% endif %} {% data variables.product.prodname_pages %} will not attempt to build your site after you push changes to your site's publishing source.{% ifversion fpt or ghec %} +{% ifversion pages-custom-workflow %}Se você estiver publicando em uma branch, às vezes{% else %}às vezes,{% endif %} {% data variables.product.prodname_pages %} não tentará criar seu site depois que você fizer push das alterações na fonte de publicação do seu site.{% ifversion fpt or ghec %} - A pessoa que fez push das alterações não verificou o endereço de e-mail dela. Para obter mais informações, consulte "[Verificar o endereço de e-mail](/articles/verifying-your-email-address)".{% endif %} - Você está fazendo push com uma chave de implantação. Se desejar automatizar pushes para o repositório do seu site, você poderá configurar um usuário de máquina. Para obter mais informações, consulte "[Gerenciar chaves de implantação](/developers/overview/managing-deploy-keys#machine-users)". - Você está usando um serviço de CI que não está configurado para criar sua fonte de publicação. Por exemplo, Travis CI não criará o branch `gh-pages`, a menos que você adicione o branch a uma lista segura. Para obter mais informações, consulte "[Personalizar a criação](https://docs.travis-ci.com/user/customizing-the-build/#safelisting-or-blocklisting-branches)" em Travis CI ou na documentação do seu serviço de CI. @@ -58,15 +58,15 @@ Por padrão, seu site de {% data variables.product.prodname_pages %} foi criado ## Visualizando mensagens de erro de criação do Jekyll no seu pull request -{% ifversion pages-custom-workflow %}If you are publishing from a branch, when{% else %}When{% endif %} you create a pull request to update your publishing source on {% data variables.product.product_name %}, you can see build error messages on the **Checks** tab of the pull request. Para obter mais informações, consulte "[Sobre verificações de status](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)". +{% ifversion pages-custom-workflow %}Se você estiver publicando a partir de um branch, quando{% else %}Quando{% endif %} você cria um pull request para atualizar a sua fonte de pulicação em {% data variables.product.product_name %}, você pode ver as mensagens de erro de criação na aba **Verificações** do pull request. Para obter mais informações, consulte "[Sobre verificações de status](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)". -{% ifversion pages-custom-workflow %}If you are publishing with a custom {% data variables.product.prodname_actions %} workflow, in order to see build error messages in your pull request, you must configure your workflow to run on the `pull_request` trigger. When you do this, we recommend that you skip any deploy steps if the workflow was triggered by the `pull_request` event. This will allow you to see any build errors without deploying the changes from your pull request to your site. For more information, see "[Events that trigger workflows](/actions/using-workflows/events-that-trigger-workflows#pull_request)" and "[Expressions](/actions/learn-github-actions/expressions)."{% endif %} +{% ifversion pages-custom-workflow %}Se você estiver publicando com um fluxo de trabalho personalizado de {% data variables.product.prodname_actions %}, para ver as mensagens de erro de criação no seu pull request, você deve configurar seu fluxo de trabalho para executar o gatilho `pull_request`. Ao fazer isso, recomendamos que você ignore todas as etapas de implantação se o fluxo de trabalho foi acionado pelo evento `pull_request`. Isso permitirá que você veja todos os erros de criação sem implantar as alterações de seu pull request para seu site. Para obter mais informações, consulte "[Eventos que acionam fluxos de trabalho](/actions/using-workflows/events-that-trigger-workflows#pull_request)" e "[Expressões](/actions/learn-github-actions/expressions)".{% endif %} ## Visualizando os erros de criação do Jekyll por e-mail -{% ifversion pages-custom-workflow %}If you are publishing from a branch, when{% else %}When{% endif %} you push changes to your publishing source on {% data variables.product.product_name %}, {% data variables.product.prodname_pages %} will attempt to build your site. Se a criação falhar, você receberá um e-mail no seu endereço de e-mail principal. {% data reusables.pages.build-failure-email-server %} +{% ifversion pages-custom-workflow %}Se você estiver publicando a partir de um branch, quando{% else %}quando{% endif %} você fizer push de alterações na sua fonte de publicação em {% data variables.product.product_name %}, {% data variables.product.prodname_pages %} tentará criar seu site. Se a criação falhar, você receberá um e-mail no seu endereço de e-mail principal. {% data reusables.pages.build-failure-email-server %} -{% ifversion pages-custom-workflow %}If you are publishing with a custom {% data variables.product.prodname_actions %} workflow, in order to receive emails about build errors in your pull request, you must configure your workflow to run on the `pull_request` trigger. When you do this, we recommend that you skip any deploy steps if the workflow was triggered by the `pull_request` event. This will allow you to see any build errors without deploying the changes from your pull request to your site. For more information, see "[Events that trigger workflows](/actions/using-workflows/events-that-trigger-workflows#pull_request)" and "[Expressions](/actions/learn-github-actions/expressions)."{% endif %} +{% ifversion pages-custom-workflow %}Se você está publicando com um fluxo de trabalho personalizado de {% data variables.product.prodname_actions %}, para receber e-mails sobre erros de criação em sua pull request, você deve configurar seu fluxo de trabalho para executar o gatilho `pull_request`. Ao fazer isso, recomendamos que você ignore todas as etapas de implantação se o fluxo de trabalho foi acionado pelo evento `pull_request`. Isso permitirá que você veja todos os erros de criação sem implantar as alterações de seu pull request para seu site. Para obter mais informações, consulte "[Eventos que acionam fluxos de trabalho](/actions/using-workflows/events-that-trigger-workflows#pull_request)" e "[Expressões](/actions/learn-github-actions/expressions)".{% endif %} ## Visualizando as mensagens de erro do Jekyll no seu pull request com um serviço de CI de terceiros diff --git a/translations/pt-BR/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md b/translations/pt-BR/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md index d29a0d912ae3..38d5a0d9a96f 100644 --- a/translations/pt-BR/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md +++ b/translations/pt-BR/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md @@ -43,12 +43,12 @@ Se o Jekyll encontrar um erro ao criar seu site do {% data variables.product.pro Se você recebeu uma mensagem de erro genérica, verifique os problemas comuns. - Você está usando plugins incompatíveis. Para obter mais informações, consulte "[Sobre o {% data variables.product.prodname_pages %} e o Jekyll](/articles/about-github-pages-and-jekyll#plugins)".{% ifversion fpt or ghec %} - Seu repositório excedeu os limites de tamanho. Para obter mais informações, consulte "[Qual é a minha quota de disco?](/articles/what-is-my-disk-quota)"{% endif %} -- Você alterou a configuração `source` no arquivo *_config.yml*. {% ifversion pages-custom-workflow %}If you publish your site from a branch, {% endif %}{% data variables.product.prodname_pages %} overrides this setting during the build process. -- A filename in your published files contains a colon (`:`) which is not supported. +- Você alterou a configuração `source` no arquivo *_config.yml*. {% ifversion pages-custom-workflow %}Se você publicar seu site a partir de um branch, {% endif %}{% data variables.product.prodname_pages %} irá substituir essa configuração durante o processo de criação. +- Um nome de arquivo em seus arquivos publicados contém dois pontos (`:`) o que não é compatível. Se você recebeu uma mensagem de erro específica, revise abaixo as informações de solução de problemas relativas à mensagem de erro. -{% ifversion pages-custom-workflow %}After you've fixed any errors, trigger another build by pushing the changes to your site's source branch (if you are publishing from a branch) or by triggering your custom {% data variables.product.prodname_actions %} workflow (if you are publishing with {% data variables.product.prodname_actions %}).{% else %}After you've fixed any errors, push the changes to your site's publishing source to trigger another build on {% data variables.product.product_name %}.{% endif %} +{% ifversion pages-custom-workflow %}Depois de corrigir todos os erros, acionar outra compilação, enviando as alterações por push para o branch de origem do seu site de (se você estiver publicando de uma filial) ou acionando o fluxo de trabalho personalizado do {% data variables.product.prodname_actions %} (se você estiver publicando com {% data variables.product.prodname_actions %}).{% else %}Depois de corrigir todos os erros, envie as alterações por push para a fonte de publicação do seu site para acionar outra compilação em {% data variables.product.product_name %}.{% endif %} ## Erro no arquivo de configuração @@ -74,7 +74,7 @@ Este erro significa que o código faz referência a um arquivo que não existe n ## O arquivo é um link simbólico -This error means that your code references a symlinked file that does not exist in the published files for your site. +Este erro significa que o código faz referência a um arquivo com link simbólico que não existe nos arquivos publicados para o seu site. {% data reusables.pages.search-for-includes %} Se algum dos arquivos a que você fez referência for com link simbólico, copie ou mova os arquivos para o diretório *_includes*. @@ -162,9 +162,9 @@ Para solucionar problemas, remova a linha `relative_permalinks` do arquivo *_con ## O link simbólico não existe no repositório do site -This error means that your site includes a symbolic link (symlink) that does not exist in the published files for your site. Para obter mais informações sobre links simbólicos, consulte "[Link simbólico](https://en.wikipedia.org/wiki/Symbolic_link)" na Wikipédia. +Este erro significa que seu site inclui um link simbólico (symlink) que não existe nos arquivos publicados em seu site. Para obter mais informações sobre links simbólicos, consulte "[Link simbólico](https://en.wikipedia.org/wiki/Symbolic_link)" na Wikipédia. -Para solucionar problemas, determine se o arquivo na mensagem de erro é usado para criar o site. Se ele não for ou se você não quiser que o arquivo seja um link simbólico, exclua o arquivo. If the symlinked file is necessary to build your site, make sure the file or directory the symlink references is in the published files for your site. Para incluir ativos externos, considere usar {% ifversion fpt or ghec %}`submódulo do Git` ou {% endif %}um gerenciador de pacotes terceirizado como o [Bower](https://bower.io/).{% ifversion fpt or ghec %} Para obter mais informações, consulte "[Usar submódulos com o {% data variables.product.prodname_pages %}](/articles/using-submodules-with-github-pages)".{% endif %} +Para solucionar problemas, determine se o arquivo na mensagem de erro é usado para criar o site. Se ele não for ou se você não quiser que o arquivo seja um link simbólico, exclua o arquivo. Se o arquivo com o link simbólico for necessário para criar seu site, certifique-se de que o arquivo ou diretório ao qual o link simbólico faz referência esteja nos arquivos publicados no seu site. Para incluir ativos externos, considere usar {% ifversion fpt or ghec %}`submódulo do Git` ou {% endif %}um gerenciador de pacotes terceirizado como o [Bower](https://bower.io/).{% ifversion fpt or ghec %} Para obter mais informações, consulte "[Usar submódulos com o {% data variables.product.prodname_pages %}](/articles/using-submodules-with-github-pages)".{% endif %} ## Erro de sintaxe no loop 'for' diff --git a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md index c7581169887d..fd13d8791f81 100644 --- a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md +++ b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md @@ -16,18 +16,18 @@ topics: - Pull requests --- -## Merge your commits +## Fazer merge dos seus commits {% data reusables.pull_requests.default_merge_option %} -## Squash and merge your commits +## Fazer combinação por squash e merge dos seus commits {% data reusables.pull_requests.squash_and_merge_summary %} ### Mesclar mensagem para uma mesclagem por squash {% ifversion default-merge-squash-commit-message %} -Ao fazer combinação por squash e merge, {% data variables.product.prodname_dotcom %} gera uma mensagem de commit padrão, que você pode editar. Depending on how the repository is configured and the number of commits in the pull request, not including merge commits, this message may include the pull request title, pull request description, or information about the commits. +Ao fazer combinação por squash e merge, {% data variables.product.prodname_dotcom %} gera uma mensagem de commit padrão, que você pode editar. Dependendo de como o repositório é configurado e do número de commits no pull request, não sem incluir os commits do merge, esta mensagem poderá incluir o título do pull request, descrição do pull request ou informações sobre o commits. {% else %} Ao fazer combinação por squash e merge, {% data variables.product.prodname_dotcom %} gera uma mensagem de commit padrão, que você pode editar. A mensagem padrão depende do número de commits no pull request, que não inclui commits de merge. @@ -43,7 +43,7 @@ Ao fazer combinação por squash e merge, {% data variables.product.prodname_dot | Mais de um commit | Título da pull request, seguido do número da pull request | Uma lista das mensagens de commit para todos os commits combinados por squash, por ordem de data | {% ifversion default-merge-squash-commit-message %} -People with maintainer or admin access to a repository can configure their repository's default merge message for all squashed commits to use the pull request title, the pull request title and commit details, or the pull request title and description. For more information, see "[Configure commit squashing](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests)".{% endif %} +As pessoas com acesso de mantenedor ou administrador a um repositório podem configurar a mensagem de merge padrão de seu repositório para todos os commits combinados por squash para usar o título do pull request, os detalhes do título e do commit do pull request ou o título e a descrição do pull request. Para obter mais informações, consulte "[Configurar o commit combinado por squash](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests)".{% endif %} {% ifversion ghes = 3.6 %} As pessoas com acesso de administrador a um repositório podem configurar o repositório para usar o título do pull request como a mensagem de merge padrão para todos os commits combinados por squash. Para obter mais informações, consulte "[Configurar o commit combinado por squash](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests)". @@ -57,7 +57,7 @@ Quando você cria uma pull request, o {% data variables.product.prodname_dotcom Uma vez que esse commit está apenas no branch base e não no branch head, o ancestral comum dos dois branches permanece inalterado. Se você continuar a trabalhar no branch head e, em seguida, criar uma nova pull request entre os dois branches, a pull request incluirá todos os commits desde o ancestral comum, incluindo commits que você combinou por squash e fez merge na pull request anterior. Se não houver conflitos, você pode mesclar esses commits com segurança. No entanto, este fluxo de trabalho torna os conflitos de mesclagem mais prováveis. Se você continuar a combinar por squash e mesclar pull requests para um branch head de longo prazo, você terá que resolver os mesmos conflitos repetidamente. -## Rebase and merge your commits +## Faça rebase e merge dos seus commits {% data reusables.pull_requests.rebase_and_merge_summary %} diff --git a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md index e98cfec19fec..574af385fbf4 100644 --- a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md +++ b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md @@ -24,7 +24,7 @@ Antes de usar o merge automático com um pull request, o merge automático deve Depois que você ativar o merge automático para uma pull request, se alguém que não tiver permissões de gravação no repositório fizer push de novas alterações no branch principal ou alterar o branch de base do pull request, o merge automático será desabilitado. Por exemplo, se um mantenedor permitir o merge automático para um pull request a partir de uma bifurcação, o merge automático será desabilitado depois que um colaborador fizer push de novas alterações no pull request. -You can provide feedback about auto-merge through a [{% data variables.product.prodname_github_community %} discussion](https://github.com/orgs/community/discussions/categories/pull-requests). +Você pode fornecer feedback sobre a o merge automático por meio de uma discussão [{% data variables.product.prodname_github_community %}](https://github.com/orgs/community/discussions/categories/pull-requests). ## Habilitar merge automático diff --git a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md index b95a75d9baa6..614bd89a64fd 100644 --- a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md +++ b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.md @@ -27,7 +27,7 @@ redirect_from: 1. Na lista "Pull Requests", clique no pull request que você gostaria de adicionar a uma fila de merge. 1. Clique em **Fazer merge quando estiver pronto** para adicionar o pull request à fila de merge. Como alternativa, se você for um administrador, você pode: - - Directly merge the pull request by checking **Merge without waiting for requirements to be met ({% ifversion bypass-branch-protections %}bypass branch protections{% else %}administrators only{% endif %})**, if allowed by branch protection settings, and follow the standard flow. ![Opções da fila de merge](/assets/images/help/pull_requests/merge-queue-options.png) + - Faça o merge direto do pull request marcando **Merge sem espera para atendimento dos requisitos ({% ifversion bypass-branch-protections %}ignorar proteções do branch{% else %}apenas administradores{% endif %})**, se permitido pelas configurações de proteção de branches e siga o fluxo padrão. ![Opções da fila de merge](/assets/images/help/pull_requests/merge-queue-options.png) {% tip %} diff --git a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md index 04908b365317..e4e2653ed604 100644 --- a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md +++ b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md @@ -27,7 +27,7 @@ Você pode fazer comentários na guia **Conversation** (Conversa) de uma pull re Também é possível comentar em seções específicas de um arquivo na guia **Files changed** (Arquivos alterados) de uma pull request na forma de comentários em linha individuais ou como parte de uma [revisão de pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews). Adicionar comentários em linha é uma excelente maneira de discutir questões sobre implementação ou fornecer feedback ao autor. -For more information on adding line comments to a pull request review, see "[Reviewing proposed changes in a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)." +Para obter mais informações sobre como adicionar comentários em linha a uma revisão de pull request, consulte "[Revisar alterações propostas em um pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)". {% note %} diff --git a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork.md b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork.md index 72f51400c00c..c8462071e8f7 100644 --- a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork.md +++ b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork.md @@ -25,11 +25,11 @@ permissions: People with write access for a forked repository can sync the fork {% ifversion syncing-fork-web-ui %} 1. Em {% data variables.product.product_name %}, acesse a página principal do repositório bifurcado que você deseja sincronizar com o repositório upstream. -2. Select the **Sync fork** dropdown. !["Sync fork" dropdown emphasized](/assets/images/help/repository/sync-fork-dropdown.png) -3. Review the details about the commits from the upstream repository, then click **Update branch**. ![Sync fork modal with "Update branch" button emphasized](/assets/images/help/repository/update-branch-button.png) +2. Selecione o menu suspenso **Sincronizar bifurcação**. ![Menu suspenso "Sincronizar bifurcação" destacado](/assets/images/help/repository/sync-fork-dropdown.png) +3. Revise os detalhes sobre os commits do repositório upstream e clique em **Atualizar branch**. ![Modo sincronizar bifurcação com o botão "Atualizar branch" destacado](/assets/images/help/repository/update-branch-button.png) {% else %} 1. Em {% data variables.product.product_name %}, acesse a página principal do repositório bifurcado que você deseja sincronizar com o repositório upstream. -2. Select the **Fetch upstream** dropdown. ![Menu suspenso "Buscar upstream"](/assets/images/help/repository/fetch-upstream-drop-down.png) +2. Selecione o menu suspenso **Buscar upstream**. ![Menu suspenso "Buscar upstream"](/assets/images/help/repository/fetch-upstream-drop-down.png) 3. Revise as informações sobre os commits do repositório upstream e, em seguida, clique em **Buscar e merge**. !["Fetch and merge" button](/assets/images/help/repository/fetch-and-merge-button.png){% endif %} Se as alterações do repositório a upstream gerarem conflitos, {% data variables.product.company_short %} solicitará a criação de um pull request para resolver os conflitos. diff --git a/translations/pt-BR/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md b/translations/pt-BR/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md index 00fe1c38b46e..2e7a215e47a4 100644 --- a/translations/pt-BR/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md +++ b/translations/pt-BR/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits.md @@ -19,7 +19,7 @@ versions: {% data reusables.commits.about-commits %} {% ifversion commit-signoffs %} -If the repository you are committing to has compulsory commit signoffs enabled, and you are committing via the web interface, you will automatically sign off on the commit as part of the commit process. For more information, see "[Managing the commit signoff policy for your repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository)." {% endif %} +Se o repositório com o qual você está se comprometendo tiver assinaturas de commit habilitadas e você estiver fazendo o commit por meio da interface web, você irá automaticamente assinar o commit como parte do processo de commit. Para obter mais informações, consulte "[Gerenciando a política de assinatura de commit para o seu repositório](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository)". {% endif %} Você pode adicionar um coautor em qualquer commit em que colaborar. Para obter mais informações, consulte "[Criar um commit com vários autores](/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors)". diff --git a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-merging-for-pull-requests.md b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-merging-for-pull-requests.md index ca2e7821d7e1..fe21fd341314 100644 --- a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-merging-for-pull-requests.md +++ b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-merging-for-pull-requests.md @@ -1,6 +1,6 @@ --- -title: Configuring commit merging for pull requests -intro: 'You can enforce, allow, or disable merging with a merge commit for all pull request merges on {% data variables.product.product_location %} in your repository.' +title: Configurar o merge do commit para pull requests +intro: 'É possível aplicar, permitir ou desabilitar o merge com um commit de merge para todos os merge de pull request em {% data variables.product.product_location %} no seu repositório.' versions: fpt: '*' ghes: '*' @@ -8,18 +8,18 @@ versions: ghec: '*' topics: - Repositories -shortTitle: Configure commit merging +shortTitle: Configurar o merge de commit --- {% data reusables.pull_requests.configure_pull_request_merges_intro %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -1. Under {% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-6069 %}"Pull Requests"{% else %}"Merge button"{% endif %}, select **Allow merge commits**. This allows contributors to merge a pull request with a full history of commits.{% ifversion default-merge-squash-commit-message %} ![Screenshot of Pull Request settings with allow merge commits checkbox emphasized](/assets/images/help/repository/allow-merge-commits.png){% endif %}{% ifversion ghes = 3.6 %} ![Screenshot of Pull Request settings with allow merge commits checkbox emphasized](/assets/images/help/repository/allow-merge-commits-no-dropdown.png){% endif %} +1. Em {% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-6069 %}"Pull Requests"{% else %}"Botão de merge"{% endif %}, selecione **Permitir commits de merge**. Isso permite que os contribuidores façam merge de um pull request com um histórico completo dos commits.{% ifversion default-merge-squash-commit-message %} ![Screenshot of Pull Request settings with allow merge commits checkbox emphasized](/assets/images/help/repository/allow-merge-commits.png){% endif %}{% ifversion ghes = 3.6 %} ![Screenshot of Pull Request settings with allow merge commits checkbox emphasized](/assets/images/help/repository/allow-merge-commits-no-dropdown.png){% endif %} {% ifversion ghes < 3.6 %} ![allow_standard_merge_commits](/assets/images/help/repository/pr-merge-full-commits.png){% endif %} {% ifversion default-merge-squash-commit-message %} -1. Optionally, under **Allow merge commits**, use the dropdown to choose the format of the commit message presented to contributors when merging. The default message includes the pull request number and title. For example, `Merge pull request #123 from patch-1`. You can also choose to use just the pull request title, or the pull request title and description. ![Screenshot of emphasized default commit message dropdown](/assets/images/help/repository/default-commit-message-dropdown.png) +1. Opcionalmente, em **Permitir commits de merge**, use o menu suspenso para escolher o formato da mensagem de commit apresentada aos contribuidores quando realizar o merge. A mensagem padrão inclui o número e título do pull request. Por exemplo, `Merge pull request #123 from patch-1`. Você também pode escolher usar apenas o título do pull request ou o título e a descrição do pull request. ![Captura de tela do menu suspenso da mensagem do commit de combinação por squash padrão](/assets/images/help/repository/default-commit-message-dropdown.png) {% endif %} Se você selecionar mais de um método de merge, os colaboradores poderão escolher qual o tipo de commit de merge usar ao fazer o merge de um pull request. {% data reusables.repositories.squash-and-rebase-linear-commit-history %} diff --git a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests.md b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests.md index 33d1ef03b16b..d093ff8b4812 100644 --- a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests.md +++ b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-rebasing-for-pull-requests.md @@ -21,7 +21,7 @@ shortTitle: Configurar rebase de commit {% data reusables.repositories.sidebar-settings %} 3. Em {% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-6069 %}"Pull Requests"{% else %}"Botão de merge"{% endif %}, selecione **Permitir merge de rebase**. Isso permite que os contribuidores façam merge de uma pull request fazendo rebase dos respectivos commits individuais no branch base. {% ifversion default-merge-squash-commit-message %} - ![Screenshot of Pull Request settings with allow rebase merging checkbox emphasized](/assets/images/help/repository/allow-rebase-merging.png){% endif %}{% ifversion ghes = 3.6 %} ![Screenshot of Pull Request settings with allow rebase merging checkbox emphasized](/assets/images/help/repository/allow-rebase-merging-no-dropdown.png){% endif %} + ![Captura de tela das configurações de pull request com a caixa de seleção permitir merge de rebase destacada](/assets/images/help/repository/allow-rebase-merging.png){% endif %}{% ifversion ghes = 3.6 %} ![Screenshot of Pull Request settings with allow rebase merging checkbox emphasized](/assets/images/help/repository/allow-rebase-merging-no-dropdown.png){% endif %} {% ifversion ghes < 3.6 %} ![Commits com rebase da pull request](/assets/images/help/repository/pr-merge-rebase.png){% endif %} diff --git a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md index 56dbb274427c..c6165a65ee84 100644 --- a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md +++ b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md @@ -21,11 +21,11 @@ shortTitle: Configurar combinação por squash de commit {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -1. Em {% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-6069 %}"Pull Requests"{% else %}"Botão de merge"{% endif %}, selecione **Permitir merge de combinação por squash**. Isso permite que os contribuidores façam merge de uma pull request combinando por squash todos os commits em um único commit. The default commit message presented to contributors when merging is the commit title and message if the pull request contains only 1 commit, or the pull request title and list of commits if the pull request contains 2 or more commits. {% ifversion ghes = 3.6 %} To always use the title of the pull request regardless of the number of commits in the pull request select **Default to PR title for squash merge commits**.{% endif %}{% ifversion default-merge-squash-commit-message %} ![Pull request squashed commits](/assets/images/help/repository/allow-squash-merging.png){% endif %}{% ifversion ghes = 3.6 %} ![Screenshot of Pull Request settings with allow merge commits checkbox emphasized](/assets/images/help/repository/allow-squash-merging-no-dropdown.png){% endif %} +1. Em {% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-6069 %}"Pull Requests"{% else %}"Botão de merge"{% endif %}, selecione **Permitir merge de combinação por squash**. Isso permite que os contribuidores façam merge de uma pull request combinando por squash todos os commits em um único commit. A mensagem de commit padrão apresentada aos contribuidores ao fazer o merge é o título e a mensagem do commit se o pull request contiver apenas 1 commit, ou o título do pull request e lista de commits se o pull request contiver 2 ou mais commits. {% ifversion ghes = 3.6 %} Para usar sempre o título do pull request, independentemente do número de commits no pull request, selecione **Título padrão do PR para commits de merge de combinação por squash**.{% endif %}{% ifversion default-merge-squash-commit-message %} ![Pull request squashed commits](/assets/images/help/repository/allow-squash-merging.png){% endif %}{% ifversion ghes = 3.6 %} ![Screenshot of Pull Request settings with allow merge commits checkbox emphasized](/assets/images/help/repository/allow-squash-merging-no-dropdown.png){% endif %} {% ifversion ghes < 3.6 %} ![Commits de combinação por squash da pull request](/assets/images/enterprise/3.5/repository/pr-merge-squash.png){% endif %} {% ifversion default-merge-squash-commit-message %} -1. Optionally, under **Allow squash merging**, use the dropdown to choose the format of the default squash commit message presented to contributors when merging. The default message uses the commit title and message if the pull request contains only 1 commit, or the pull request title and list of commits if the pull request contains 2 or more commits. You can also choose to use just the pull request title, the pull request title and commit details, or the pull request title and description. ![Screenshot of emphasized default squash message dropdown](/assets/images/help/repository/default-squash-message-dropdown.png) +1. Opcionalmente, em **Permitir o merge de combinação por squash**, use o menu suspenso para escolher o formato da mensagem do commit da combinação por squash padrão apresentada para os contribuidores ao realizar o merge. A mensagem padrão usa o título e a mensagem de commit se o pull request contiver apenas 1 commit, ou o título do pull request e lista de commits se o pull request contiver 2 ou mais commits. Você também pode opter por usar apenas o título do pull request, o título e os detalhes de commit do pull request ou o título e descrição do pull request. ![Captura de tela do menu suspenso da mensagem de combinação por squash padrão](/assets/images/help/repository/default-squash-message-dropdown.png) {% endif %} Se você selecionar mais de um método de merge, os colaboradores poderão escolher qual o tipo de commit de merge usar ao fazer o merge de um pull request. {% data reusables.repositories.squash-and-rebase-linear-commit-history %} diff --git a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md index a13a9d797476..b9e4cbafbbd3 100644 --- a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md +++ b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue.md @@ -19,7 +19,7 @@ redirect_from: {% data reusables.pull_requests.merge-queue-overview %} -A fila de merge cria branches temporários com um prefixo especial para validar as alterações do pull request. The changes in the pull request are then grouped into a `merge_group` with the latest version of the `base_branch` as well as changes ahead of it in the queue. {% data variables.product.product_name %} fará merge de todas essas alterações em `base_branch` uma vez que as verificações exigidas pelas proteções do branch de `base_branch` sejam aprovadas. +A fila de merge cria branches temporários com um prefixo especial para validar as alterações do pull request. Em seguida, as alterações no pull request são agrupadas em um `merge_group` com a última versão do `base_branch` e também com as alterações antes dele na fila. {% data variables.product.product_name %} fará merge de todas essas alterações em `base_branch` uma vez que as verificações exigidas pelas proteções do branch de `base_branch` sejam aprovadas. Para obter informações sobre métodos de merge, consulte "[Sobre merges de pull requests](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)". @@ -34,11 +34,11 @@ Para obter informações sobre métodos de merge, consulte "[Sobre merges de pul {% data reusables.pull_requests.merge-queue-reject %} -### Triggering merge group checks with {% data variables.product.prodname_actions %} +### Acionando verificações de grupo de merge com {% data variables.product.prodname_actions %} -You can use the `merge_group` event to trigger your {% data variables.product.prodname_actions %} workflow when a pull request is added to a merge queue. Note that this is a different event from the `pull_request` and `push` events. +Você pode usar o evento `merge_group` para acionar o fluxo de trabalho {% data variables.product.prodname_actions %} quando um pull request é adicionado à fila de merge. Observe que este é um evento diferente dos eventos `pull_request` e `push`. -A workflow that reports a check which is required by the target branch's protections would look like this: +Um fluxo de trabalho que informa uma verificação necessária pelas proteções do branch de destino ficaria assim: ```yaml on: @@ -46,11 +46,11 @@ on: merge_group: ``` -For more information see "[Events that trigger workflows](/actions/using-workflows/events-that-trigger-workflows#merge-group)" +Para obter mais informações, consulte "[Eventos que acionam fluxos de trabalho](/actions/using-workflows/events-that-trigger-workflows#merge-group)" -### Triggering merge group checks with other CI providers +### Acionando verificações de grupo de merge com outros provedores de CI -With other CI providers, you may need to update your CI configuration to run when a branch that begins with the special prefix `gh-readonly-queue/{base_branch}` is created. +Com outros provedores de CI, é possível que você precise atualizar sua configuração de CI para ser executada quando uma branch que começa quando o prefixo especial `gh-readonly /{base_branch}` é criado. ## Gerenciando uma fila de merge diff --git a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md index a25cd9d89d28..5107588067ef 100644 --- a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md +++ b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches.md @@ -33,9 +33,9 @@ topics: Por padrão, cada regra de proteção de branch desabilita push forçado para os branches correspondentes e impede que os branches correspondentes sejam excluídos. Você pode, opcionalmente, desabilitar essas restrições e habilitar configurações adicionais de proteção de branches. {% ifversion bypass-branch-protections %} -By default, the restrictions of a branch protection rule don't apply to people with admin permissions to the repository or custom roles with the "bypass branch protections" permission. You can optionally apply the restrictions to administrators and roles with the "bypass branch protections" permission, too. For more information, see "[Managing custom repository roles for an organization](/en/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". +Por padrão, as restrições de uma regra de proteção de branch não se aplicam a pessoas com permissões de administrador para o repositório ou funções personalizadas com a permissão de "ignorar proteção de branch". Opcionalmente, você pode aplicar as restrições para administradores e funções com a permissão "ignorar proteção de branch". Para obter mais informações, consulte "[Gerenciando funções de repositórios personalizados para uma organização](/en/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". {% else %} -Por padrão, as restrições de uma regra de proteção de branch não se aplicam a pessoas com permissões de administrador para o repositório. You can optionally choose to include administrators, too.{% endif %} +Por padrão, as restrições de uma regra de proteção de branch não se aplicam a pessoas com permissões de administrador para o repositório. Opcionalmente, você também pode escolher incluir administradores.{% endif %} {% data reusables.repositories.branch-rules-example %} Para obter mais informações sobre os padrões de nomes do branch, consulte "[Gerenciar uma regra de proteção de branch](/github/administering-a-repository/managing-a-branch-protection-rule)". @@ -55,7 +55,7 @@ Para cada regra de proteção do branch, você pode escolher habilitar ou desabi {%- ifversion required-deployments %} - [Exige implantações para ter sucesso antes do merge](#require-deployments-to-succeed-before-merging) {%- endif %} -{% ifversion bypass-branch-protections %}- [Do not allow bypassing the above settings](#do-not-allow-bypassing-the-above-settings){% else %}- [Include administrators](#include-administrators){% endif %} +{% ifversion bypass-branch-protections %}- [Não permita que as configurações acima sejam ignoradas](#do-not-allow-bypassing-the-above-settings){% else %}- [Incluir administradores](#include-administrators){% endif %} - [Restringir quem pode fazer push para branches correspondentes](#restrict-who-can-push-to-matching-branches) - [Permitir push forçado](#allow-force-pushes) - [Permitir exclusões](#allow-deletions) @@ -152,15 +152,15 @@ Antes de exigir um histórico de commit linear, seu repositório deve permitir m Você pode exigir que as alterações sejam implantadas em ambientes específicos antes de ua branch poder ser mesclado. Por exemplo, você pode usar essa regra para garantir que as alterações sejam implantadas com sucesso em um ambiente de teste antes das alterações sofrerem merge no seu branch padrão. -{% ifversion bypass-branch-protections %}### Do not allow bypassing the above settings{% else %} -### Include administrators{% endif %} +{% ifversion bypass-branch-protections %}### Não permita que sejam ignoradas as configurações acima{% else %} +### Incluir administradores{% endif %} {% ifversion bypass-branch-protections %} -By default, the restrictions of a branch protection rule do not apply to people with admin permissions to the repository or custom roles with the "bypass branch protections" permission in a repository. +Por padrão, as restrições de uma regra de proteção de branch não se aplicam a pessoas com permissões de administrador para o repositório ou funções personalizadas com a permissão de "ignorar proteção de branch" em um repositório. -You can enable this setting to apply the restrictions to admins and roles with the "bypass branch protections" permission, too. For more information, see "[Managing custom repository roles for an organization](/en/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". +Você pode habilitar esta configuração para aplicar as restrições aos administradores e funções com a permissão "ignorar proteção de branch". Para obter mais informações, consulte "[Gerenciando funções de repositórios personalizados para uma organização](/en/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)". {% else %} -Por padrão, as regras de branch protegidos não se aplicam a pessoas com permissões de administrador em um repositório. You can enable this setting to include administrators in your protected branch rules.{% endif %} +Por padrão, as regras de branch protegidos não se aplicam a pessoas com permissões de administrador em um repositório. Você pode habilitar essa configuração para incluir administradores em suas regras de proteção de branch.{% endif %} ### Restringir quem pode fazer push para branches correspondentes diff --git a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md index 8c536793dd0c..f040be4182ed 100644 --- a/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md +++ b/translations/pt-BR/content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule.md @@ -77,14 +77,14 @@ Ao criar uma regra de branch, o branch que você especificar ainda não existe n 1. Opcionalmente, para fazer merge de pull requests usando uma fila de merge, selecione **Exigir fila de merge**. {% data reusables.pull_requests.merge-queue-references %} ![Opção de exigir fila de merge](/assets/images/help/repository/require-merge-queue.png) {% tip %} - **Dica:** O recurso de merge da fila de pull request está atualmente em versão beta pública limitada e sujeito a alterações. Organizations owners can request early access to the beta by joining the [waitlist](https://github.com/features/merge-queue/signup). + **Dica:** O recurso de merge da fila de pull request está atualmente em versão beta pública limitada e sujeito a alterações. As organizações às quais os proprietários podem solicitar acesso antecipado ao beta entrando na [lista de espera](https://github.com/features/merge-queue/signup). {% endtip %} {%- endif %} {%- ifversion required-deployments %} 1. Opcionalmente, para escolher em quais ambientes as alterações devem ser implantadas com sucesso antes de fazer merge, selecione **Exigir implantações para ser bem-sucedidas antes do merge** e, em seguida, selecione os ambientes. ![Exigir uma opção de implantação bem-sucedida](/assets/images/help/repository/require-successful-deployment.png) {%- endif %} -1. Optionally, select {% ifversion bypass-branch-protections %}**Do not allow bypassing the above settings**. ![Do not allow bypassing the above settings checkbox](/assets/images/help/repository/do-not-allow-bypassing-the-above-settings.png){% else %}**Apply the rules above to administrators**. ![Apply the rules above to administrators checkbox](/assets/images/help/repository/include-admins-protected-branches.png){% endif %} +1. Opcionalmente, selecione {% ifversion bypass-branch-protections %}**Não permita que sejam ignoradas as configurações acima**. ![Do not allow bypassing the above settings checkbox](/assets/images/help/repository/do-not-allow-bypassing-the-above-settings.png){% else %}**Aplicar as regras acima aos administradores**. ![Apply the rules above to administrators checkbox](/assets/images/help/repository/include-admins-protected-branches.png){% endif %} 1. Opcionalmente, {% ifversion fpt or ghec %} se o repositório pertencer a uma organização que usa {% data variables.product.prodname_team %} ou {% data variables.product.prodname_ghe_cloud %},{% endif %} habilitar as restrições de branches. - Selecione **Restringir quem pode fazer push para os branches correspondentes**. ![Branch restriction checkbox](/assets/images/help/repository/restrict-branch.png){% ifversion restrict-pushes-create-branch %} - Opcionalmente, para também restringir a criação de branches correspondentes, selecione **Restringir pushes que criam branches correspondentes**. ![Branch creation restriction checkbox](/assets/images/help/repository/restrict-branch-create.png){% endif %} diff --git a/translations/pt-BR/content/repositories/creating-and-managing-repositories/about-repositories.md b/translations/pt-BR/content/repositories/creating-and-managing-repositories/about-repositories.md index 7d4b78c2050a..bcbf580bb519 100644 --- a/translations/pt-BR/content/repositories/creating-and-managing-repositories/about-repositories.md +++ b/translations/pt-BR/content/repositories/creating-and-managing-repositories/about-repositories.md @@ -90,12 +90,12 @@ Todos os integrantes da empresa têm permissões de leitura no repositório inte {% data reusables.repositories.internal-repo-default %} -{% ifversion ghec %}Unless your enterprise uses {% data variables.product.prodname_emus %}, members{% else %}Members{% endif %} of the enterprise can fork any internal repository owned by an organization in the enterprise. O repositório bifurcado pertencerá à conta pessoal do integrante e a visibilidade da bifurcação será privada. Se um usuário for removido de todas as organizações pertencentes à empresa, essas bifurcações do usuário dos repositórios internos do usuário serão removidas automaticamente. +{% ifversion ghec %}A menos que sua empresa use {% data variables.product.prodname_emus %}, os integrantes{% else %}Integrantes{% endif %} da empresa poderão bifurcar qualquer repositório interno de propriedade de uma organização na empresa. O repositório bifurcado pertencerá à conta pessoal do integrante e a visibilidade da bifurcação será privada. Se um usuário for removido de todas as organizações pertencentes à empresa, essas bifurcações do usuário dos repositórios internos do usuário serão removidas automaticamente. {% ifversion ghec %} {% note %} -**Note:** {% data variables.product.prodname_managed_users_caps %} cannot fork internal repositories. For more information, see "[About {% data variables.product.prodname_emus %}](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#abilities-and-restrictions-of-managed-user-accounts)." +**Observação:** {% data variables.product.prodname_managed_users_caps %} não pode realizar a bifurcação a partir de repositórios internos. Para obter mais informações, consulte "[Sobre {% data variables.product.prodname_emus %}](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#abilities-and-restrictions-of-managed-user-accounts)." {% endnote %} {% endif %} @@ -109,9 +109,9 @@ A maioria dos limites abaixo afetam o {% data variables.product.product_name %} ### Limites de texto -Os arquivos de texto acima de **512 KB** são sempre exibidos como texto sem formatação. Code is not syntax highlighted, and prose files are not converted to HTML (such as Markdown, AsciiDoc, *etc.*). +Os arquivos de texto acima de **512 KB** são sempre exibidos como texto sem formatação. O código não destaca a sintaxe e arquivos em prosa não são convertidos em HTML (como markdown, AsciiDoc *etc.*). -Text files over **5 MB** are only available through their raw URLs, which are served through `{% data variables.product.raw_github_com %}`; for example, `https://{% data variables.product.raw_github_com %}/octocat/Spoon-Knife/master/index.html`. Click the **Raw** button to get the raw URL for a file. +Arquivos de texto acima de **5 MB** somente estão disponíveis por meio de suas URLs não processadas, que são servidas em `{% data variables.product.raw_github_com %}`; por exemplo, `https://{% data variables.product.raw_github_com %}/octocat/Spoon-Knife/master/index.html`. Clique no botão **Não processado** para obter a URL não processada de um arquivo. ### Limites de diff @@ -126,7 +126,7 @@ Algumas partes de um diff limitado podem ser exibidas, mas qualquer excedente de ### Limites de listas de commits -As páginas de visualização comparada e pull requests exibem uma lista de commits entre as revisões `base` e `head`. These lists are limited to **250** commits. Caso o limite seja excedido, uma observação indicará que commits adicionais estão presentes (mas não são mostrados). +As páginas de visualização comparada e pull requests exibem uma lista de commits entre as revisões `base` e `head`. Essas listas são limitadas a **250** commits. Caso o limite seja excedido, uma observação indicará que commits adicionais estão presentes (mas não são mostrados). ## Leia mais diff --git a/translations/pt-BR/content/repositories/creating-and-managing-repositories/transferring-a-repository.md b/translations/pt-BR/content/repositories/creating-and-managing-repositories/transferring-a-repository.md index 409378317499..140953a96659 100644 --- a/translations/pt-BR/content/repositories/creating-and-managing-repositories/transferring-a-repository.md +++ b/translations/pt-BR/content/repositories/creating-and-managing-repositories/transferring-a-repository.md @@ -31,7 +31,7 @@ Pré-requisitos para transferências no repositório: - Ao transferir um repositório que possui para outra conta pessoal, o novo proprietário receberá um e-mail de confirmação.{% ifversion fpt or ghec %} O e-mail de confirmação inclui instruções para aceitar a transferência. Se o novo proprietário não aceitar a transferência em um dia, o convite vai expirar.{% endif %} - Para transferir um repositório que você possui para uma organização, é preciso ter permissão para criar um repositório na organização de destino. - A conta de destino não deve ter um repositório com o mesmo nome ou uma bifurcação na mesma rede. -- O proprietário original do repositório é adicionado como colaborador no repositório transferido. Other collaborators to the transferred repository remain intact.{% ifversion ghes < 3.7 %} +- O proprietário original do repositório é adicionado como colaborador no repositório transferido. Outros colaboradores no repositório transferido permanecem intactos.{% ifversion ghes < 3.7 %} - Os repositórios internos não podem ser transferidos.{% endif %} - Bifurcações privadas não podem ser transferidas. diff --git a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md index 5d34fb20d2e0..c1bd353596c5 100644 --- a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md +++ b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md @@ -48,7 +48,7 @@ Para reduzir o tamanho do seu arquivo CODEOWNERS, considere o uso de padrões cu ## Sintaxe de CODEOWNERS -Um arquivo CODEOWNERS usa um padrão que segue a maioria das mesmas regras usadas nos arquivos [gitignore](https://git-scm.com/docs/gitignore#_pattern_format), com [algumas exceções](#syntax-exceptions). O padrão é seguido por um ou mais nomes de usuário ou nomes de equipe do {% data variables.product.prodname_dotcom %} usando o formato padrão `@username` ou `@org/team-name`. Users and teams must have explicit `write` access to the repository, even if the team's members already have access. +Um arquivo CODEOWNERS usa um padrão que segue a maioria das mesmas regras usadas nos arquivos [gitignore](https://git-scm.com/docs/gitignore#_pattern_format), com [algumas exceções](#syntax-exceptions). O padrão é seguido por um ou mais nomes de usuário ou nomes de equipe do {% data variables.product.prodname_dotcom %} usando o formato padrão `@username` ou `@org/team-name`. Os usuários e as equipes devem ter acesso explícito de `gravação` para o repositório, mesmo que os integrantes da equipe já tenham acesso. {% ifversion fpt or ghec%}Na maioria dos casos você{% else %}Você{% endif %} também pode se referir a um usuário por um endereço de e-mail que foi adicionado a sua conta em {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, por exemplo, `user@example tom`. {% ifversion fpt or ghec %} Você não pode usar um endereço de e-mail para fazer referência a um {% data variables.product.prodname_managed_user %}. Para obter mais informações sobre {% data variables.product.prodname_managed_users %}, consulte "[Sobre {% data variables.product.prodname_emus %}](/enterprise-cloud@latest/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/about-enterprise-managed-users){% ifversion fpt %}" na documentação de {% data variables.product.prodname_ghe_cloud %}.{% else %}."{% endif %}{% endif %} diff --git a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md index c4678ef37d9d..64aa9bd18cec 100644 --- a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md +++ b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository.md @@ -18,7 +18,7 @@ shortTitle: Exibir um botão de patrocinador Para configurar o botão de patrocinador, edite um arquivo _FUNDING.yml_ na pasta `.github` do repositório, no branch padrão. É possível configurar o botão para incluir desenvolvedores patrocinados no {% data variables.product.prodname_sponsors %}, em plataformas de financiamento externas ou em uma URL de financiamento personalizado. Para obter mais informações a respeito do {% data variables.product.prodname_sponsors %}, consulte "[Sobre o GitHub Sponsors](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)". -Você pode adicionar um nome de usuário, de pacote ou de projeto por plataforma de financiamento externa e até quatro URLs personalizadas. You can add one organization and up to four sponsored developers in {% data variables.product.prodname_sponsors %}. Adicione cada plataforma em uma nova linha, usando a seguinte sintaxe: +Você pode adicionar um nome de usuário, de pacote ou de projeto por plataforma de financiamento externa e até quatro URLs personalizadas. Você pode adicionar uma organização e até quatro desenvolvedores patrocinados em {% data variables.product.prodname_sponsors %}. Adicione cada plataforma em uma nova linha, usando a seguinte sintaxe: | Plataforma | Sintaxe | | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | diff --git a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository.md b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository.md index a333f2fae969..349867a03abd 100644 --- a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository.md +++ b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/disabling-project-boards-in-a-repository.md @@ -1,6 +1,6 @@ --- -title: 'Disabling {% data variables.projects.projects_v1_boards %} in a repository' -intro: 'Repository administrators can turn off {% data variables.projects.projects_v1_boards %} for a repository if you or your team manages work differently.' +title: 'Desabilitando {% data variables.projects.projects_v1_boards %} em um repositório' +intro: 'Os administradores do repositório podem desativar {% data variables.projects.projects_v1_boards %} para um repositório, se você ou sua equipe gerenciarem trabalhos de forma diferente.' redirect_from: - /github/managing-your-work-on-github/managing-project-boards/disabling-project-boards-in-a-repository - /articles/disabling-project-boards-in-a-repository @@ -13,14 +13,14 @@ versions: ghec: '*' topics: - Pull requests -shortTitle: 'Disable {% data variables.projects.projects_v1_boards %}' +shortTitle: 'Desabilite {% data variables.projects.projects_v1_boards %}' allowTitleToDifferFromFilename: true --- -When you disable {% data variables.projects.projects_v1_boards %}, you will no longer see {% data variables.projects.projects_v1_board %} information in timelines or [audit logs](/articles/reviewing-your-security-log/). +Ao desabilitar {% data variables.projects.projects_v1_boards %}, você não verá mais as informações de {% data variables.projects.projects_v1_board %} em linhas do tempo ou em [logs de auditoria](/articles/reviewing-your-security-log/). {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} 3. Em "Features" (Recursos), desmarque a caixa de seleção **Projects** (Projetos). ![Caixa de seleção Remove Projects (Remover projetos)](/assets/images/help/projects/disable-projects-checkbox.png) -After {% data variables.projects.projects_v1_boards %} are disabled, existing {% data variables.projects.projects_v1_boards %} are inaccessible at their previous URLs. {% data reusables.organizations.disable_project_board_results %} +Após {% data variables.projects.projects_v1_boards %} ser desabilitado, {% data variables.projects.projects_v1_boards %} existente poderá ser acessado nas suas URLs anteriores. {% data reusables.organizations.disable_project_board_results %} diff --git a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository.md b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository.md index 078ea1e6b4c8..2ccb44ce8f6d 100644 --- a/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository.md +++ b/translations/pt-BR/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-commit-signoff-policy-for-your-repository.md @@ -1,6 +1,6 @@ --- -title: Managing the commit signoff policy for your repository -intro: 'You can require users to automatically sign off on the commits they make to your repository using {% data variables.product.product_name %}''s web interface.' +title: Gerenciando a política de assinatura do commit para seu repositório +intro: 'Você pode exigir que os usuários assinem automaticamente os commits que criarem no seu repositório usando a interface web do {% data variables.product.product_name %}.' versions: feature: commit-signoffs permissions: Organization owners and repository administrators can require all commits to a repository to be signed off by the commit author. @@ -11,14 +11,14 @@ shortTitle: Gerenciar a política de aprovação de commit ## Sobre as autorizações de commit -Commit signoffs enable users to affirm that a commit complies with the rules and licensing governing a repository. You can enable compulsory commit signoffs on individual repositories for users committing through {% data variables.product.product_location %}'s web interface, making signing off on a commit a seemless part of the commit process. Once compulsory commit signoffs are enabled for a repository, every commit made to that repository through {% data variables.product.product_location %}'s web interface will automatically be signed off on by the commit author. +As assinaturas de commits permitem que os usuários afirmem que um commit cumpre as regras e licenciamento que regem um repositório. Você pode habilitar assinaturas de commit obrigatórias em repositórios individuais para os usuários que fazem commit através da interface web do {% data variables.product.product_location %}, tornando a assinatura de um commit uma parte integrante do processo de commit. Uma vez que as assinaturas obrigatórias de commit estiverem habilitadas para um repositório, cada commit criado para esse repositório por meio da interface web do {% data variables.product.product_location %} será automaticamente assinado pelo autor do commit. -Organization owners can also enable compulsory commit signoffs at the organization level. For more information, see "[Managing the commit signoff policy for your organization](/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization)." +Os proprietários da organização também podem habilitar assinaturas de commit obrigatórias no nível da organização. Para obter mais informações, consulte "[Gerenciando a política de assinatura de commit para a sua organização](/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization)". {% data reusables.repositories.commit-signoffs %} -## Enabling or disabling compulsory commit signoffs for your repository +## Habilitando ou desabilitando as assinaturas obrigatórias de commit para o seu repositório {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -1. Select **Require contributors to sign off on web-based commits**. ![Captura de tela dos contribuidores obrigatórios para assinar commits baseados na web](/assets/images/help/repository/require-signoffs.png) +1. Selecione **Exigir que os contribuidores assinem os commits baseados na web**. ![Captura de tela dos contribuidores obrigatórios para assinar commits baseados na web](/assets/images/help/repository/require-signoffs.png) diff --git a/translations/pt-BR/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md b/translations/pt-BR/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md index e6f77eeb6abf..78c55b1fed01 100644 --- a/translations/pt-BR/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md +++ b/translations/pt-BR/content/repositories/working-with-files/managing-files/adding-a-file-to-a-repository.md @@ -1,6 +1,6 @@ --- title: Adicionar um arquivo a um repositório -intro: 'Você pode fazer o upload e o commit de um arquivo existente para um repositório no {% data variables.product.product_name %} ou usando a linha de comando.' +intro: 'Você pode fazer o upload e o commit de um arquivo existente para um repositório em {% data variables.product.product_name %} ou usando a linha de comando.' redirect_from: - /articles/adding-a-file-to-a-repository - /github/managing-files-in-a-repository/adding-a-file-to-a-repository @@ -22,7 +22,7 @@ shortTitle: Adicionar um arquivo ## Adicionando um arquivo a um repositório em {% data variables.product.product_name %} -Os arquivos que você adiciona a um repositório por meio do navegador são limitados a {% data variables.large_files.max_github_browser_size %} por arquivo. É possível adicionar arquivos maiores, de até {% data variables.large_files.max_github_size %} cada um, usando a linha de comando. Para obter mais informações, consulte "[Adicionar um arquivo a um repositório usando a linha de comando](#adding-a-file-to-a-repository-using-the-command-line)". To add files larger than {% data variables.large_files.max_github_size %}, you must use {% data variables.large_files.product_name_long %}. For more information, see "[About large files on {% data variables.product.product_name %}](/repositories/working-with-files/managing-large-files/about-large-files-on-github)." +Os arquivos que você adiciona a um repositório por meio do navegador são limitados a {% data variables.large_files.max_github_browser_size %} por arquivo. É possível adicionar arquivos maiores, de até {% data variables.large_files.max_github_size %} cada um, usando a linha de comando. Para obter mais informações, consulte "[Adicionar um arquivo a um repositório usando a linha de comando](#adding-a-file-to-a-repository-using-the-command-line)". Para adicionar arquivos maiores que {% data variables.large_files.max_github_size %}, você deve usar {% data variables.large_files.product_name_long %}. Para obter mais informações, consulte "[Sobre arquivos grandes em {% data variables.product.product_name %}](/repositories/working-with-files/managing-large-files/about-large-files-on-github)." {% tip %} diff --git a/translations/pt-BR/content/repositories/working-with-files/using-files/working-with-non-code-files.md b/translations/pt-BR/content/repositories/working-with-files/using-files/working-with-non-code-files.md index 70dc064c89d5..71226163b455 100644 --- a/translations/pt-BR/content/repositories/working-with-files/using-files/working-with-non-code-files.md +++ b/translations/pt-BR/content/repositories/working-with-files/using-files/working-with-non-code-files.md @@ -363,7 +363,7 @@ Ao visualizar o arquivo no repositório, ele é interpretado como um gráfico de Se o seu gráfico não faz nenhuma interpretação, verifique se ele contém uma sintaxe válida do Markdown do Mermaid, verificando sua carta com [editor ativo do Mermaid](https://mermaid.live/edit). -If the chart displays, but does not appear as you'd expect, you can create a new [{% data variables.product.prodname_github_community %} discussion](https://github.com/orgs/community/discussions/categories/general), and add the `Mermaid` label. +Se o gráfico for exibido, mas não aparecer como você esperara, você poderá uma nova [discussão de {% data variables.product.prodname_github_community %} discussão](https://github.com/orgs/community/discussions/categories/general) e adicionar a etiqueta `Mermaid`. #### Problemas conhecidos diff --git a/translations/pt-BR/content/rest/actions/cache.md b/translations/pt-BR/content/rest/actions/cache.md index 2c0dcb2956cc..67035b74c37c 100644 --- a/translations/pt-BR/content/rest/actions/cache.md +++ b/translations/pt-BR/content/rest/actions/cache.md @@ -13,4 +13,4 @@ versions: ## About a API do cache -A API do cache do {% data variables.product.prodname_actions %} permite que você consulte e gerencie o cache {% data variables.product.prodname_actions %} para repositórios. {% ifversion actions-cache-management %}You can also install a {% data variables.product.prodname_cli %} extension to manage your caches from the command line. {% endif %}For more information, see "[Caching dependencies to speed up workflows](/actions/advanced-guides/caching-dependencies-to-speed-up-workflows#managing-caches)." +A API do cache do {% data variables.product.prodname_actions %} permite que você consulte e gerencie o cache {% data variables.product.prodname_actions %} para repositórios. {% ifversion actions-cache-management %}Você também pode instalar uma extensão de {% data variables.product.prodname_cli %} para gerenciar seus caches a partir da linha de comando. {% endif %}Para obter mais informações, consulte "[Dependências de cache para acelerar os fluxos de trabalho](/actions/advanced-guides/caching-dependencies-to-speed-up-workflows#managing-caches)". diff --git a/translations/pt-BR/content/rest/deployments/branch-policies.md b/translations/pt-BR/content/rest/deployments/branch-policies.md index 77279b9fe888..b6cb80a805ac 100644 --- a/translations/pt-BR/content/rest/deployments/branch-policies.md +++ b/translations/pt-BR/content/rest/deployments/branch-policies.md @@ -1,8 +1,8 @@ --- -title: Deployment branch policies +title: Políticas de branch de implantação allowTitleToDifferFromFilename: true -shortTitle: Deployment branch policies -intro: The Deployment branch policies API allows you to manage custom deployment branch policies. +shortTitle: Políticas de branch de implantação +intro: A API de políticas de branch de implantação permite que você gerencie políticas personalizadas de branch de implantação. versions: fpt: '*' ghes: '*' @@ -13,8 +13,8 @@ topics: miniTocMaxHeadingLevel: 3 --- -## About the Deployment branch policies API +## Sobre a API das políticas de branch de implantação -The Deployment branch policies API allows you to specify custom name patterns that branches must match in order to deploy to an environment. The `deployment_branch_policy.custom_branch_policies` property for the environment must be set to `true` to use these endpoints. To update the `deployment_branch_policy` for an environment, see "[Create or update an environment](/rest/deployments/environments#create-or-update-an-environment)." +A API de políticas de branch de implantação permite que você especifique padrões de nome personalizados aos quais os branchs devem corresponder para fazer a implantação em um ambiente. A propriedade `deployment_branch_policy.custom_branch_policy` para o ambiente deve ser definida como `verdadeiro` para usar estas extremidades. Para atualizar o `deployment_branch_policy` para um ambiente, consulte "[Criando ou atualizando um ambiente](/rest/deployments/environments#create-or-update-an-environment)". -For more information about restricting environment deployments to certain branches, see "[Using environments for deployment](/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-branches)." +Para obter mais informações sobre como restringir implantações de ambiente em certos branches, consulte "[Usando ambientes para implantação](/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-branches). ". diff --git a/translations/pt-BR/content/rest/deployments/deployments.md b/translations/pt-BR/content/rest/deployments/deployments.md index 3c258cf34f19..1b3a87d63567 100644 --- a/translations/pt-BR/content/rest/deployments/deployments.md +++ b/translations/pt-BR/content/rest/deployments/deployments.md @@ -19,7 +19,7 @@ Os status de implantação externos permitem marcar implantações com `error`, Os status de implantação também podem incluir uma `descrição` opcional e `log_url`, que são altamente recomendados porque tornam o status de implantação mais útil. O `log_url` é a URL completa para a saída de implantação e a `descrição` é um resumo de alto nível do que aconteceu com a implantação. -O GitHub envia os eventos de `implantação` e `deployment_status` quando novas implantações de status de implantação são criadas. These events allow third-party integrations to receive and respond to deployment requests, and update the status of a deployment as progress is made. +O GitHub envia os eventos de `implantação` e `deployment_status` quando novas implantações de status de implantação são criadas. Esses eventos permitem que as integrações de terceiros recebam e respondam às solicitações de implantação e atualizem o status de implantação conforme o progresso é feito. Abaixo está um diagrama de sequência sobre para como essas interações funcionariam. diff --git a/translations/pt-BR/content/rest/guides/getting-started-with-the-checks-api.md b/translations/pt-BR/content/rest/guides/getting-started-with-the-checks-api.md index 93eba6bfd787..7aedf512944b 100644 --- a/translations/pt-BR/content/rest/guides/getting-started-with-the-checks-api.md +++ b/translations/pt-BR/content/rest/guides/getting-started-with-the-checks-api.md @@ -41,7 +41,7 @@ Uma execução de verificação é um teste individual que faz parte de um conju ![Fluxo de trabalho das execuções de verificação](/assets/images/check_runs.png) -Se uma execução de verificação estiver em um estado incompleto por mais de 14 dias, a execução de verificação `conclusão` irá tornar-se `obsoleta` e será exibida em {% data variables.product.prodname_dotcom %} como obsoleto com {% octicon "issue-reopened" aria-label="The issue-reopened icon" %}. Somente {% data variables.product.prodname_dotcom %} pode marcar a execuções de verificação como `obsoleto`. Para obter mais informações sobre possíveis conclusões de uma execução de verificação, consulte o parâmetro [`conclusão`](/rest/reference/checks#create-a-check-run--parameters). +If a check run is in an incomplete state for more than 14 days, then the check run's `conclusion` becomes `stale` and appears on {% data variables.product.prodname_dotcom %} as stale with {% octicon "issue-reopened" aria-label="The issue-reopened icon" %}. Somente {% data variables.product.prodname_dotcom %} pode marcar a execuções de verificação como `obsoleto`. Para obter mais informações sobre possíveis conclusões de uma execução de verificação, consulte o parâmetro [`conclusão`](/rest/reference/checks#create-a-check-run--parameters). Assim que você receber o webhook de [`check_suite`](/webhooks/event-payloads/#check_suite), você poderá criar a execução de verificação, mesmo que a verificação não esteja completa. Você pode atualizar o `status` da execução de verificação, pois ele é completado com os valores de `queued`, `in_progress` ou `completed`, e você poderá atualizar a saída de `` conforme mais informações forem disponibilizadas. Uma verificação de execução pode conter registros de hora, um link para obter mais informações sobre o seu site externo, anotações detalhadas para linhas específicas de código, e informações sobre a análise realizada. diff --git a/translations/pt-BR/content/rest/guides/getting-started-with-the-rest-api.md b/translations/pt-BR/content/rest/guides/getting-started-with-the-rest-api.md index fdc40ed59d55..ac338ba59fd3 100644 --- a/translations/pt-BR/content/rest/guides/getting-started-with-the-rest-api.md +++ b/translations/pt-BR/content/rest/guides/getting-started-with-the-rest-api.md @@ -1,6 +1,6 @@ --- title: Primeiros passos com a API REST -intro: 'Learn how to use the {% data variables.product.prodname_dotcom %} REST API.' +intro: 'Aprenda a usar a API REST de {% data variables.product.prodname_dotcom %}.' versions: fpt: '*' ghes: '*' @@ -8,33 +8,33 @@ versions: ghec: '*' topics: - API -shortTitle: Using the API +shortTitle: Usando a API miniTocMaxHeadingLevel: 3 --- -## About the {% data variables.product.prodname_dotcom %} REST API +## Sobre a API REST de {% data variables.product.prodname_dotcom %} -This article describes how to use the {% data variables.product.prodname_dotcom %} REST API using {% data variables.product.prodname_cli %}, JavaScript, or cURL. For a quickstart guide, see "[Quickstart for GitHub REST API](/rest/quickstart)." +Esse artigo descreve como usar a API REST de {% data variables.product.prodname_dotcom %}, usando {% data variables.product.prodname_cli %}, JavaScript ou cURL. Para um guia de início rápido, consulte " Quickstart[Início rápido para a API REST do GitHub](/rest/quickstart)." -When you make a request to the REST API, you will specify an HTTP method and a path. Additionally, you might also specify request headers and path, query, or body parameters. The API will return the response status code, response headers, and potentially a response body. +Ao fazer uma solicitação para a API REST, você especifica um método HTTP e um caminho. Além disso, você também pode especificar cabeçalhos de solicitação e caminho, consulta ou parâmetros de texto. A API retornará o código de status de resposta, cabeçalhos de resposta e, potencialmente, um texto de resposta. -The REST API reference documentation describes the HTTP method, path, and parameters for every operation. It also displays example requests and responses for each operation. For more information, see the [REST reference documentation](/rest). +A documentação de referência da API REST descreve o método HTTP, o caminho e os parâmetros para cada operação. Els também exibe exemplos de solicitações e respostas para cada operação. Para obter mais informações, consulte a [Documentação de referência de REST](/rest). -## Making a request +## Fazendo uma solicitação -To make a request, first find the HTTP method and the path for the operation that you want to use. For example, the "Get Octocat" operation uses the `GET` method and the `/octocat` path. For the full reference documentation for this operation, see "[Get Octocat](/rest/meta#get-octocat)." +Para fazer uma solicitação, primeiro encontre o método HTTP e o caminho para a operação que você deseja usar. Por exemplo, a operação "Obter Octocat" usa o método `GET` e o caminho `/octocat`. Para a documentação completa de referência para esta operação, consulte "[Obter Octocat](/rest/meta#get-octocat)". {% cli %} {% note %} -**Note**: You must install {% data variables.product.prodname_cli %} in order to use the commands in the {% data variables.product.prodname_cli %} examples. For installation instructions, see the [{% data variables.product.prodname_cli %} repository](https://github.com/cli/cli#installation). +**Observação**: Você deve instalar {% data variables.product.prodname_cli %} para usar os comandos nos exemplos de {% data variables.product.prodname_cli %}. For installation instructions, see the [{% data variables.product.prodname_cli %} repository](https://github.com/cli/cli#installation). {% endnote %} -If you are not already authenticated to {% data variables.product.prodname_cli %}, you must use the `gh auth login` subcommand to authenticate before making any requests. For more information, see "[Authenticating](#authenticating)." +Se você ainda não está efetuando a autenticação em {% data variables.product.prodname_cli %}, você deve usar o subcomando de autenticação `gh login` para efetuar a autenticação antes de fazer qualquer solicitação. Para obter mais informações, consulte "[Efetuando a autenticação](#authenticating)". -To make a request using {% data variables.product.prodname_cli %}, use the `api` subcommand along with the path. Use the `--method` or `-X` flag to specify the method. +Para fazer uma solicitação usando {% data variables.product.prodname_cli %}, use o subcomando `api` junto com o caminho. Use o sinalizador `--method` ou `-X` para especificar o método. ```shell gh api /octocat --method GET @@ -46,13 +46,13 @@ gh api /octocat --method GET {% note %} -**Note**: You must install and import `octokit` in order to use the Octokit.js library used in the JavaScript examples. For more information, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). +**Observação**: Você deve instalar e importar o `octokit` para usar a biblioteca Octokit.js usada nos exemplos de JavaScript. For more information, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). {% endnote %} -To make a request using JavaScript, you can use Octokit.js. For more information, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). +Para fazer uma solicitação usando o JavaScript, você pode usar o Octokit.js. For more information, see [the Octokit.js README](https://github.com/octokit/octokit.js/#readme). -First, create an instance of `Octokit`.{% ifversion ghes or ghae %} Set the base URL to `{% data variables.product.api_url_code %}`. Replace `[hostname]` with the name of {% data variables.product.product_location %}.{% endif %} +Primeiro, crie uma instância de `Octokit`.{% ifversion ghes or ghae %} Defina a URL de base como `{% data variables.product.api_url_code %}`. Substitua `[hostname]` pelo nome de {% data variables.product.product_location %}.{% endif %} ```javascript const octokit = new Octokit({ {% ifversion ghes or ghae %} @@ -60,7 +60,7 @@ const octokit = new Octokit({ {% ifversion ghes or ghae %} {% endif %}}); ``` -Then, use the `request` method to make requests. Pass the HTTP method and path as the first argument. +Em seguida, use o método `solicitação` para fazer solicitações. Passe o método HTTP e o caminho como o primeiro argumento. ```javascript await octokit.request("GET /octocat", {}); @@ -72,7 +72,7 @@ await octokit.request("GET /octocat", {}); Prepend the base URL for the {% data variables.product.prodname_dotcom %} REST API, `{% data variables.product.api_url_code %}`, to the path to get the full URL: `{% data variables.product.api_url_code %}/octocat`.{% ifversion ghes or ghae %} Replace `[hostname]` with the name of {% data variables.product.product_location %}.{% endif %} -Use the `curl` command in your command line. Use the `--request` or `-X` flag followed by the HTTP method. Use the `--url` flag followed by the full URL. +Use o comando `curl` na sua linha de comando. Use o sinalizador `--request` ou `-X` seguido do método HTTP. Use o sinalizador `--url` seguido da URL completa. ```shell curl --request GET \ @@ -81,39 +81,39 @@ curl --request GET \ {% note %} -**Note**: If you get a message similar to "command not found: curl", you may need to download and install cURL. For more information, see [the cURL project download page](https://curl.se/download.html). +**Observação**: Se você receber uma mensagem semelhante a command not found: curl", talvez você tenha de fazer o download e instalar o cURL. For more information, see [the cURL project download page](https://curl.se/download.html). {% endnote %} {% endcurl %} -Continue reading to learn how to authenticate, send parameters, and use the response. +Continue lendo para aprender como efetuar a autenticação, enviar parâmetros e usar a resposta. -## Authenticating +## Autenticando -Many operations require authentication or return additional information if you are authenticated. Additionally, you can make more requests per hour when you are authenticated.{% cli %} Although some REST API operations are accessible without authentication, you must authenticate to {% data variables.product.prodname_cli %} in order to use the `api` subcommand.{% endcli %} +Muitas operações exigem autenticação ou devolução de informações adicionais se você estiver autenticado. Além disso, você pode fazer mais solicitações quando estiver autenticado.{% cli %} Embora algumas operações da API REST possam ser acessadas sem autenticação, você deve efetuar a autenticação em {% data variables.product.prodname_cli %} para usar o subcomando `api` .{% endcli %} ### Sobre tokens -You can authenticate your request by adding a token. +Você pode autenticar a sua solicitação adicionando um token. -If you want to use the {% data variables.product.company_short %} REST API for personal use, you can create a personal access token (PAT). The REST API operations used in this article require `repo` scope for personal access tokens. Other operations may require different scopes. Para obter mais informações sobre a criação de um token de acesso pessoal, consulte[Criando um token de acesso pessoal](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." +Se você deseja usar a API REST de {% data variables.product.company_short %} para uso pessoal, você pode criar um token de acesso pessoal (PAT). As operações da API REST usadas neste artigo exigem um escopo `repo` para tokens de acesso pessoal. Outras operações podem exigir diferentes escopos. Para obter mais informações sobre a criação de um token de acesso pessoal, consulte[Criando um token de acesso pessoal](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." -If you want to use the API on behalf of an organization or another user, {% data variables.product.company_short %} recommends that you use a {% data variables.product.prodname_github_app %}. If an operation is available to {% data variables.product.prodname_github_apps %}, the REST reference documentation for that operation will say "Works with GitHub Apps." The REST API operations used in this article require `issues` read and write permissions for {% data variables.product.prodname_github_apps %}. Other operations may require different permissions. For more information, see "[Creating a GitHub App](/developers/apps/building-github-apps/creating-a-github-app)", "[Authenticating with GitHub Apps](/developers/apps/building-github-apps/authenticating-with-github-apps), and "[Identifying and authorizing users for GitHub Apps](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps)." +Se você quiser usar a API em nome de uma organização ou outro usuário, {% data variables.product.company_short %} recomenda que você use um {% data variables.product.prodname_github_app %}. Se uma operação estiver disponível para {% data variables.product.prodname_github_apps %}, a documentação de referência REST para essa operação dirá "Funciona com aplicativos GitHub". As operações da API REST usadas neste artigo exigem permissões de leitura e gravação de `problemas` para {% data variables.product.prodname_github_apps %}. Outras operações podem exigir diferentes permissões. Para obter mais informações, consulte "[Criando um aplicativo GitHub](/developers/apps/building-github-apps/creating-a-github-app)", "[Efetuando a autenticação com aplicativos GitHub](/developers/apps/building-github-apps/authenticating-with-github-apps) e "[Identificando e autorizando os usuários pelos aplicativos GitHub](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps)". -If you want to use the API in a {% data variables.product.prodname_actions %} workflow, {% data variables.product.company_short %} recommends that you authenticate with the built-in `GITHUB_TOKEN` instead of creating a token. You can grant permissions to the `GITHUB_TOKEN` with the `permissions` key. Para obter mais informações, consulte "[Autenticação automática de tokens](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token)". +Se você quiser usar a API em um fluxo de trabalho de {% data variables.product.prodname_actions %}, {% data variables.product.company_short %} recomenda que você efetue a autenticação com o `GITHUB_TOKEN` ao invés de criar um token. Você pode conceder permissões para o `GITHUB_TOKEN` com a tecla `permissões`. Para obter mais informações, consulte "[Autenticação automática de tokens](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token)". -### Authentication example +### Exemplo de autenticação {% cli %} -With {% data variables.product.prodname_cli %}, you don't need to create an access token in advance. Use the `auth login` subcommand to authenticate to {% data variables.product.prodname_cli %}: +Com {% data variables.product.prodname_cli %}, você não precisa criar um token de acesso antecipadamente. Use o subcomando `auth login` para efetuar a autenticação em {% data variables.product.prodname_cli %}: ```shell gh auth login ``` -You can use the `--scopes` flag to specify what scopes you want. If you want to authenticate with a token that you created, you can use the `--with-token` flag. For more information, see the [{% data variables.product.prodname_cli %} `auth login` documentation](https://cli.github.com/manual/gh_auth_login). +Você pode usar o sinalizador `--escopes` para especificar quais escopos você quer. Se você deseja efetuar a autenticação com um token que você criou, você pode usar o sinalizador `--with-token`. For more information, see the [{% data variables.product.prodname_cli %} `auth login` documentation](https://cli.github.com/manual/gh_auth_login). {% endcli %} @@ -125,13 +125,13 @@ You can use the `--scopes` flag to specify what scopes you want. If you want to To keep your token secure, you can store your token as a secret and run your script through {% data variables.product.prodname_actions %}. Para obter mais informações, consulte "[Segredos criptografados](/actions/security-guides/encrypted-secrets)". -{% ifversion ghec or fpt %}You can also store your token as a {% data variables.product.prodname_codespaces %} secret and run your script in {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} +{% ifversion ghec or fpt %}Você também pode armazenar seu token como um segredo de {% data variables.product.prodname_codespaces %} e executar seu script em {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} If these options are not possible, consider using another service such as [the 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) to store your token securely. {% endwarning %} -To authenticate with the Octokit.js library, you can pass your token when you create an instance of `Octokit`. Replace `YOUR-TOKEN` with your token.{% ifversion ghes or ghae %} Replace `[hostname]` with the name of {% data variables.product.product_location %}.{% endif %} +Para efetuar a autenticação com a biblioteca do Octokit.js, você pode passar seu token ao criar uma instância de `Octokit`. Substitua `YOUR-TOKEN` pelo seu token.{% ifversion ghes or ghae %} Substitua `[hostname]` pelo nome de {% data variables.product.product_location %}.{% endif %} ```javascript const octokit = new Octokit({ {% ifversion ghes or ghae %} @@ -148,15 +148,15 @@ const octokit = new Octokit({ {% ifversion ghes or ghae %} **Warning**: Treat your access token like a password. -To help keep your account secure, you can use {% data variables.product.prodname_cli %} instead of cURL. {% data variables.product.prodname_cli %} will take care of authentication for you. For more information, see the {% data variables.product.prodname_cli %} version of this page. +Para ajudar a manter sua conta segura, você pode usar {% data variables.product.prodname_cli %} ao invés de cURL. {% data variables.product.prodname_cli %} will take care of authentication for you. For more information, see the {% data variables.product.prodname_cli %} version of this page. -{% ifversion ghec or fpt %}You can also store your token as a {% data variables.product.prodname_codespaces %} secret and use the command line through {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} +{% ifversion ghec or fpt %}Você também pode armazenar seu token como um segredo de {% data variables.product.prodname_codespaces %} e usar a linha de comando através de {% data variables.product.prodname_codespaces %}. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."{% endif %} If these options are not possible, consider using another service such as [the 1Password CLI](https://developer.1password.com/docs/cli/secret-references/) to store your token securely. {% endwarning %} -With cURL, you will send an `Authorization` header with your token. Replace `YOUR-TOKEN` with your token: +Com cURL, você enviará um cabeçalho `Autorização` com seu token. Substitua `YOUR-TOKEN` pelo seu token: ```shell curl --request GET \ @@ -166,19 +166,19 @@ curl --request GET \ {% note %} -**Note:** In most cases, you can use `Authorization: Bearer` or `Authorization: token`. JSON web tokens (JWTs) will only work with `Authorization: Bearer`. +**Note:** In most cases, you can use `Authorization: Bearer` or `Authorization: token`. Os tokens da web JSON (JWTs) só funcionarão com `Authorization: Bearer`. {% endnote %} {% endcurl %} -### Authentication example for {% data variables.product.prodname_actions %} +### Exemplo de autenticação para {% data variables.product.prodname_actions %} {% cli %} -You can also use the `run` keyword to execute {% data variables.product.prodname_cli %} commands in your {% data variables.product.prodname_actions %} workflows. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." +Você também pode usar a palavra-chave `executar` para executar comandos de {% data variables.product.prodname_cli %} nos seus fluxos de trabalho {% data variables.product.prodname_actions %}. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." -Instead of using the `gh auth login` command, pass your token as an environment variable called `GH_TOKEN`. {% data variables.product.prodname_dotcom %} recommends that you authenticate with the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." Para obter mais informações sobre segredos, consulte "[Segredos criptografados](/actions/security-guides/encrypted-secrets)". +Em vez de usar o comando de autenticação `gh login`, passe seu token como uma variável de ambiente denominada `GH_TOKEN`. {% data variables.product.prodname_dotcom %} recomenda que você efetue a autenticação com o `GITHUB_TOKEN` integrado em vez de criar um token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." Para obter mais informações sobre segredos, consulte "[Segredos criptografados](/actions/security-guides/encrypted-secrets)". ```yaml jobs: @@ -196,9 +196,9 @@ jobs: {% javascript %} -You can also use the `run` keyword to execute your JavaScript scripts in your {% data variables.product.prodname_actions %} workflows. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." +Você também pode usar a palavra-chave `executar` para executar seus scripts do JavaScript nos seus fluxos de trabalho de {% data variables.product.prodname_actions %}. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." -{% data variables.product.prodname_dotcom %} recommends that you authenticate with the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." Para obter mais informações sobre segredos, consulte "[Segredos criptografados](/actions/security-guides/encrypted-secrets)". +{% data variables.product.prodname_dotcom %} recomenda que você efetue a autenticação com o `GITHUB_TOKEN` integrado em vez de criar um token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." Para obter mais informações sobre segredos, consulte "[Segredos criptografados](/actions/security-guides/encrypted-secrets)". The following example workflow: @@ -249,7 +249,7 @@ const octokit = new Octokit({ {% ifversion ghes or ghae %} await octokit.request("GET /octocat", {}); ``` -Instead of storing your script in a separate file and executing the script from your workflow, you can use the `actions/github-script` action to run a script. For more information, see the [actions/github-script README](https://github.com/actions/github-script). +Em vez de armazenar seu script em um arquivo separado e executar o script do seu fluxo de trabalho, você pode usar a ação `actions/github-script` para executar um script. Para obter mais informações, consulte [actions/github-script README](https://github.com/actions/github-script). ```yaml jobs: @@ -268,9 +268,9 @@ jobs: {% curl %} -You can also use the `run` keyword to execute cURL commands in your {% data variables.product.prodname_actions %} workflows. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." +Você também pode usar a palavra-chave `executar` para executar comandos do cURL nos fluxos de trabalho {% data variables.product.prodname_actions %}. For more information, see "[Workflow syntax for GitHub Actions](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)." -{% data variables.product.prodname_dotcom %} recommends that you authenticate with the built-in `GITHUB_TOKEN` instead of creating a token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." Para obter mais informações sobre segredos, consulte "[Segredos criptografados](/actions/security-guides/encrypted-secrets)". +{% data variables.product.prodname_dotcom %} recomenda que você efetue a autenticação com o `GITHUB_TOKEN` integrado em vez de criar um token. If this is not possible, store your token as a secret and replace `GITHUB_TOKEN` in the example below with the name of your secret. For more information about `GITHUB_TOKEN`, see "[Automatic token authentication](/actions/security-guides/automatic-token-authentication)." Para obter mais informações sobre segredos, consulte "[Segredos criptografados](/actions/security-guides/encrypted-secrets)". ```yaml jobs: @@ -288,13 +288,13 @@ jobs: {% endcurl %} -## Using headers +## Usando cabeçalhos -Most operations specify that you should pass an `Accept` header with a value of `application/vnd.github.v3+json`. Other operations may specify that you should send a different `Accept` header or additional headers. +A maioria das operações especifica que você deve passar um cabeçalho `Aceitar` com um valor de `application/vnd.github.v3+json`. Outras operações podem especificar que você deve enviar um cabeçalho `Aceitar` diferente ou cabeçalhos adicionais. {% cli %} -To send a header with {% data variables.product.prodname_cli %}, use the `--header` or `-H` flag followed by the header in `key: value` format. +Para enviar um cabeçalho com {% data variables.product.prodname_cli %}, utilize o sinalizador `--header` ou `-H` seguido pelo formato de cabeçalho em `key: value`. ```shell gh api --header 'Accept: application/vnd.github.v3+json' --method GET /octocat @@ -304,7 +304,7 @@ gh api --header 'Accept: application/vnd.github.v3+json' --method GET /octocat {% javascript %} -The Octokit.js library automatically passes the `Accept: application/vnd.github.v3+json` header. To pass additional headers or a different `Accept` header, add a `headers` property to the object that is passed as a second argument to the `request` method. The value of the `headers` property is an object with the header names as keys and header values as values. For example, to send a `content-type` header with a value of `text/plain`: +A biblioteca do Octokit.js passa automaticamente o cabeçalho <`Accept: application/vnd.github.v3+json`. Para passar cabeçalhos adicionais ou um outro cabeçalho `Aceitar`, adicione uma propriedade de `cabeçalhos` ao objeto que é passado como um segundo argumento ao mpetodo de `solicitação`. O valor da propriedade dos `cabeçalhos` propriedade é um objeto com os nomes de cabeçalho como chaves e valores de cabeçalho como valores. Por exemplo, para enviar um cabeçalho `content-type` com um valor de `text/plain`: ```javascript await octokit.request("GET /octocat", { @@ -318,7 +318,7 @@ await octokit.request("GET /octocat", { {% curl %} -To send a header with cURL, use the `--header` or `-H` flag followed by the header in `key: value` format. +Para enviar um cabeçalho com cURL, use o sinalizador `--header` ou `-H` seguido pelo cabeçalho no formato `key: value`. ```shell curl --request GET \ @@ -329,21 +329,21 @@ curl --request GET \ {% endcurl %} -## Using path parameters +## Usando parâmetros de caminho -Path parameters modify the operation path. For example, the "List repository issues" path is `/repos/{owner}/{repo}/issues`. The curly brackets `{}` denote path parameters that you need to specify. In this case, you must specify the repository owner and name. For the reference documentation for this operation, see "[List repository issues](/rest/issues/issues#list-repository-issues)." +Os parâmetros de caminho modificam o caminho da operação. Por exemplo, o caminho "Listar problemas de repositório" é `/repos/{owner}/{repo}/issues`. As chaves `{}` denotam parâmetros de caminhos que você precisa especificar. Neste caso, você deve especificar o proprietário e o nome do repositório. Para a documentação de referência para esta operação, consulte "[Listar problemas com o repositório](/rest/issues/issues#list-repository-issues)". {% cli %} {% ifversion ghes or ghae %} {% note %} -**Note:** In order for this command to work for {% data variables.product.product_location %}, replace `octocat/Spoon-Knife` with a repository owned by {% data variables.product.product_location %}. Otherwise, rerun the `gh auth login` command to authenticate to {% data variables.product.prodname_dotcom_the_website %} instead of {% data variables.product.product_location %}. +**Observação:** Para que este comando funcione para {% data variables.product.product_location %}, substitua `octocat/Spoon-Knife` por um repositório pertencente ao {% data variables.product.product_location %}. Caso contrário, execute novamente o comando `gh login` para efetuar a autenticação em {% data variables.product.prodname_dotcom_the_website %} em vez de {% data variables.product.product_location %}. {% endnote %} {% endif %} -To get issues from the `octocat/Spoon-Knife` repository, replace `{owner}` with `octocat` and `{repo}` with `Spoon-Knife`. +Para obter problemas do repositório `octocat/Spoon-Knife`, substitua `{owner}` por `octocat` e `{repo}` por `Spoon-Knife`. ```shell gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues @@ -356,12 +356,12 @@ gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/oct {% ifversion ghes or ghae %} {% note %} -**Note:** In order for this example to work for {% data variables.product.product_location %}, replace `octocat/Spoon-Knife` with a repository owned by {% data variables.product.product_location %}. Otherwise, create a new `Octokit` instance and do not specify `baseURL`. +**Observação:** Para que este exemplo funcione para {% data variables.product.product_location %}, substitua `octocat/Spoon-Knife` por um repositório pertencente ao {% data variables.product.product_location %}. Caso contrário, crie uma nova instância `Octokit` e não especifique `baseURL`. {% endnote %} {% endif %} -When you make a request with Octokit.js, all parameters, including path parameters, are passed in an object as the second argument to the `request` method. To get issues from the `octocat/Spoon-Knife` repository, specify `owner` as `octocat` and `repo` as `Spoon-Knife`. +Ao fazer uma solicitação com Octokit.js, todos os parâmetros, incluindo os parâmetros de caminho, são passados em um objeto como o segundo argumento para o método `solicitação`. Para obter problemas do repositório `octocat/Spoon-Knife`, especifique `proprietário` como `octocat` e `repo` como `Spoon-Knife`. ```javascript await octokit.request("GET /repos/{owner}/{repo}/issues", { @@ -374,12 +374,12 @@ await octokit.request("GET /repos/{owner}/{repo}/issues", { {% curl %} -To get issues from the `octocat/Spoon-Knife` repository, replace `{owner}` with `octocat` and `{repo}` with `Spoon-Knife`. To build the full path, prepend the base URL for the {% data variables.product.prodname_dotcom %} REST API, `https://api.github.com`: `https://api.github.com/repos/octocat/Spoon-Knife/issues`. +Para obter problemas do repositório `octocat/Spoon-Knife`, substitua `{owner}` por `octocat` e `{repo}` por `Spoon-Knife`. Para criar o caminho completo, preencha a URL de base para a API REST de {% data variables.product.prodname_dotcom %}, `https://api.github.com`: `https://api.github.com/repos/octocat/Spoon-Knife/issues`. {% ifversion ghes or ghae %} {% note %} -**Note:** If you want to use {% data variables.product.product_location %} instead of {% data variables.product.prodname_dotcom_the_website %}, use `{% data variables.product.api_url_code %}` instead of `https://api.github.com` and replace `[hostname]` with the name of {% data variables.product.product_location %}. Replace `octocat/Spoon-Knife` with a repository owned by {% data variables.product.product_location %}. +**Observação:** Se você quiser usar {% data variables.product.product_location %} em vez de {% data variables.product.prodname_dotcom_the_website %}, use `{% data variables.product.api_url_code %}` em vez de `https://api.github.com` e substitua `[hostname]` pelo nome de {% data variables.product.product_location %}. Substitua `octocat/Spoon-Knife` por um repositório pertencente a {% data variables.product.product_location %}. {% endnote %} {% endif %} @@ -393,21 +393,21 @@ curl --request GET \ {% endcurl %} -The operation returns a list of issues and data about each issue. For more information about using the response, see the "[Using the response](#using-the-response)" section. +A operação retorna uma lista de problemas e dados sobre cada problema. Para obter mais informações sobre como usar a resposta, consulte a seção "[Usando a resposta](#using-the-response). -## Using query parameters +## Usando parâmetros de consulta -Query parameters allow you to control what data is returned for a request. For example, a query parameter may let you specify how many items are returned when the response is paginated. +Os parâmetros de consulta permitem que você controle quais dados são retornados para uma solicitação. Por exemplo, um parâmetro de consulta pode permitir que você especifique quantos itens são retornados quando a resposta é paginada. -By default, the "List repository issues" operation returns thirty issues, sorted in descending order by the date they were created. You can use the `per_page` parameter to return two issues instead of 30. You can use the `sort` parameter to sort the issues by the date they were last updated instead of by the date they were created. You can use the `direction` parameter to sort the results in ascending order instead of descending order. +Por padrão, a operação "Listar problemas do repositório" retorna trinta problemas, ordenados em ordem decrescente pela data em que eles foram criados. Você pode usar o parâmetro `per_page` para retornar dois problemas em vez de 30. Você pode usar o parâmetro `ordenar` para classificar os problemas pela data em que foram atualizados pela última vez de ordenar pela data em que foram criados. Você pode usar o parâmetro `direção` para classificar os resultados em ordem ascendente em vez de descemdente. {% cli %} -For {% data variables.product.prodname_cli %}, use the `-F` flag to pass a parameter that is a number, Boolean, or null. Use `-f` to pass string parameters. +Para {% data variables.product.prodname_cli %}, use o sinalizador `-F` para passar um parâmetro que é um número, booleano ou nulo. Use `-f` para passar parâmetros de string {% note %} -**Note**: {% data variables.product.prodname_cli %} does not currently accept parameters that are arrays. For more information, see [this issue](https://github.com/cli/cli/issues/1484). +**Observação**: {% data variables.product.prodname_cli %} no momento não aceita parâmetros que são matrizes. Para obter mais informações, consulte [este problema](https://github.com/cli/cli/issues/1484). {% endnote %} @@ -419,7 +419,7 @@ gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/oct {% javascript %} -When you make a request with Octokit.js, all parameters, including query parameters, are passed in an object as the second argument to the `request` method. +Ao fazer uma solicitação com Octokit.js, todos os parâmetros, incluindo os parâmetros de consulta, são passados em um objeto como o segundo argumento para o método `solicitação`. ```javascript await octokit.request("GET /repos/{owner}/{repo}/issues", { @@ -435,7 +435,7 @@ await octokit.request("GET /repos/{owner}/{repo}/issues", { {% curl %} -For cURL, add a `?` to the end of the path, then append your query parameter name and value in the form `parameter_name=value`. Separate multiple query parameters with `&`. +Para o cURL, adicione um `?` ao final do caminho e, em seguida, anexe o nome e o valor do parâmetro de consulta na forma `parameter_name=value`. Separe os parâmetros múltiplos de consulta com `&`. ```shell curl --request GET \ @@ -446,21 +446,21 @@ curl --request GET \ {% endcurl %} -The operation returns a list of issues and data about each issue. For more information about using the response, see the "[Using the response](#using-the-response)" section. +A operação retorna uma lista de problemas e dados sobre cada problema. Para obter mais informações sobre como usar a resposta, consulte a seção "[Usando a resposta](#using-the-response). -## Using body parameters +## Usando parâmetros do texto -Body parameters allow you to pass additional data to the API. For example, the "Create an issue" operation requires you to specify a title for the new issue. It also lets you specify other information, such as text to put in the issue body. For the full reference documentation for this operation, see "[Create an issue](/rest/issues/issues#create-an-issue)." +Os parâmetros do texto permitem que você passe dados adicionais para a API. Por exemplo, a operação "Criar um problema" exige que você especifique um título para o novo problema. Ela também permite especificar outras informações, como texto para colocar no texto do problema. Para a documentação completa de referência para esta operação, consulte "[Criar um problema](/rest/issues/issues#create-an-issue)". -The "Create an issue" operation uses the same path as the "List repository issues" operation in the examples above, but it uses a `POST` method instead of a `GET` method. +A operação "Criar um problema" usa o mesmo caminho da operação "Listar problemas de repositório" nos exemplos acima, mas usa um método `POST` em vez de um método `GET`. {% cli %} -For {% data variables.product.prodname_cli %}, use the `-F` flag to pass a parameter that is a number, Boolean, or null. Use `-f` to pass string parameters. +Para {% data variables.product.prodname_cli %}, use o sinalizador `-F` para passar um parâmetro que é um número, booleano ou nulo. Use `-f` para passar parâmetros de string {% note %} -**Note**: {% data variables.product.prodname_cli %} does not currently accept parameters that are arrays. For more information, see [this issue](https://github.com/cli/cli/issues/1484). +**Observação**: {% data variables.product.prodname_cli %} no momento não aceita parâmetros que são matrizes. Para obter mais informações, consulte [este problema](https://github.com/cli/cli/issues/1484). {% endnote %} @@ -472,7 +472,7 @@ gh api --header 'Accept: application/vnd.github.v3+json' --method POST /repos/oc {% javascript %} -When you make a request with Octokit.js, all parameters, including body parameters, are passed in an object as the second argument to the `request` method. +Ao fazer uma solicitação com Octokit.js, todos os parâmetros, incluindo os parâmetros de texto, são passados em um objeto como o segundo argumento para o método `solicitação`. ```javascript await octokit.request("POST /repos/{owner}/{repo}/issues", { @@ -487,7 +487,7 @@ await octokit.request("POST /repos/{owner}/{repo}/issues", { {% curl %} -For cURL, use the `--data` flag to pass the body parameters in a JSON object. +Para o cURL, use o sinalizador `--data` para passar os parâmetros de texto em um objeto do JSON. ```shell curl --request POST \ @@ -502,27 +502,27 @@ curl --request POST \ {% endcurl %} -The operation creates an issue and returns data about the new issue. In the response, find the `html_url` of your issue and navigate to your issue in the browser. For more information about using the response, see the "[Using the response](#using-the-response)" section. +A operação cria um problema e retorna dados sobre o novo problema. Na resposta, encontre o `html_url` do seu problema e acesse o seu problema no navegador. Para obter mais informações sobre como usar a resposta, consulte a seção "[Usando a resposta](#using-the-response). -## Using the response +## Usando a resposta -### About the response code and headers +### Sobre o código de resposta e cabeçalhos -Every request will return an HTTP status code that indicates the success of the response. For more information about response codes, see [the MDN HTTP response status code documentation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status). +Cada solicitação retornará um código de status HTTP que indica o sucesso da resposta. Para obter mais informações sobre códigos de resposta, consulte [a documentação de código de status de resposta de HTTP MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status). -Additionally, the response will include headers that give more details about the response. Headers that start with `X-` or `x-` are custom to {% data variables.product.company_short %}. For example, the `x-ratelimit-remaining` and `x-ratelimit-reset` headers tell you how many requests you can make in a time period. +Além disso, a resposta incluirá cabeçalhos que fornecem mais detalhes sobre a resposta. Os cabeçalhos que começam com `X-` ou `x-` são personalizados para {% data variables.product.company_short %}. Por exemplo, os cabeçalhos `x-ratelimit-remaining` e `x-ratelimit-reset` mostram quantas solicitações você pode fazer em um período de tempo. {% cli %} -To view the status code and headers, use the `--include` or `--i` flag when you send your request. +Para ver o código de status e os cabeçalhos, use o sinalizador `--include` ou `--i` ao enviar sua solicitação. -For example, this request: +Por exemplo, essa solicitação: ```shell gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues -F per_page=2 --include ``` -returns the response code and headers like: +retorna o código de resposta e cabeçalhos como: ```shell HTTP/2.0 200 OK @@ -554,15 +554,15 @@ X-Ratelimit-Used: 4 X-Xss-Protection: 0 ``` -In this example, the response code is `200`, which indicates a successful request. +Neste exemplo, o código de resposta é `200`, o que indica uma solicitação bem-sucedida. {% endcli %} {% javascript %} -When you make a request with Octokit.js, the `request` method returns a promise. If the request was successful, the promise resolves to an object that includes the HTTP status code of the response (`status`) and the response headers (`headers`). If an error occurs, the promise resolves to an object that includes the HTTP status code of the response (`status`) and the response headers (`response.headers`). +Ao fazer uma solicitação com o Octokit.js, o método `solicitação` retorna uma promessa. If the request was successful, the promise resolves to an object that includes the HTTP status code of the response (`status`) and the response headers (`headers`). If an error occurs, the promise resolves to an object that includes the HTTP status code of the response (`status`) and the response headers (`response.headers`). -You can use a `try/catch` block to catch an error if it occurs. For example, if the request in the following script is successful, the script will log the status code and the value of the `x-ratelimit-remaining` header. If the request was not successful, the script will log the status code, the value of the `x-ratelimit-remaining` header, and the error message. +Você pode usar um bloco `try/catch` para capturar um erro, caso ocorra. Por exemplo, se o pedido no script seguinte for bem-sucedido, o script registrará o código de status e o valor do cabeçalho `x-ratelimit-restante`. If the request was not successful, the script will log the status code, the value of the `x-ratelimit-remaining` header, and the error message. ```javascript try { @@ -583,9 +583,9 @@ try { {% curl %} -To view the status code and headers, use the `--include` or `--i` flag when you send your request. +Para ver o código de status e os cabeçalhos, use o sinalizador `--include` ou `--i` ao enviar sua solicitação. -For example, this request: +Por exemplo, essa solicitação: ```shell curl --request GET \ @@ -595,7 +595,7 @@ curl --request GET \ --include ``` -returns the response code and headers like: +retorna o código de resposta e cabeçalhos como: ```shell HTTP/2 200 @@ -625,13 +625,13 @@ content-length: 4936 x-github-request-id: 14E0:4BC6:F1B8BA:208E317:62EC2715 ``` -In this example, the response code is `200`, which indicates a successful request. +Neste exemplo, o código de resposta é `200`, o que indica uma solicitação bem-sucedida. {% endcurl %} -### About the response body +### Sobre o texto de resposta -Many operations will return a response body. Unless otherwise specified, the response body is in JSON format. For example, this request returns a list of issues with data about each issue: +Muitas operações retornarão um texto de resposta. A menos que seja especificado, o texto da resposta está em formato JSON. Por exemplo, esta solicitação retorna uma lista de problemas com dados sobre cada problema: {% cli %} @@ -674,13 +674,13 @@ For example, you can use `>` to redirect the response to a file: gh api --header 'Accept: application/vnd.github.v3+json' --method GET /repos/octocat/Spoon-Knife/issues -F per_page=2 > data.json ``` -Then you can use jq to get the title and author ID of each issue: +Em seguida, você pode usar jq para obter o título e o ID do autor de cada problema: ```shell jq '.[] | {title: .title, authorID: .user.id}' data.json ``` -The previous two commands return something like: +Os dois comandos anteriores retornam algo parecido a: ``` { @@ -693,13 +693,13 @@ The previous two commands return something like: } ``` -For more information about jq, see [the jq documentation](https://stedolan.github.io/jq/) and [jq play](https://jqplay.org/). +Para obter mais informações sobre jq, consulte [a documentação do jq](https://stedolan.github.io/jq/) e [jq play](https://jqplay.org/). {% endcli %} {% javascript %} -For example, you can get the title and author ID of each issue: +Por exemplo, você pode obter o ID do autor e título de cada problema: ```javascript try { @@ -731,13 +731,13 @@ curl --request GET \ --header "Authorization: Bearer YOUR-TOKEN" > data.json ``` -Then you can use jq to get the title and author ID of each issue: +Em seguida, você pode usar jq para obter o título e o ID do autor de cada problema: ```shell jq '.[] | {title: .title, authorID: .user.id}' data.json ``` -The previous two commands return something like: +Os dois comandos anteriores retornam algo parecido a: ``` { @@ -750,12 +750,12 @@ The previous two commands return something like: } ``` -For more information about jq, see [the jq documentation](https://stedolan.github.io/jq/) and [jq play](https://jqplay.org/). +Para obter mais informações sobre jq, consulte [a documentação do jq](https://stedolan.github.io/jq/) e [jq play](https://jqplay.org/). {% endcurl %} ## Próximas etapas -This article demonstrated how to list and create issues in a repository. For more practice, try to comment on an issue, edit the title of an issue, or close an issue. For more information about these operations, see "[Create an issue comment](/rest/issues#create-an-issue-comment)" and "[Update an issue](/rest/issues/issues#update-an-issue)." +Este artigo demonstrou como listar e criar problemas em um repositório. Para mais adquirir prática, tente comentar sobre um problema, editar o título de um problema ou fechar um problema. Para obter mais informações sobre essas operações, consulte "[Criar um comentário de problema](/rest/issues#create-an-issue-comment)" e "[Atualizar um problema](/rest/issues/issues#update-an-issue)". -For more information about the operations that you can use, see the [REST reference documentation](/rest). +Para obter mais informações sobre as operações que você pode usar, consulte a [documentação de referência de REST](/rest). diff --git a/translations/pt-BR/content/rest/orgs/security-managers.md b/translations/pt-BR/content/rest/orgs/security-managers.md index 9385167d7654..09febe3b35fa 100644 --- a/translations/pt-BR/content/rest/orgs/security-managers.md +++ b/translations/pt-BR/content/rest/orgs/security-managers.md @@ -1,10 +1,10 @@ --- -title: Security Managers +title: Gerentes de segurança intro: '' versions: fpt: '*' ghes: '>=3.7' - ghae: 'issue-7691' + ghae: issue-7691 ghec: '*' topics: - API diff --git a/translations/pt-BR/content/rest/projects/cards.md b/translations/pt-BR/content/rest/projects/cards.md index 893d6413c5be..76af8dae46b0 100644 --- a/translations/pt-BR/content/rest/projects/cards.md +++ b/translations/pt-BR/content/rest/projects/cards.md @@ -1,8 +1,8 @@ --- -title: '{% data variables.product.prodname_project_v1_caps %} cards' +title: 'Cartões de {% data variables.product.prodname_project_v1_caps %}' shortTitle: Cartões allowTitleToDifferFromFilename: true -intro: 'The {% data variables.product.prodname_project_v1 %} cards API lets you create and manage cards on a {% data variables.projects.projects_v1_board %}.' +intro: 'A API de cartões de {% data variables.product.prodname_project_v1 %} permite que você crie e gerencie cartões em um {% data variables.projects.projects_v1_board %}.' versions: fpt: '*' ghes: '*' diff --git a/translations/pt-BR/content/rest/projects/collaborators.md b/translations/pt-BR/content/rest/projects/collaborators.md index 1f9ddf287ad6..c8673b69a20b 100644 --- a/translations/pt-BR/content/rest/projects/collaborators.md +++ b/translations/pt-BR/content/rest/projects/collaborators.md @@ -1,8 +1,8 @@ --- -title: '{% data variables.product.prodname_project_v1_caps %} collaborators' +title: 'colaboradores de {% data variables.product.prodname_project_v1_caps %}' shortTitle: Colaboradores allowTitleToDifferFromFilename: true -intro: 'The {% data variables.product.prodname_project_v1 %} collaborators API lets you manage collaborators on a {% data variables.projects.projects_v1_board %}.' +intro: 'A API de colaboradores de {% data variables.product.prodname_project_v1 %} permite que você gerencie os colaboradores em um {% data variables.projects.projects_v1_board %}.' versions: fpt: '*' ghes: '*' diff --git a/translations/pt-BR/content/rest/projects/columns.md b/translations/pt-BR/content/rest/projects/columns.md index fabf2f3daf4a..390e1daaff4f 100644 --- a/translations/pt-BR/content/rest/projects/columns.md +++ b/translations/pt-BR/content/rest/projects/columns.md @@ -1,8 +1,8 @@ --- -title: '{% data variables.product.prodname_project_v1_caps %} columns' +title: 'colunas de {% data variables.product.prodname_project_v1_caps %}' shortTitle: Colunas allowTitleToDifferFromFilename: true -intro: 'The {% data variables.product.prodname_project_v1 %} columns API lets you create and manage columns on a {% data variables.projects.projects_v1_board %}.' +intro: 'A API de colunas {% data variables.product.prodname_project_v1 %} permite que você crie e gerencie as colunas em um {% data variables.projects.projects_v1_board %}.' versions: fpt: '*' ghes: '*' diff --git a/translations/pt-BR/content/rest/projects/index.md b/translations/pt-BR/content/rest/projects/index.md index 7064fbb38436..376f470c15db 100644 --- a/translations/pt-BR/content/rest/projects/index.md +++ b/translations/pt-BR/content/rest/projects/index.md @@ -1,6 +1,6 @@ --- title: '{% data variables.product.prodname_projects_v1_caps %}' -intro: 'The {% data variables.product.prodname_projects_v1 %} API lets you create, list, update, delete and customize {% data variables.projects.projects_v1_boards %}.' +intro: 'A API de {% data variables.product.prodname_projects_v1 %} permite que você crie, liste, atualize, esxclua e personalize {% data variables.projects.projects_v1_boards %}.' redirect_from: - /v3/projects - /rest/reference/projects diff --git a/translations/pt-BR/content/rest/projects/projects.md b/translations/pt-BR/content/rest/projects/projects.md index 64cddc91ad82..e4fa7aa4d4cd 100644 --- a/translations/pt-BR/content/rest/projects/projects.md +++ b/translations/pt-BR/content/rest/projects/projects.md @@ -2,7 +2,7 @@ title: '{% data variables.product.prodname_projects_v1_caps %}' shortTitle: Quadros allowTitleToDifferFromFilename: true -intro: 'The {% data variables.product.prodname_projects_v1 %} API lets you create and manage {% data variables.projects.projects_v1_boards %} in a repository.' +intro: 'A API de {% data variables.product.prodname_projects_v1 %} permite criar e gerenciar {% data variables.projects.projects_v1_boards %} em um repositório.' versions: fpt: '*' ghes: '*' diff --git a/translations/pt-BR/content/rest/quickstart.md b/translations/pt-BR/content/rest/quickstart.md index 7e7344208400..70914d0a04a4 100644 --- a/translations/pt-BR/content/rest/quickstart.md +++ b/translations/pt-BR/content/rest/quickstart.md @@ -1,6 +1,6 @@ --- -title: Quickstart for GitHub REST API -intro: 'Learn how to get started with the {% data variables.product.prodname_dotcom %} REST API.' +title: Início rápido para a API REST do GitHub +intro: 'Saiba como começar com a API REST de {% data variables.product.prodname_dotcom %}.' allowTitleToDifferFromFilename: true versions: fpt: '*' @@ -16,13 +16,13 @@ redirect_from: miniTocMaxHeadingLevel: 3 --- -This article describes how to quickly get started with the {% data variables.product.prodname_dotcom %} REST API using {% data variables.product.prodname_cli %}, JavaScript, or cURL. For a more detailed guide, see "[Getting started with the REST API](/rest/guides/getting-started-with-the-rest-api)." +Esse artigo descreve como começar rapidamente com a API REST de {% data variables.product.prodname_dotcom %} usando {% data variables.product.prodname_cli %}, JavaScript ou cURL. Para um guia mais detalhado, consulte "[Primeiros passos com a API REST](/rest/guides/getting-started-with-the-rest-api)." {% cli %} -## Getting started using {% data variables.product.prodname_cli %} +## Primeiros passos para usar o {% data variables.product.prodname_cli %} -### Using {% data variables.product.prodname_cli %} in the command line +### Usando {% data variables.product.prodname_cli %} na linha de comando {% data variables.product.prodname_cli %} is the easiest way to use the {% data variables.product.prodname_dotcom %} REST API from the command line. @@ -348,4 +348,4 @@ jobs: ## Próximas etapas -For a more detailed guide, see "[Getting started with the REST API](/rest/guides/getting-started-with-the-rest-api)." +Para um guia mais detalhado, consulte "[Primeiros passos com a API REST](/rest/guides/getting-started-with-the-rest-api)." diff --git a/translations/pt-BR/content/rest/teams/external-groups.md b/translations/pt-BR/content/rest/teams/external-groups.md index 03ed92724682..1ada12fe562f 100644 --- a/translations/pt-BR/content/rest/teams/external-groups.md +++ b/translations/pt-BR/content/rest/teams/external-groups.md @@ -19,7 +19,7 @@ Para usar esta API, o usuário autenticado deve ser um mantenedor de equipe ou u **Notas:** -- A API de grupos externos está disponível apenas para organizações que fazem parte de uma empresa que usa {% data variables.product.prodname_emus %}. Para obter mais informações, consulte[Sobre usuários gerenciados pela empresa](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)". +- The external groups API is only available for organizations that are part of an enterprise using {% data variables.product.prodname_emus %}. Para obter mais informações, consulte[Sobre usuários gerenciados pela empresa](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)". - Se sua organização usar a sincronização de equipe, você poderá usar a API de sincronização de equipe. Para obter mais informações, consulte "[API de sincronização de equipe](#team-synchronization)". {% endnote %} diff --git a/translations/pt-BR/content/rest/webhooks/index.md b/translations/pt-BR/content/rest/webhooks/index.md index 12d70969a42f..97fb7ce394dc 100644 --- a/translations/pt-BR/content/rest/webhooks/index.md +++ b/translations/pt-BR/content/rest/webhooks/index.md @@ -70,9 +70,9 @@ Solicitações do PubSubHubbub podem ser enviadas várias vezes. Se o hook já e #### Parâmetros -| Nome | Tipo | Descrição | -| -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `hub.mode` | `string` | **Obrigatório**. `Assine` ou `cancele a assinatura`. | -| `hub.topic` | `string` | **Obrigatório**. A URI do repositório do GitHub a ser assinada. O caminho deve estar no formato `/{owner}/{repo}/events/{event}`. | -| `hub.callback` | `string` | A URI para receber as atualizações do tópico. | -| `hub.secret` | `string` | Uma chave de segredo compartilhado que gera uma assinatura de hash do conteúdo de saída do texto. You can verify a push came from GitHub by comparing the raw request body with the contents of the {% ifversion fpt or ghes or ghec %}`X-Hub-Signature` or `X-Hub-Signature-256` headers{% elsif ghae %}`X-Hub-Signature-256` header{% endif %}. Você pode ver [a documentação do PubSubHubbub](https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html#authednotify) para obter mais informações. | +| Nome | Tipo | Descrição | +| -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `hub.mode` | `string` | **Obrigatório**. `Assine` ou `cancele a assinatura`. | +| `hub.topic` | `string` | **Obrigatório**. A URI do repositório do GitHub a ser assinada. O caminho deve estar no formato `/{owner}/{repo}/events/{event}`. | +| `hub.callback` | `string` | A URI para receber as atualizações do tópico. | +| `hub.secret` | `string` | Uma chave de segredo compartilhado que gera uma assinatura de hash do conteúdo de saída do texto. Você pode verificar se um push veio do GitHub comparando o texto da solicitação não processada com o conteúdo dos cabeçalhos {% ifversion fpt or ghes or ghec %}`X-Hub-Signature` ou `X-Hub-Signature-256` {% elsif ghae %}`X-Hub-Signature-256` cabeçalho{% endif %}. Você pode ver [a documentação do PubSubHubbub](https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html#authednotify) para obter mais informações. | diff --git a/translations/pt-BR/content/search-github/searching-on-github/finding-files-on-github.md b/translations/pt-BR/content/search-github/searching-on-github/finding-files-on-github.md index db96c2f48739..fe598716c183 100644 --- a/translations/pt-BR/content/search-github/searching-on-github/finding-files-on-github.md +++ b/translations/pt-BR/content/search-github/searching-on-github/finding-files-on-github.md @@ -18,12 +18,12 @@ topics: **Dicas:** -- By default, file finder results exclude some directories like `build`, `log`, `tmp`, and `vendor`. To search for files in these directories, use the [`filename` code search qualifier](/search-github/searching-on-github/searching-code#search-by-filename).{% ifversion file-finder-exclusion-controls %} Alternatively, you can customize which directories are excluded by default [using a `.gitattributes` file](#customizing-excluded-files).{% endif %} +- Por padrão, os resultados da busca de arquivos excluem alguns diretórios como `criar`, `log`, `tmp` e `fornecedor`. To search for files in these directories, use the [`filename` code search qualifier](/search-github/searching-on-github/searching-code#search-by-filename).{% ifversion file-finder-exclusion-controls %} Alternatively, you can customize which directories are excluded by default [using a `.gitattributes` file](#customizing-excluded-files).{% endif %} - É possível também abrir o file finder (localizador de arquivos) digitando `t` no teclado. Para obter mais informações, consulte "[Atalhos de teclado](/articles/keyboard-shortcuts)". {% endtip %} -## Using the file finder +## Usando o buscador de arquivos {% data reusables.repositories.navigate-to-repo %} 2. Acima da lista de arquivos, clique em **Ir para o arquivo**. ![Botão Find file (Localizar arquivo)](/assets/images/help/search/find-file-button.png) @@ -32,9 +32,9 @@ topics: {% ifversion file-finder-exclusion-controls %} -## Customizing excluded files +## Personalizando arquivos excluídos -By default, file finder results do not include files in the following directories if they exist at your repository root: +Por padrão, os resultados do buscador de arquivos não incluem arquivos nos seguintes diretórios se eles existem na raiz do repositório: - `.git` - `.hg` @@ -46,22 +46,22 @@ By default, file finder results do not include files in the following directorie - `tmp` - `vendor` -You can override these default exclusions using a `.gitattributes` file. +Você pode substituir estas exclusões padrão usando um arquivo `.gitattributes`. -To do this, create or update a file called `.gitattributes` in your repository root, setting the [`linguist-generated`](https://github.com/github/linguist/blob/master/docs/overrides.md) attribute to `false` for each directory that should be included in file finder results. +Para fazer isso, crie ou atualize um arquivo denominado `.gitattributes` na raiz do seu repositório, definindo o atrivuto [`linguist-generated`](https://github.com/github/linguist/blob/master/docs/overrides.md) como `falso` para cada diretório que deve ser incluído nos resultados do busca de arquivos. -For example, the following `.gitattributes` file would cause files in the `build/` directory to be available to the file finder: +Por exemplo, o seguinte arquivo `.gitattributes` faria com que os arquivos no diretório `build/` estivessem disponíveis no gerenciador de arquivos: ``` build/** linguist-generated=false ``` -Note that this override requires the use of the recursive glob pattern (`**`). For more information, see "[pattern format](https://git-scm.com/docs/gitignore#_pattern_format)" in the Git documentation. More complex overrides of subdirectories within excluded-by-default directories are not supported. +Observe que esta substituição exige o uso do padrão glob recursivo (`**`). Para obter mais informações, consulte "[formato padrão](https://git-scm.com/docs/gitignore#_pattern_format)" na documentação do Git. As substituições mais complexas de subdiretórios dentro de diretórios excluídos por padrão não são compatíveis. {% endif %} ## Leia mais -- "[About searching on GitHub](/search-github/getting-started-with-searching-on-github/about-searching-on-github)"{% ifversion file-finder-exclusion-controls %} -- "[Customizing how changed files appear on GitHub](/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github)" -- [`.gitattributes`](https://git-scm.com/docs/gitattributes) in the Git documentation{% endif %} +- "[Sobre a pesquisa no GitHub](/search-github/getting-started-with-searching-on-github/about-searching-on-github)"{% ifversion file-finder-exclusion-controls %} +- "[Personalizando como arquivos alterados aparecem no GitHub](/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github)" +- [`.gitattributes`](https://git-scm.com/docs/gitattributes) na documentação do Git{% endif %} diff --git a/translations/pt-BR/content/site-policy/github-terms/github-community-code-of-conduct.md b/translations/pt-BR/content/site-policy/github-terms/github-community-code-of-conduct.md index 67b7c23fa516..92a231b99313 100644 --- a/translations/pt-BR/content/site-policy/github-terms/github-community-code-of-conduct.md +++ b/translations/pt-BR/content/site-policy/github-terms/github-community-code-of-conduct.md @@ -1,5 +1,5 @@ --- -title: GitHub Community Code of Conduct +title: Código de Conduta da Comunidade GitHub redirect_from: - /articles/github-community-forum-code-of-conduct - /github/site-policy/github-community-forum-code-of-conduct @@ -16,7 +16,7 @@ topics: Milhões de desenvolvedores em todo o mundo hospedam milhões de projetos, tanto de código aberto como de código fechado, no GitHub. Nós temos sorte de poder participar da colaboração em toda a comunidade de desenvolvedores todos os dias que é uma responsabilidade que não aceitamos de de forma leviana. Juntos, todos nós temos a oportunidade interessante de fazer desta uma comunidade de que nos podemos orgulhar. -GitHub Community, powered by GitHub Discussions, is intended to be a place for further collaboration, support, and brainstorming. Este é um lugar civilizado para se conectar com outros usuários, aprender novas habilidades, compartilhar feedbacks e ideias e encontrar todo o suporte necessário para seus projetos do GitHub. By participating in GitHub Community, you are agreeing to the same [Terms of Service](/github/site-policy/github-terms-of-service/) and [GitHub Acceptable Use Policies](/github/site-policy/github-acceptable-use-policies) that apply to GitHub.com, as well as this GitHub Community-specific Code of Conduct. +A comunidade do GitHub, com base em Discussões do GitHub, destina-se a ser um lugar para mais colaboração, suporte e levantamento de ideias. Este é um lugar civilizado para se conectar com outros usuários, aprender novas habilidades, compartilhar feedbacks e ideias e encontrar todo o suporte necessário para seus projetos do GitHub. By participating in GitHub Community, you are agreeing to the same [Terms of Service](/github/site-policy/github-terms-of-service/) and [GitHub Acceptable Use Policies](/github/site-policy/github-acceptable-use-policies) that apply to GitHub.com, as well as this GitHub Community-specific Code of Conduct. With this Code of Conduct, we hope to help you understand how best to collaborate in GitHub Community, what you can expect from moderators, and what type of actions or content may result in temporary or permanent suspension from community participation. We will investigate any abuse reports and may moderate public content within GitHub Community that we determine to be in violation of either the GitHub Terms of Service or this Code of Conduct. diff --git a/translations/pt-BR/content/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data.md b/translations/pt-BR/content/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data.md index 94d34f2600cf..328e5c22c2c2 100644 --- a/translations/pt-BR/content/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data.md +++ b/translations/pt-BR/content/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data.md @@ -174,7 +174,7 @@ c/o Corporation Service Company 2710 Gateway Oaks Drive, Suite 150N Sacramento, CA 95833-3505 ``` -Courtesy copies may be emailed to legal-support@github.com +Cópias de cortesia podem ser enviadas para legal-support@github.com Por favor, faça suas solicitações da forma mais específica e breve quanto for possível, incluindo as seguintes informações: diff --git a/translations/pt-BR/content/site-policy/privacy-policies/github-privacy-statement.md b/translations/pt-BR/content/site-policy/privacy-policies/github-privacy-statement.md index 97b0499ba3cd..d0573033e7f1 100644 --- a/translations/pt-BR/content/site-policy/privacy-policies/github-privacy-statement.md +++ b/translations/pt-BR/content/site-policy/privacy-policies/github-privacy-statement.md @@ -289,22 +289,22 @@ Embora a tabela abaixo contenha informações sobre as categorias de informaçõ | Dados de geolocalização (como qualquer informação coletada após dar aos usuários a oportunidade de optar por serviços baseados na localização, que dependem dos serviços de localização precisos de um dispositivo. ) | Informação que o consumidor fornece automaticamente através da interação com os nossos Serviços | | Informações de áudio, eletrônicas, visuais ou similares, como conteúdo e arquivos enviados para o Serviço. | Informações que o consumidor pode optar por fornecer diretamente | | Informações profissionais ou de emprego | Informações que o consumidor pode optar por fornecer diretamente | -| Inferences drawn from any of the information identified in this table to create a profile about a consumer reflecting the consumer’s preferences | Informação que o consumidor fornece direta ou automaticamente através da interação com os nossos Serviços | +| Inferências extraídas de qualquer informação identificada nesta tabela para criar um perfil sobre um consumidor que reflete as preferências do consumidor | Informação que o consumidor fornece direta ou automaticamente através da interação com os nossos Serviços | -We use the categories of personal information described above for the purposes listed in the [“How GitHub uses your information”](/github/site-policy/github-privacy-statement#how-github-uses-your-information) section of our Privacy Statement. We also disclose the categories of personal information listed above for business purposes. Please see the [“How we share the information we collect”](/github/site-policy/github-privacy-statement#how-we-share-the-information-we-collect) section of our Privacy Statement for additional details. +Usamos as categorias de informações pessoais descritas acima para os fins listados na seção ["Como o GitHub usa suas informações"](/github/site-policy/github-privacy-statement#how-github-uses-your-information) da nossa Declaração de Privacidade. Também divulgamos as categorias de informações pessoais listadas acima para fins comerciais. Consulte a seção ["Como compartilhamos as informações que coletamos"](/github/site-policy/github-privacy-statement#how-we-share-the-information-we-collect) da nossa Declaração de Privacidade para obter detalhes adicionais. ### Não vendemos suas informações pessoais -De acordo com a CCPA, um negócio que consiste na venda de informações pessoais de residentes da Califórnia para outros: 1) deve avisar os residentes da Califórnia antes de vender suas informações pessoais para outros; e 2) deve fornecer o direito de opt-out (autoexclusão) pela venda de suas informações pessoais. GitHub does not sell personal information, including personal information of anyone under 16 years old. +De acordo com a CCPA, um negócio que consiste na venda de informações pessoais de residentes da Califórnia para outros: 1) deve avisar os residentes da Califórnia antes de vender suas informações pessoais para outros; e 2) deve fornecer o direito de opt-out (autoexclusão) pela venda de suas informações pessoais. O Github não vende informações pessoais, incluindo informações pessoais de menores de 16 anos. ### Seus direitos sob a CCPA A CCPA fornece aos residentes da Califórnia certos direitos relacionados às suas informações pessoais. Para enviar uma solicitação com base nesses direitos, entre em contato conosco por meio do nosso [formulário de contato](https://support.github.com/contact?tags=docs-policy). -Ao receber uma solicitação, verificaremos se o indivíduo que fez a solicitação é o residente a quem pertencem as informações pessoais sujeitas à solicitação. California residents may exercise their rights themselves or may use an authorized agent, designated in writing or through a power of attorney, to make requests on their behalf. If you use an authorized agent to submit a request, we may require that you provide us additional information demonstrating that the agent is acting on your behalf, and we may need you to verify your identity directly with us. With respect to your personal information, California residents may exercise the rights described below. -#### Right to Know. -You have a right to request that we disclose to you the personal information we have collected about you. Você também tem o direito de solicitar informações adicionais sobre nossa coleta, uso, divulgação ou venda dessas informações pessoais. Observe que fornecemos muitas dessas informações nesta declaração de privacidade. Você pode usar a API de Migração do Usuário GitHub para acessar e fazer o download dos seus dados. Saiba mais aqui. Você também pode fazer esse "pedido de conhecimento" entrando em contato conosco aqui. +Ao receber uma solicitação, verificaremos se o indivíduo que fez a solicitação é o residente a quem pertencem as informações pessoais sujeitas à solicitação. Os residentes da Califórnia podem exercer seus direitos eles mesmos ou utilizar um agente autorizado, designado por escrito ou por meio de um advogado, para fazer pedidos em seu nome. Se você usar um agente autorizado para enviar uma solicitação podemos exigir que você nos forneça informações adicionais que demonstrem que o agente está agindo em seu nome, e talvez seja necessário que você verifique sua identidade diretamente conosco. Com relação às suas informações pessoais, os residentes da Califórnia podem exercer os direitos descritos abaixo. +#### Direito de saber. +Você tem o direito de solicitar que divulgamos para você as informações pessoais que coletamos sobre você. Você também tem o direito de solicitar informações adicionais sobre nossa coleta, uso, divulgação ou venda dessas informações pessoais. Observe que fornecemos muitas dessas informações nesta declaração de privacidade. Você pode usar a API de Migração do Usuário GitHub para acessar e fazer o download dos seus dados. Saiba mais aqui. Você também pode fazer esse "pedido de conhecimento" entrando em contato conosco aqui. #### Direito de solicitar a exclusão. Você também tem o direito de solicitar que excluamos informações pessoais em certas circunstâncias, sujeitas a várias exceções. Para fazer um pedido de exclusão, você pode usar a API de migração de usuário do GitHub para acessar e fazer o download dos seus dados. Saiba mais aqui. Você também pode fazer esse "pedido de exclusão" entrando em contato conosco aqui. @@ -314,8 +314,8 @@ Você tem o direito de não participar de “vendas” futuras de informações #### Direito à não discriminação. Você tem o direito de não ser discriminado por exercer os seus direitos do CCPA. Não discriminaremos você pelo exercício dos seus direitos no âmbito do CCPA. -Você pode designar, por escrito ou por meio de advogado, um agente autorizado a fazer pedidos em seu nome para exercer seus direitos nos termos do CCPA. Antes de aceitar tal solicitação de um agente, exigimos que o agente forneça a prova que o autorizou a agir em seu nome, e talvez seja necessário que você verifique sua identidade diretamente conosco. Além disso, para fornecer ou excluir informações pessoais específicas, precisaremos verificar sua identidade de acordo com o grau de certeza exigido pela lei. Verificaremos a sua solicitação pedindo que você envie a solicitação do endereço de e-mail associado à sua conta ou exigindo que você forneça as informações necessárias para verificar sua conta. [Please note that you may use two-factor authentication with your GitHub account](/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication). -Finally, you have a right to receive notice of our practices at or before collection of personal information. +Você pode designar, por escrito ou por meio de advogado, um agente autorizado a fazer pedidos em seu nome para exercer seus direitos nos termos do CCPA. Antes de aceitar tal solicitação de um agente, exigimos que o agente forneça a prova que o autorizou a agir em seu nome, e talvez seja necessário que você verifique sua identidade diretamente conosco. Além disso, para fornecer ou excluir informações pessoais específicas, precisaremos verificar sua identidade de acordo com o grau de certeza exigido pela lei. Verificaremos a sua solicitação pedindo que você envie a solicitação do endereço de e-mail associado à sua conta ou exigindo que você forneça as informações necessárias para verificar sua conta. [Observeque você pode usar a autenticação de dois fatores com sua conta do GitHub.](/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication) +Por fim, você tem o direito de receber o aviso de nossas práticas durante ou antes da coleta de informações pessoais. Additionally, under California Civil Code section 1798.83, also known as the “Shine the Light” law, California residents who have provided personal information to a business with which the individual has established a business relationship for personal, family, or household purposes (“California Customers”) may request information about whether the business has disclosed personal information to any third parties for the third parties’ direct marketing purposes. Tenha em mente que não divulgamos informações pessoais a terceiros para fins de marketing direto, conforme definido nesta lei. California Customers may request further information about our compliance with this law by emailing **(privacy [at] github [dot] com)**. Observe que as empresas são obrigadas a responder a uma solicitação por cliente da Califórnia todos os anos e que talvez não seja necessário responder às solicitações por outros meios, além do endereço de e-mail designado. diff --git a/translations/pt-BR/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md b/translations/pt-BR/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md index 515fd465ff2f..a9a7e718c7a1 100644 --- a/translations/pt-BR/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md +++ b/translations/pt-BR/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md @@ -18,7 +18,7 @@ Data de entrada em vigor: **2 de abril de 2021** {% note %} -**Note:** Changes to the list of cookies on this page are currently pending. +**Observação:** As alterações para a lista de cookies nesta página estão pendentes. {% endnote %} @@ -26,7 +26,7 @@ O GitHub fornece um grande acordo de transparência em relação à forma como u ## Subprocessadores GitHub -Quando compartilhamos suas informações com terceiros subprocessadores, tais como nossos fornecedores e provedores de serviços, permanecemos responsáveis por elas. Trabalhamos muito duro para manter sua confiança quando trazemos novos fornecedores, e exigimos que todos os fornecedores se submetam a contratos de proteção de dados conosco que restringem seu processamento de Informações Pessoais dos Usuários (conforme definido na [Declaração de Privacidade](/articles/github-privacy-statement/)). You can sign up to receive subprocessor list updates [here](https://www.github.com/privacy/subprocessors). +Quando compartilhamos suas informações com terceiros subprocessadores, tais como nossos fornecedores e provedores de serviços, permanecemos responsáveis por elas. Trabalhamos muito duro para manter sua confiança quando trazemos novos fornecedores, e exigimos que todos os fornecedores se submetam a contratos de proteção de dados conosco que restringem seu processamento de Informações Pessoais dos Usuários (conforme definido na [Declaração de Privacidade](/articles/github-privacy-statement/)). Você pode se inscrever para receber atualizações da lista de subprocessadores [aqui](https://www.github.com/privacy/subprocessors). | Nome do subprocessador | Descrição do processamento | Local do Processamento | Localização corporativa | |:------------------------ |:--------------------------------------------------------------------------- |:---------------------- |:----------------------- | diff --git a/translations/pt-BR/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md b/translations/pt-BR/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md index 1a3b7b283e23..a197a5a9ac7f 100644 --- a/translations/pt-BR/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md +++ b/translations/pt-BR/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md @@ -25,7 +25,7 @@ shortTitle: Patrocinar um contribuidor Você pode patrocinar uma conta em nome de sua conta de pessoal para investir em projetos dos quais você se beneficia pessoalmente. Você pode patrocinar uma conta em nome de sua organização por muitas razões. - Sustentar bibliotecas específicas das quais o trabalho da sua organização depende -- Investir no ecossistema com o qual você conta como uma organização (como a blockchain) +- Investing in the ecosystem you rely on as an organization (such as blockchain) - Desenvolver a conscientização da marca como uma organização que valoriza o código aberto - Agradecer aos desenvolvedores de código aberto para a criação de bibliotecas que complementam os produtos que a sua organização oferece diff --git a/translations/pt-BR/data/features/packages-npm-v2.yml b/translations/pt-BR/data/features/packages-npm-v2.yml new file mode 100644 index 000000000000..572e412e4a45 --- /dev/null +++ b/translations/pt-BR/data/features/packages-npm-v2.yml @@ -0,0 +1,5 @@ +#Issue 7039 +#npm Package Registry Improvements (v2) GA +versions: + fpt: '*' + ghec: '*' diff --git a/translations/pt-BR/data/features/streaming-datadog.yml b/translations/pt-BR/data/features/streaming-datadog.yml new file mode 100644 index 000000000000..ab90546c8d4e --- /dev/null +++ b/translations/pt-BR/data/features/streaming-datadog.yml @@ -0,0 +1,4 @@ +#Reference #7495 +#Documentation for audit log streaming to a Datadog endpoint +versions: + ghec: '*' diff --git a/translations/pt-BR/data/graphql/ghec/graphql_upcoming_changes.public.yml b/translations/pt-BR/data/graphql/ghec/graphql_upcoming_changes.public.yml index 45eba08d2ba9..f025d7e4e5d2 100644 --- a/translations/pt-BR/data/graphql/ghec/graphql_upcoming_changes.public.yml +++ b/translations/pt-BR/data/graphql/ghec/graphql_upcoming_changes.public.yml @@ -996,7 +996,7 @@ upcoming_changes: owner: lukewar - location: ProjectView.groupedItems - description: '`groupedItems` will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.' + description: 'O `groupedItems` será removido. Siga o guia ProjectV2 em https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ para encontrar um substituto adequado.' reason: A API `ProjectNext` está obsoleta para favorecer a API `ProjectV2` que tem mais capacidade. date: '2022-10-01T00:00:00+00:00' criticality: breaking diff --git a/translations/pt-BR/data/graphql/graphql_upcoming_changes.public.yml b/translations/pt-BR/data/graphql/graphql_upcoming_changes.public.yml index 45eba08d2ba9..f025d7e4e5d2 100644 --- a/translations/pt-BR/data/graphql/graphql_upcoming_changes.public.yml +++ b/translations/pt-BR/data/graphql/graphql_upcoming_changes.public.yml @@ -996,7 +996,7 @@ upcoming_changes: owner: lukewar - location: ProjectView.groupedItems - description: '`groupedItems` will be removed. Follow the ProjectV2 guide at https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/, to find a suitable replacement.' + description: 'O `groupedItems` será removido. Siga o guia ProjectV2 em https://github.blog/changelog/2022-06-23-the-new-github-issues-june-23rd-update/ para encontrar um substituto adequado.' reason: A API `ProjectNext` está obsoleta para favorecer a API `ProjectV2` que tem mais capacidade. date: '2022-10-01T00:00:00+00:00' criticality: breaking diff --git a/translations/pt-BR/data/learning-tracks/code-security.yml b/translations/pt-BR/data/learning-tracks/code-security.yml index 22db7b40dc1b..bac6b7fbfb75 100644 --- a/translations/pt-BR/data/learning-tracks/code-security.yml +++ b/translations/pt-BR/data/learning-tracks/code-security.yml @@ -15,8 +15,8 @@ security_advisories: - /code-security/repository-security-advisories/removing-a-collaborator-from-a-repository-security-advisory #Feature available on dotcom and GHES 3.3+, so articles available on GHAE and earlier GHES hidden to hide the learning track dependabot_alerts: - title: 'Get notifications for insecure dependencies' - description: 'Set up Dependabot to alert you to new vulnerabilities{% ifversion GH-advisory-db-supports-malware %} or malware{% endif %} in your dependencies.' + title: 'Receber notificações para dependências inseguras' + description: 'Configure o dependente para alertar você sobre novas vulnerabilidades{% ifversion GH-advisory-db-supports-malware %} ou malware{% endif %} em suas dependências.' guides: - /code-security/dependabot/dependabot-alerts/about-dependabot-alerts - '{% ifversion fpt or ghec or ghes > 3.2 %}/github/administering-a-repository/managing-repository-settings/managing-security-and-analysis-settings-for-your-repository{% endif %}' diff --git a/translations/pt-BR/data/reusables/dependabot/dependabot-alerts-filters.md b/translations/pt-BR/data/reusables/dependabot/dependabot-alerts-filters.md index 53ee652c54b4..bb66dd96394a 100644 --- a/translations/pt-BR/data/reusables/dependabot/dependabot-alerts-filters.md +++ b/translations/pt-BR/data/reusables/dependabot/dependabot-alerts-filters.md @@ -2,7 +2,7 @@ You can sort and filter {% data variables.product.prodname_dependabot_alerts %} | Opção | Descrição | Exemplo | |:------------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ecossistema` | Displays alerts for the selected ecosystem | Use `ecosystem:npm` to show {% data variables.product.prodname_dependabot_alerts %} for npm |{% ifversion fpt or ghec or ghes > 3.5 %} +| `ecossistema` | Displays alerts for the selected ecosystem | Use `ecosystem:npm` to show {% data variables.product.prodname_dependabot_alerts %} for npm |{% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-7891 %} | `has` | Displays alerts meeting the selected filter criteria | Use `has:patch` to show alerts related to advisories that have a patch{% ifversion dependabot-alerts-vulnerable-calls %}
Use `has:vulnerable-calls` to show alerts relating to calls to vulnerable functions{% endif %} {% endif %} | `is` | Displays alerts based on their state | Use `is:open` to show open alerts | diff --git a/translations/pt-BR/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md b/translations/pt-BR/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md index c5d610006352..d9e308eee95d 100644 --- a/translations/pt-BR/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md +++ b/translations/pt-BR/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md @@ -1,4 +1,4 @@ -1. Define the key as a environment variable for {% data variables.product.product_name %}, replacing `` with the GPG key ID. +1. Define the key as an environment variable for {% data variables.product.product_name %}, replacing `` with the GPG key ID. ```bash{:copy} ghe-config "secrets.gpgverify.web-signing-key" "$(gpg --export-secret-keys -a | awk '{printf "%s\\n", $0}')" diff --git a/translations/pt-BR/data/reusables/gpg/copy-gpg-key-id.md b/translations/pt-BR/data/reusables/gpg/copy-gpg-key-id.md index 7527dd811a6a..99a4a4c3d9eb 100644 --- a/translations/pt-BR/data/reusables/gpg/copy-gpg-key-id.md +++ b/translations/pt-BR/data/reusables/gpg/copy-gpg-key-id.md @@ -1,9 +1,9 @@ 1. Da lista de chaves GPG, copie a forma longa do ID da chave GPG que você gostaria de usar. Neste exemplo, o ID da chave GPG é `3AA5C34371567BD2`: - ```shell + ```shell{:copy} $ gpg --list-secret-keys --keyid-format=long /Users/hubot/.gnupg/secring.gpg ------------------------------------ sec 4096R/3AA5C34371567BD2 2016-03-10 [expires: 2017-03-10] uid Hubot ssb 4096R/42B317FD4BA89E7A 2016-03-10 - ``` + ``` diff --git a/translations/pt-BR/data/reusables/gpg/list-keys-with-note.md b/translations/pt-BR/data/reusables/gpg/list-keys-with-note.md index de75bf4ce372..a3650500a0e3 100644 --- a/translations/pt-BR/data/reusables/gpg/list-keys-with-note.md +++ b/translations/pt-BR/data/reusables/gpg/list-keys-with-note.md @@ -1,10 +1,11 @@ - 1. Use o comando `gpg --list-secret-keys --keyid-format=long` para listar a forma longa das chaves GPG para as quais você tem uma chave pública e privada. Uma chave privada é necessária para assinar commits ou tags. - ```shell - $ gpg --list-secret-keys --keyid-format=long -``` - {% note %} - **Nota:** Algumas instalações GPG no Linux podem exigir que você use `gpg2 --list-keys --keyid-format LONG` para visualizar uma lista de suas chaves existentes. Neste caso você também precisará configurar o Git para usar `gpg2` executando `git config --global gpg.program gpg2`. + ```shell{:copy} + $ gpg --list-secret-keys --keyid-format=long + ``` + + {% note %} + + **Nota:** Algumas instalações GPG no Linux podem exigir que você use `gpg2 --list-keys --keyid-format LONG` para visualizar uma lista de suas chaves existentes. Neste caso você também precisará configurar o Git para usar `gpg2` executando `git config --global gpg.program gpg2`. - {% endnote %} + {% endnote %} diff --git a/translations/pt-BR/data/reusables/identity-and-permissions/ipv6-allow-lists.md b/translations/pt-BR/data/reusables/identity-and-permissions/ipv6-allow-lists.md new file mode 100644 index 000000000000..3c26491fe2fb --- /dev/null +++ b/translations/pt-BR/data/reusables/identity-and-permissions/ipv6-allow-lists.md @@ -0,0 +1,7 @@ +{% ifversion fpt or ghec %} +{% note %} + +**Note:** {% data variables.product.company_short %} is gradually rolling out support for IPv6. As {% data variables.product.prodname_dotcom %} services continue to add IPv6 support, we will start recognizing IPv6 addresses of {% data variables.product.prodname_dotcom %} users. To prevent possible access interruptions, please ensure you have added any necessary IPv6 addresses to your IP allow list. + +{% endnote %} +{% endif %} \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/package_registry/authenticate-packages.md b/translations/pt-BR/data/reusables/package_registry/authenticate-packages.md index a766f6e96d9f..5ca4e91584b2 100644 --- a/translations/pt-BR/data/reusables/package_registry/authenticate-packages.md +++ b/translations/pt-BR/data/reusables/package_registry/authenticate-packages.md @@ -4,4 +4,4 @@ You can use a personal access token (PAT) to authenticate to {% data variables.p To authenticate to a {% data variables.product.prodname_registry %} registry within a {% data variables.product.prodname_actions %} workflow, you can use: - `GITHUB_TOKEN` to publish packages associated with the workflow repository. -- a PAT to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). +- a PAT with at least `packages:read` scope to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). diff --git a/translations/pt-BR/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md b/translations/pt-BR/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md deleted file mode 100644 index 7fa54b22c10d..000000000000 --- a/translations/pt-BR/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md +++ /dev/null @@ -1,11 +0,0 @@ -{% ifversion fpt or ghec or ghes > 3.4 %} - -Para efetuar a autenticação em {% data variables.product.prodname_container_registry %} dentro de um fluxo de trabalho {% data variables.product.prodname_actions %}, use o `GITHUB_TOKEN` para obter a melhor segurança e experiência. If your workflow is using a personal access token (PAT) to authenticate to `{% data reusables.package_registry.container-registry-hostname %}`, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. - -{% ifversion fpt or ghec %}For guidance on updating your workflows that authenticate to `{% data reusables.package_registry.container-registry-hostname %}` with a personal access token, see "[Upgrading a workflow that accesses `ghcr.io`](/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions#upgrading-a-workflow-that-accesses-ghcrio)."{% endif %} - -Para obter mais informações sobre o `GITHUB_TOKEN`, consulte "[Autenticação em um fluxo de trabalho](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)". - -Se você estiver usando {% data variables.product.prodname_container_registry %} em ações, siga nossas práticas recomendadas em matéria de segurança na[Enrijecimento de segurança para o GitHub Actions](/actions/getting-started-with-github-actions/security-hardening-for-github-actions#considering-cross-repository-access)". - -{% endif %} diff --git a/translations/pt-BR/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md b/translations/pt-BR/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md new file mode 100644 index 000000000000..718710d5cea9 --- /dev/null +++ b/translations/pt-BR/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md @@ -0,0 +1,7 @@ +If your workflow is using a personal access token (PAT) to authenticate to a registry, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. + +{% ifversion fpt or ghec %}For guidance on updating your workflows that authenticate to a registry with a personal access token, see "[Upgrading a workflow that accesses a registry using a PAT](/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions#upgrading-a-workflow-that-accesses-a-registry-using-a-pat)."{% endif %} + +Para obter mais informações sobre o `GITHUB_TOKEN`, consulte "[Autenticação em um fluxo de trabalho](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)". + +For more information about the best practises when using a registry in actions, see "[Security hardening for GitHub Actions](/actions/getting-started-with-github-actions/security-hardening-for-github-actions#considering-cross-repository-access)." diff --git a/translations/pt-BR/data/reusables/package_registry/no-graphql-to-delete-packages.md b/translations/pt-BR/data/reusables/package_registry/no-graphql-to-delete-packages.md new file mode 100644 index 000000000000..cbab609f2b0e --- /dev/null +++ b/translations/pt-BR/data/reusables/package_registry/no-graphql-to-delete-packages.md @@ -0,0 +1 @@ +{% ifversion fpt or ghec %} The {% data variables.product.prodname_registry %} GraphQL API does not support containers or Docker images that use the package namespace `https://ghcr.io/OWNER/PACKAGE-NAME`, or npm images that use the package namespace `https://npm.pkg.github.com/OWNER/PACKAGE-NAME`.{% endif %} \ No newline at end of file diff --git a/translations/pt-BR/data/reusables/pages/navigate-publishing-source.md b/translations/pt-BR/data/reusables/pages/navigate-publishing-source.md index 023fcbd39289..f959dcee5e46 100644 --- a/translations/pt-BR/data/reusables/pages/navigate-publishing-source.md +++ b/translations/pt-BR/data/reusables/pages/navigate-publishing-source.md @@ -1 +1 @@ -1. Navegue até a fonte de publicação do seu site. For more information, see "[Configuring a publishing source for your GitHub Pages site](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." +1. Navegue até a fonte de publicação do seu site. Para obter mais informações, consulte "[Configurando uma fonte de publicação para o site do GitHub Pages](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)". diff --git a/translations/pt-BR/data/variables/product.yml b/translations/pt-BR/data/variables/product.yml index ddecd920aa8f..4168fb80dbab 100644 --- a/translations/pt-BR/data/variables/product.yml +++ b/translations/pt-BR/data/variables/product.yml @@ -112,6 +112,10 @@ prodname_registry: 'GitHub Package Registry' prodname_container_registry: 'Container registry' prodname_docker_registry_namespace: '{% ifversion fpt or ghec %}`docker.pkg.github.com`{% elsif ghes or ghae %}docker.HOSTNAME{% endif %}' prodname_container_registry_namespace: '{% ifversion fpt or ghec %}`ghcr.io`{% elsif ghes or ghae %}containers.HOSTNAME{% endif %}' +prodname_npm_registry: 'Registro de npm' +prodname_ghcr_and_npm_registry: '{% data variables.product.prodname_container_registry %}{% ifversion packages-npm-v2 %} and {% data variables.product.prodname_npm_registry %}{% endif %}' +prodname_ghcr_or_npm_registry: '{% data variables.product.prodname_container_registry %}{% ifversion packages-npm-v2 %} or {% data variables.product.prodname_npm_registry %}{% endif %}' +prodname_ghcr_and_npm_registry_full: '{% data variables.product.prodname_container_registry %} (`ghcr.io`){% ifversion packages-npm-v2 %} and {% data variables.product.prodname_npm_registry %} (`npm.pkg.github.com`){% endif %}' #GitHub Insights prodname_insights: 'GitHub Insights' #GitHub Sponsors diff --git a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md index 8db444c4882a..45fe502fd4a6 100644 --- a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md +++ b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/index.md @@ -25,6 +25,7 @@ children: - /managing-the-default-branch-name-for-your-repositories - /managing-security-and-analysis-settings-for-your-personal-account - /managing-access-to-your-personal-accounts-project-boards + - /managing-your-cookie-preferences-for-githubs-enterprise-marketing-pages - /integrating-jira-with-your-personal-projects - /what-does-the-available-for-hire-checkbox-do shortTitle: 个人帐户设置 diff --git a/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-cookie-preferences-for-githubs-enterprise-marketing-pages.md b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-cookie-preferences-for-githubs-enterprise-marketing-pages.md new file mode 100644 index 000000000000..a091ba0f320b --- /dev/null +++ b/translations/zh-CN/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-cookie-preferences-for-githubs-enterprise-marketing-pages.md @@ -0,0 +1,33 @@ +--- +title: Managing your cookie preferences for GitHub's enterprise marketing pages +intro: 'You can control how {% data variables.product.company_short %} uses information from non-essential tracking cookies for enterprise marketing pages.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - Accounts +shortTitle: Manage cookie preferences +--- + +## About cookie preferences on enterprise marketing pages + +{% data variables.product.company_short %} may use non-essential cookies on some enterprise marketing pages. You can customize how these cookies behave. For more information about how {% data variables.product.company_short %} uses cookies, see "[{% data variables.product.company_short %} Privacy Statement](/free-pro-team@latest/site-policy/privacy-policies/github-privacy-statement)." + +## Changing your cookie preferences + +You can customize how non-essential cookies behave on any {% data variables.product.company_short %} enterprise marketing page. + +1. Navigate to the {% data variables.product.company_short %} enterprise marketing page where you'd like to change your cookie preferences. For example, navigate to [{% data variables.product.company_short %} Resources](https://resources.github.com/). +1. Scroll to the bottom of the page, then click **Manage Cookies**. + + ![Screenshot of button to manage cookie settings.](/assets/images/help/settings/cookie-settings-manage.png) + +1. Under "Manage cookie preferences," to accept or reject each non-essential cookie, click **Accept** or **Reject**. + + ![Screenshot of radio buttons to choose "Accept" or "Reject" for non-essential cookies.](/assets/images/help/settings/cookie-settings-accept-or-reject.png) + +1. 单击 **Save changes(保存更改)**。 + + ![Screenshot of button to save changes.](/assets/images/help/settings/cookie-settings-save.png) diff --git a/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md b/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md index 024ad28af34b..4774b64695a5 100644 --- a/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md +++ b/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md @@ -147,11 +147,11 @@ OIDC 令牌还包括其他标准声明: 在云角色/资源上设置条件以限定其对 GitHub 工作流程的访问范围时,受众和主题声明通常结合使用。 - **受众**:默认情况下,此值使用组织或存储库所有者的 URL。 这可用于设置只有特定组织中的工作流程才能访问云角色的条件。 -- **主题**:具有预定义的格式,并且是有关工作流程的某些关键元数据的串联,如 {% data variables.product.prodname_dotcom %} 组织、存储库、分支或关联的[`作业`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idenvironment)环境。 请参阅“[示例主题声明](#example-subject-claims)”,了解如何从串联的元数据汇编主题声明。 +- **Subject**: By default, has a predefined format and is a concatenation of some of the key metadata about the workflow, such as the {% data variables.product.prodname_dotcom %} organization, repository, branch, or associated [`job`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idenvironment) environment. 请参阅“[示例主题声明](#example-subject-claims)”,了解如何从串联的元数据汇编主题声明。 -OIDC 令牌中还支持许多其他声明,这些声明也可用于设置这些条件。 +If you need more granular trust conditions, you can customize the issuer (`iss`) and subject (`sub`) claims that are included with the JWT. For more information, see "[Customizing the token claims](#customizing-the-token-claims)". -此外,云提供商可以允许你为访问令牌分配角色,从而允许你指定更精细的权限。 +There are also many additional claims supported in the OIDC token that can be used for setting these conditions. 此外,云提供商可以允许你为访问令牌分配角色,从而允许你指定更精细的权限。 {% note %} @@ -245,9 +245,13 @@ curl -H "Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" "$ACTIONS_ID_TOK {% ifversion actions-oidc-hardening-config %} ## Customizing the token claims -You can security harden your OIDC configuration by customizing the claims that are included with the JWT. This allows your cloud provider to apply more granular trust conditions when determining whether to grant access to its resources. For example, {% ifversion ghec %}you can customize the issuer (`iss`) claim to only allow access from a specific enterprise URL, and {% endif %}you can customize the subject (`sub`) value to require that requests originate from a specific repository, reusable workflow, or other source. +You can security harden your OIDC configuration by customizing the claims that are included with the JWT. These customisations allow you to define more granular trust conditions on your cloud roles when allowing your workflows to access resources hosted in the cloud: -To configure the claim conditions on {% data variables.product.prodname_dotcom %}, you can use the REST API endpoints described in the following sections. +{% ifversion ghec %} - For an additional layer of security, you can append the `issuer` url with your enterprise slug. This lets you set conditions on the issuer (`iss`) claim, configuring it to only accept JWT tokens from a unique `issuer` URL that must include your enterprise slug.{% endif %} +- You can standardize your OIDC configuration by setting conditions on the subject (`sub`) claim that require JWT tokens to originate from a specific repository, reusable workflow, or other source. +- You can define granular OIDC policies by using additional OIDC token claims, such as `repository_id` and `repo_visibility`. For more information, see "[Understanding the OIDC token](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#understanding-the-oidc-token)". + +To customize these claim formats, organization and repository admins can use the REST API endpoints described in the following sections. {% ifversion ghec %} @@ -282,19 +286,21 @@ After this setting is applied, the JWT will contain the updated `iss` value. In To configure organization-wide security, compliance, and standardization, you can customize the standard claims to suit your required access conditions. If your cloud provider supports conditions on subject claims, you can create a condition that checks whether the `sub` value matches the path of the reusable workflow, such as `"job_workflow_ref: "octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main""`. The exact format will vary depending on your cloud provider's OIDC configuration. To configure the matching condition on {% data variables.product.prodname_dotcom %}, you can can use the REST API to require that the `sub` claim must always include a specific custom claim, such as `job_workflow_ref`. For more information, see "[Set the customization template for an OIDC subject claim for an organization](/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization)." +Customizing the claims results in a new format for the entire `sub` claim, which replaces the default predefined `sub` format in the token described in "[Example subject claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims)." + The following example templates demonstrate various ways to customize the subject claim. To configure these settings on {% data variables.product.prodname_dotcom %}, organization admins use the REST API to specify a list of claims that must be included in the subject (`sub`) claim. {% data reusables.actions.use-request-body-api %} -To customize your subject claims, you should first create a matching condition in your cloud provider's OIDC configuration, before adding the configuration using the REST API. Once the configuration is completed, each time a new job runs, the OIDC token generated during that job will follow the new customization template. If the matching condition doesn't exist in the cloud provider's OIDC configuration before the job runs, the generated token might not be accepted by the cloud provider, since the cloud conditions may not be synchronized. +To customize your subject claims, you should first create a matching condition in your cloud provider's OIDC configuration, before customizing the configuration using the REST API. Once the configuration is completed, each time a new job runs, the OIDC token generated during that job will follow the new customization template. If the matching condition doesn't exist in the cloud provider's OIDC configuration before the job runs, the generated token might not be accepted by the cloud provider, since the cloud conditions may not be synchronized. {% note %} -**Note**: When the organization template is applied, it will not affect any existing repositories that already use OIDC. For new repositories that are created after the template has been applied, the repository owner will need to opt-in to receive this configuration. For more information, see "[Set the opt-in flag of an OIDC subject claim customization for a repository](/rest/actions/oidc#set-the-opt-in-flag-of-an-oidc-subject-claim-customization-for-a-repository)." +**Note**: When the organization template is applied, it will not affect any existing repositories that already use OIDC. For existing repositories, as well as any new repositories that are created after the template has been applied, the repository owner will need to opt-in to receive this configuration. For more information, see "[Set the opt-in flag of an OIDC subject claim customization for a repository](/rest/actions/oidc#set-the-opt-in-flag-of-an-oidc-subject-claim-customization-for-a-repository)." {% endnote %} #### Example: Allowing repository based on visibility and owner -This example template enables cloud access based on repository visibility and owner, letting you restrict cloud role access to only private repositories within an organization or enterprise. {% data reusables.actions.use-request-body-api %} +This example template allows the `sub` claim to have a new format, using `repository_owner` and `repository_visibility`: ```json { @@ -305,11 +311,11 @@ This example template enables cloud access based on repository visibility and ow } ``` -In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include specific values for `repository_owner` and `repository_visibility`. For example: `"repository_owner: "monalisa":repository_visibility:private"`. +In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include specific values for `repository_owner` and `repository_visibility`. For example: `"repository_owner: "monalisa":repository_visibility:private"`. The approach lets you restrict cloud role access to only private repositories within an organization or enterprise. #### Example: Allowing access to all repositories with a specific owner -This example template grants access to all repositories with a specified `repository_owner`. {% data reusables.actions.use-request-body-api %} +This example template enables the `sub` claim to have a new format with only the value of `repository_owner`. {% data reusables.actions.use-request-body-api %} ```json { @@ -324,7 +330,9 @@ In your cloud provider's OIDC configuration, configure the `sub` condition to re #### Example: Requiring a reusable workflow -This example template requires a specific reusable workflow in a claim, letting an enterprise enforce consistent deployments across its enterprise, organizations, and repositories. {% data reusables.actions.use-request-body-api %} +This example template allows the `sub` claim to have a new format that contains the value of the `job_workflow_ref` claim. This enables an enterprise to use [reusable workflows](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims) to enforce consistent deployments across its organizations and repositories. + +{% data reusables.actions.use-request-body-api %} ```json { @@ -338,7 +346,9 @@ In your cloud provider's OIDC configuration, configure the `sub` condition to re #### Example: Requiring a reusable workflow and other claims -This example template combines the requirement of a specific reusable workflow with additional claims. {% data reusables.actions.use-request-body-api %} +The following example template combines the requirement of a specific reusable workflow with additional claims. {% data reusables.actions.use-request-body-api %} + +This example also demonstrates how to use `"context"` to define your conditions. This is the part that follows the repository in the [default `sub` format](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#example-subject-claims). For example, when the job references an environment, the context contains: `environment:`. ```json { @@ -352,6 +362,8 @@ This example template combines the requirement of a specific reusable workflow w In your cloud provider's OIDC configuration, configure the `sub` condition to require that claims must include specific values for `repo`, `context`, and `job_workflow_ref`. +This customization template requires that the `sub` uses the following format: `repo::environment::job_workflow_ref:`. For example: `"sub": "repo:octo-org/octo-repo:environment:prod:job_workflow_ref:octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main"` + #### Example: Granting access to a specific repository This example template lets you grant cloud access to all the workflows in a specific repository, across all branches/tags and environments. To help improve security, combine this template with the custom issuer URL described in "[Customizing the token URL for an enterprise](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-url-for-an-enterprise)." diff --git a/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md b/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md index 3d3d21dcfd1e..af140033c82c 100644 --- a/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md +++ b/translations/zh-CN/content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md @@ -23,11 +23,18 @@ topics: 您可以创建一个可重用的工作流程来执行部署步骤,而不是将部署作业从一个工作流程复制并粘贴到另一个工作流程。 如果可重用工作流程满足“[重用工作流](/actions/learn-github-actions/reusing-workflows#access-to-reusable-workflows)”中所述的访问要求之一,则可以由另一个工作流程使用。 -与 OpenID Connect (OIDC) 结合使用时,可重用工作流程可让您在存储库、组织或企业中实施一致的部署。 为此,可以基于可重用工作流程在云角色上定义信任条件。 +You should be familiar with the concepts described in "\[Reusing workflows\](/actions/learn-github-actions/reusing-workflows" and "[About security hardening with OpenID Connect](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)." -为了创建基于可重用工作流程的信任条件,云提供商必须支持 `job_workflow_ref` 的自定义声明。 这允许您的云提供商确定作业最初来自哪个存储库。 如果您的云提供商仅支持标准声明(_受众_和_主题_),则无法确定作业是否源自可重用工作流程存储库。 支持 `job_workflow_ref` 的云提供商包括 Google Cloud Platform 和 HashiCorp Vault。 +## Defining the trust conditions -在继续之前,您应该熟悉[可重用工作流程](/actions/learn-github-actions/reusing-workflows) 和 [OpenID Connect](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect) 的概念。 +与 OpenID Connect (OIDC) 结合使用时,可重用工作流程可让您在存储库、组织或企业中实施一致的部署。 为此,可以基于可重用工作流程在云角色上定义信任条件。 The available options will vary depending on your cloud provider: + +- **Using `job_workflow_ref`**: + - To create trust conditions based on reusable workflows, your cloud provider must support custom claims for `job_workflow_ref`. 这允许您的云提供商确定作业最初来自哪个存储库。 + - For clouds that only support the standard claims (audience (`aud`) and subject (`sub`)), you can use the API to customize the `sub` claim to include `job_workflow_ref`. For more information, see "[Customizing the token claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-claims)". Support for custom claims is currently available for Google Cloud Platform and HashiCorp Vault. + +- **Customizing the token claims**: + - You can configure more granular trust conditions by customizing the issuer (`iss`) and subject (`sub`) claims included with the JWT. For more information, see "[Customizing the token claims](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#customizing-the-token-claims)". ## 令牌如何与可重用工作流程配合使用 diff --git a/translations/zh-CN/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md b/translations/zh-CN/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md index 33df75d7fe38..6e7678877030 100644 --- a/translations/zh-CN/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md +++ b/translations/zh-CN/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md @@ -71,7 +71,7 @@ You can add self-hosted runners at the organization level, where they can be use {% data reusables.organizations.navigate-to-org %} {% data reusables.organizations.org_settings %} {% data reusables.organizations.settings-sidebar-actions-runners %} -1. Click **New runner**. +{% ifversion actions-hosted-runners %}1. Click **New runner**, then click **New self-hosted runner**.{% else %}1. Click **New runner**.{% endif %} {% data reusables.actions.self-hosted-runner-configure %} {% elsif ghae or ghes < 3.4 %} {% data reusables.organizations.navigate-to-org %} diff --git a/translations/zh-CN/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md b/translations/zh-CN/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md index 14e01a6ba927..d95f60b37ac0 100644 --- a/translations/zh-CN/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md +++ b/translations/zh-CN/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md @@ -18,15 +18,23 @@ shortTitle: 启动时运行运行器应用程序 {% capture service_first_step %}1. 如果自托管的运行器应用程序正在运行,请停止它。{% endcapture %} {% capture service_non_windows_intro_shell %}在运行器机器上,在安装了自托管运行器应用程序的目录中打开 shell。 使用以下命令安装和管理自托管的运行器服务。{% endcapture %} -{% capture service_nonwindows_intro %}将自托管的运行器应用程序配置为服务之前,您必须添加运行器到 {% data variables.product.product_name %}。 更多信息请参阅“[添加自托管的运行器](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)”。{% endcapture %} -{% capture service_win_name %}actions.runner.*{% endcapture %} +{% capture service_nonwindows_intro %} + +{% note %} + +**Note:** You must add a runner to {% data variables.product.product_name %} before you can configure the self-hosted runner application as a service. 更多信息请参阅“[添加自托管的运行器](/github/automating-your-workflow-with-github-actions/adding-self-hosted-runners)”。 + +{% endnote %} +{% endcapture %} + +{% capture service_win_name %}actions.runner.*{% endcapture %} {% linux %} {{ service_nonwindows_intro }} -对于使用 `systemd` 的 Linux 系统,您可以使用随自托管运行器应用程序分发的 `svc.h` 脚本来安装和管理应用程序即服务。 +For Linux systems that use `systemd`, you can use the `svc.sh` script that is created after successfully adding the runner to install and manage using the application as a service. {{ service_non_windows_intro_shell }} diff --git a/translations/zh-CN/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md b/translations/zh-CN/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md index 9bcaca122790..3cf8fcf5419f 100644 --- a/translations/zh-CN/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md +++ b/translations/zh-CN/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md @@ -9,215 +9,65 @@ versions: ghae: '*' ghec: '*' type: tutorial -shortTitle: 管理对运行器的访问 +shortTitle: Using runner groups --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} -## 关于自托管运行器组 +## About runner groups -{% ifversion fpt %} -{% note %} - -**注:**所有组织都有一个默认的自托管运行器组。 只有企业帐户和企业帐户拥有的组织才能创建和管理其他自托管的运行器组。 - -{% endnote %} - -自托管运行器组用于控制对自托管运行器的访问。 组织管理员可以配置访问策略,用以控制组织中的哪些组织可以访问运行器组。 -如果您使用 - -{% data variables.product.prodname_ghe_cloud %},您可以创建额外的运行器组;企业管理员可以配置访问策略,控制企业中哪些组织可以访问运行器组;组织管理员可以为企业运行器组分配额外的细致仓库访问策略。 更多信息请参阅 [{% data variables.product.prodname_ghe_cloud %} 文档](/enterprise-cloud@latest/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups)。 -{% endif %} +{% data reusables.actions.about-runner-groups %} {% ifversion fpt %}For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups).{% endif %} {% ifversion ghec or ghes or ghae %} -自托管运行器组用于控制对组织和企业级自托管运行器的访问。 企业所有者可以配置访问策略来控制企业中哪些组织 -{% ifversion restrict-groups-to-workflows %}和工作流程{% endif %}可以访问运行器组。 组织所有者可以配置访问策略,以控制组织中哪些存储库{% ifversion restrict-groups-to-workflows %} 和工作流程{% endif %} 可以访问运行器组。 - -当企业所有者授予组织对运行器组的访问权限时,组织所有者可以看到组织的自托管运行器设置中列出的运行器组。 然后,组织所有者可以为企业运行器组分配更细致的存储库{% ifversion restrict-groups-to-workflows %} 和工作流程{% endif %} 访问策略。 - -新运行器在创建时,将自动分配给默认组。 运行器每次只能在一个组中。 您可以将运行器从默认组移到另一组。 更多信息请参阅“[将自托管运行器移动到组](#moving-a-self-hosted-runner-to-a-group)”。 ## 为组织创建自托管的运行器组 -所有组织都有一个默认的自托管运行器组。 企业帐户中的组织可以创建其他自托管组。 组织管理员可以允许单个仓库访问运行器组。 有关如何使用 REST API 创建自托管运行器组的信息,请参阅“[自托管运行器组](/rest/reference/actions#self-hosted-runner-groups)”。 - -自托管运行器在创建时会自动分配给默认组,并且每次只能成为一个组的成员。 您可以将运行器从默认组移到您创建的任何组。 - -创建组时,必须选择一个策略,用于定义哪些存储库{% ifversion restrict-groups-to-workflows %} 和工作流程{% endif %} 有权访问运行器组。 - -{% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %} -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.org_settings %} -{% data reusables.organizations.settings-sidebar-actions-runner-groups %} -1. 在“Runner groups(运行器组)”部分,单击 **New runner group(新运行器组)**。 -1. 为运行器组输入名称。 - {% data reusables.actions.runner-group-assign-policy-repo %} - - {% warning %} - - **警告:** {% indented_data_reference reusables.actions.self-hosted-runner-security spaces=3 %} +{%- ifversion ghec or ghes %} - 更多信息请参阅“[关于自托管运行器](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)”。 +{% data reusables.actions.self-hosted-runner-security-admonition %} - {% endwarning %} -{% data reusables.actions.runner-group-assign-policy-workflow %}{%- ifversion restrict-groups-to-workflows %} 组织拥有的运行器组无法访问企业中其他组织的工作流程;相反,您必须创建企业拥有的运行器组。{% endif %} -{% data reusables.actions.self-hosted-runner-create-group %} -{% elsif ghae or ghes < 3.4 %} -{% data reusables.organizations.navigate-to-org %} -{% data reusables.organizations.org_settings %} -{% data reusables.organizations.settings-sidebar-actions-runner-groups %} -1. 在 {% ifversion ghes or ghae %}“Runners(运行器)”{% endif %} 下,单击 **Add new(新增)**,然后单击 **New group(新建组)**。 +{%- endif %} - ![添加运行器组](/assets/images/help/settings/actions-org-add-runner-group.png) -1. 输入运行程序组的名称,并分配仓库访问策略。 - - 您可以将运行器组配置为可供特定的存储库列表或组织中的所有存储库访问。{% ifversion ghec or ghes %} 默认情况下,只有私有存储库可以访问运行器组中的运行器,但您可以覆盖此操作。 如果配置企业共享的组织的运行组,则不能覆盖此设置。{% endif %} - - {%- ifversion ghes %} - {% warning %} - - **警告**: - - {% indented_data_reference reusables.actions.self-hosted-runner-security spaces=3 %} - - 更多信息请参阅“[关于自托管运行器](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)”。 - - {% endwarning %} - {%- endif %} - - ![添加运行器组选项](/assets/images/help/settings/actions-org-add-runner-group-options.png) -1. 单击 **Save group(保存组)**创建组并应用策略。 -{% endif %} +{% data reusables.actions.creating-a-runner-group-for-an-organization %} ## 为企业创建自托管运行器组 -企业可以将其自托管的运行器添加到组以进行访问管理。 企业可以创建自托管运行器组,这些组可供企业帐户中的特定组织{% ifversion restrict-groups-to-workflows %} 或特定工作流程{% endif %} 访问。 然后,组织所有者可以为企业运行器组分配更细致的存储库{% ifversion restrict-groups-to-workflows %} 和工作流程{% endif %} 访问策略。 有关如何使用 REST API 创建自托管运行器组的信息,请参阅 [{% data variables.product.prodname_actions %} REST API](/rest/reference/actions#self-hosted-runner-groups) 中的企业端点。 - -自托管运行器在创建时会自动分配给默认组,并且每次只能成为一个组的成员。 您可以在注册过程中将运行器分配给特定组,也可以稍后将运行器从默认组移到自定义组。 - -创建组时,必须选择用于定义哪些组织有权访问运行器组的策略。 - -{% data reusables.actions.self-hosted-runner-groups-add-to-enterprise-first-steps %} -1. 要为组织访问选择策略,请选择 **Organization access(组织访问)**下拉列表,然后单击一个策略。 您可以将运行器组配置为可供特定组织列表或企业中的所有组织访问。{% ifversion ghes %} 默认情况下,只有私有存储库可以访问运行器组中的运行器,但您可以覆盖此操作。{% endif %} + {%- ifversion ghec or ghes %} - {%- ifversion ghec or ghes %} - {% warning %} +{% data reusables.actions.self-hosted-runner-security-admonition %} - **警告**: +{%- endif %} - {% indented_data_reference reusables.actions.self-hosted-runner-security spaces=3 %} - - 更多信息请参阅“[关于自托管运行器](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)”。 - - {% endwarning %} - {%- endif %} - {%- ifversion ghec or ghes %} - - ![添加运行器组选项](/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png) - {%- elsif ghae %} - - ![添加运行器组选项](/assets/images/help/settings/actions-enterprise-account-add-runner-group-options-ae.png) - {%- endif %} -{% data reusables.actions.runner-group-assign-policy-workflow %} -1. 单击 **Save group(保存组)**创建组并应用策略。 +{% data reusables.actions.creating-a-runner-group-for-an-enterprise %} {% endif %} ## 更改自托管运行器组的访问策略 -对于企业中的运行器组,您可以更改企业中可以访问运行器组的组织{% ifversion restrict-groups-to-workflows %} 或限制运行器组可以运行的工作流程{% endif %}。 对于组织中的运行器组,您可以更改组织中可以访问运行器组的存储库{% ifversion restrict-groups-to-workflows %} 或限制运行器组可以运行的工作流程{% endif %}。 - -### 更改可以访问运行器组的组织或存储库 - -{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %} -{% data reusables.actions.self-hosted-runner-groups-navigate-to-repo-org-enterprise %} -{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %} -1. 对于企业中的运行器组,在 **Organization access(组织访问)**下,修改可以访问运行器组的组织。 对于组织中的运行器组,在 **Repository access(存储库访问)**下,修改可以访问运行器组的存储库。 - - {%- ifversion fpt or ghec or ghes %} - {% warning %} - - **警告**: - - {% indented_data_reference reusables.actions.self-hosted-runner-security spaces=3 %} - - 更多信息请参阅“[关于自托管运行器](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)”。 - - {% endwarning %} - {%- endif %} -{% elsif ghae or ghes < 3.4 %} -{% data reusables.actions.self-hosted-runner-configure-runner-group-access %} -{% endif %} +{%- ifversion fpt or ghec or ghes %} -{% ifversion restrict-groups-to-workflows %} -### 更改可以访问运行器组的工作流程 -您可以将自托管运行器组配置为运行选定的工作流程或所有工作流程。 例如,可以使用此设置来保护存储在自托管运行器上的机密,或者通过将运行器组限制为仅运行特定的可重用工作流程来标准化部署工作流程。 如果配置企业共享的组织的运行组,则不能覆盖此设置。 -{% data reusables.actions.self-hosted-runner-groups-navigate-to-repo-org-enterprise %} -{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %} -1. 在 **Workflow access(工作流程访问)**下,选择下拉菜单,然后单击 **Selected workflows(选定的工作流程)**。 -1. 单击 {% octicon "gear" aria-label="the gear icon" %}。 -1. 输入以逗号分隔的可访问运行器组的工作流程列表。 使用完整路径,包括存储库名称和所有者。 将工作流程固定到分支、标记或完整 SHA。 例如:`octo-org/octo-repo/.github/workflows/build.yml@v2, octo-org/octo-repo/.github/workflows/deploy.yml@d6dc6c96df4f32fa27b039f2084f576ed2c5c2a5, monalisa/octo-test/.github/workflows/test.yml@main`。 +{% data reusables.actions.self-hosted-runner-security-admonition %} - 只有直接在所选工作流程中定义的作业才能访问运行器组。 +{%- endif %} - 组织拥有的运行器组无法访问企业中其他组织的工作流程。相反,您必须创建企业拥有的运行器组。 - -1. 单击 **Save(保存)**。 - -{% endif %} +{% data reusables.actions.changing-the-access-policy-of-a-runner-group %} ## 更改运行器组的名称 -{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %} -{% data reusables.actions.self-hosted-runner-groups-navigate-to-repo-org-enterprise %} -{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %} -1. 更改运行器组名称。 - -{% elsif ghae or ghes < 3.4 %} -{% data reusables.actions.self-hosted-runner-configure-runner-group %} -1. 更改运行器组名称。 -{% endif %} +{% data reusables.actions.changing-the-name-of-a-runner-group %} {% ifversion ghec or ghes or ghae %} ## 自动向组添加自托管运行器 -您可以使用配置脚本自动向组添加新的自托管运行器。 例如, 此命令将注册一个新的自托管运行器,并使用 `--runnergroup` 参数将其添加到名为 `rg-runnergroup` 的组。 - -```sh -./config.sh --url $org_or_enterprise_url --token $token --runnergroup rg-runnergroup -``` - -如果运行器组不存在,命令将失败: - -``` -找不到名为 "rg-runnergroup" 的任何自托管运行器组。 -``` +{% data reusables.actions.automatically-adding-a-runner-to-a-group %} ## 将自托管的运行器移动到组 -如果您在注册过程中没有指定运行器组,新的自托管运行器将自动分配到默认组,然后可以移到另一个组。 - -{% data reusables.actions.self-hosted-runner-navigate-to-org-enterprise %} -{% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %} -1. 在“Runners(运行器)”列表中,单击您要配置的运行器。 -2. 选择 **Runner group(运行器组)**下拉列表。 -3. 在“Move runner to group(将运行器移动到组)”中,选择运行器的目的地组。 -{% elsif ghae or ghes < 3.4 %} -1. 在设置页面的 {% ifversion ghes or ghae %} Runner groups(运行器组){% endif %} 部分,找到要移动的运行器的当前组,并展开组成员列表。 ![查看运行器组成员](/assets/images/help/settings/actions-org-runner-group-members.png) -2. 选中自托管运行器旁边的复选框,然后单击 **Move to group(移动到组)**以查看可用的目的地。 ![运行器组成员移动](/assets/images/help/settings/actions-org-runner-group-member-move.png) -3. 要移动运行器,请单击目标组。 ![运行器组成员移动](/assets/images/help/settings/actions-org-runner-group-member-move-destination.png) -{% endif %} +{% data reusables.actions.moving-a-runner-to-a-group %} ## 删除自托管运行器组 -自托管运行器在其组被删除时将自动返回到默认组。 +{% data reusables.actions.removing-a-runner-group %} -{% ifversion ghes or ghae or ghec %} -{% data reusables.actions.self-hosted-runner-groups-navigate-to-repo-org-enterprise %} -1. 在组列表中,在要删除的组右侧,单击 {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}。 -2. 要删除组,请单击 **Remove group(删除组)**。 -3. 查看确认提示,然后单击 **Remove this runner group(删除此运行器组)**。 - -{% endif %} {% endif %} diff --git a/translations/zh-CN/content/actions/learn-github-actions/understanding-github-actions.md b/translations/zh-CN/content/actions/learn-github-actions/understanding-github-actions.md index b2945079e849..cf2a9d320109 100644 --- a/translations/zh-CN/content/actions/learn-github-actions/understanding-github-actions.md +++ b/translations/zh-CN/content/actions/learn-github-actions/understanding-github-actions.md @@ -2,6 +2,7 @@ title: 了解 GitHub Actions shortTitle: 了解 GitHub Actions intro: '学习 {% data variables.product.prodname_actions %} 的基础知识,包括核心概念和基本术语。' +miniTocMaxHeadingLevel: 3 redirect_from: - /github/automating-your-workflow-with-github-actions/core-concepts-for-github-actions - /actions/automating-your-workflow-with-github-actions/core-concepts-for-github-actions @@ -82,7 +83,7 @@ _操作_是 {% data variables.product.prodname_actions %} 平台的自定义应 ### 运行器 -{% data reusables.actions.about-runners %} 每个运行器一次可以运行一个作业。 {% ifversion ghes or ghae %} 您必须为 {% data variables.product.product_name %} 托管自己的运行器。 {% elsif fpt or ghec %}{% data variables.product.company_short %} 提供 Ubuntu Linux、Microsoft Windows 和 macOS 运行器来运行您的工作流程;每个工作流程运行都在新预配的全新虚拟机中执行。 如果您需要不同的操作系统或需要特定的硬件配置,则可以托管自己的运行器。{% endif %} 有关{% ifversion fpt or ghec %} 自托管运行器{% endif %} 的更多信息,请参阅“[托管您自己的运行器](/actions/hosting-your-own-runners)”。 +{% data reusables.actions.about-runners %} 每个运行器一次可以运行一个作业。 {% ifversion ghes or ghae %} 您必须为 {% data variables.product.product_name %} 托管自己的运行器。 {% elsif fpt or ghec %}{% data variables.product.company_short %} 提供 Ubuntu Linux、Microsoft Windows 和 macOS 运行器来运行您的工作流程;每个工作流程运行都在新预配的全新虚拟机中执行。 {% ifversion actions-hosted-runners %} {% data variables.product.prodname_dotcom %} also offers {% data variables.actions.hosted_runner %}s, which are available in larger configurations. For more information, see "[Using {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/using-larger-runners)." {% endif %}If you need a different operating system or require a specific hardware configuration, you can host your own runners.{% endif %} For more information{% ifversion fpt or ghec %} about self-hosted runners{% endif %}, see "[Hosting your own runners](/actions/hosting-your-own-runners)." {% data reusables.actions.workflow-basic-example-and-explanation %} diff --git a/translations/zh-CN/content/actions/publishing-packages/publishing-nodejs-packages.md b/translations/zh-CN/content/actions/publishing-packages/publishing-nodejs-packages.md index b05078b9e3e8..aa8257e381c4 100644 --- a/translations/zh-CN/content/actions/publishing-packages/publishing-nodejs-packages.md +++ b/translations/zh-CN/content/actions/publishing-packages/publishing-nodejs-packages.md @@ -98,9 +98,9 @@ always-auth=true ### 配置目标仓库 -如果您没有在 *package.json* 文件中提供 `repository` 键,则 {% data variables.product.prodname_registry %} 将包发布到您在 *package.json* 文件的 `name` 字段中指定的 {% data variables.product.prodname_dotcom %} 仓库。 例如,名为 `@my-org/test` 的包将被发布到 `my-org/test` {% data variables.product.prodname_dotcom %} 仓库。 +Linking your package to {% data variables.product.prodname_registry %} using the `repository` key is optional. If you choose not to provide the `repository` key in your *package.json* file, then {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the `name` field of the *package.json* file. 例如,名为 `@my-org/test` 的包将被发布到 `my-org/test` {% data variables.product.prodname_dotcom %} 仓库。 If the `url` specified in the `repository` key is invalid, your package may still be published however it won't be linked to the repository source as intended. -但是,如果您提供了 `repository` 键,则该键中的仓库将被用作 {% data variables.product.prodname_registry %} 的目标 npm 注册表。 例如,发布以下 *package.json* 将导致名为 `my-amazing-package` 的包被发布到 `octocat/my-other-repo` {% data variables.product.prodname_dotcom %} 仓库。 +If you do provide the `repository` key in your *package.json* file, then the repository in that key is used as the destination npm registry for {% data variables.product.prodname_registry %}. 例如,发布以下 *package.json* 将导致名为 `my-amazing-package` 的包被发布到 `octocat/my-other-repo` {% data variables.product.prodname_dotcom %} 仓库。 Once published, only the repository source is updated, and the package doesn't inherit any permissions from the destination repository. ```json { diff --git a/translations/zh-CN/content/actions/using-github-hosted-runners/about-github-hosted-runners.md b/translations/zh-CN/content/actions/using-github-hosted-runners/about-github-hosted-runners.md index 2d10a26f1225..e0085668aa8c 100644 --- a/translations/zh-CN/content/actions/using-github-hosted-runners/about-github-hosted-runners.md +++ b/translations/zh-CN/content/actions/using-github-hosted-runners/about-github-hosted-runners.md @@ -86,6 +86,15 @@ jobs: ## 支持的运行器和硬件资源 +{% ifversion actions-hosted-runners %} + +{% note %} + +**Note**: {% data variables.product.prodname_dotcom %} also offers {% data variables.actions.hosted_runner %}s, which are available in larger configurations. For more information, see "[Using {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/using-larger-runners)." + +{% endnote %} +{% endif %} + Windows 和 Linux 虚拟机的硬件规格: - 2 核 CPU (x86_64) - 7 GB RAM diff --git a/translations/zh-CN/content/actions/using-github-hosted-runners/controlling-access-to-larger-runners.md b/translations/zh-CN/content/actions/using-github-hosted-runners/controlling-access-to-larger-runners.md new file mode 100644 index 000000000000..24f346d312c9 --- /dev/null +++ b/translations/zh-CN/content/actions/using-github-hosted-runners/controlling-access-to-larger-runners.md @@ -0,0 +1,50 @@ +--- +title: Controlling access to larger runners +intro: '您可以使用策略来限制对已添加到组织或企业的 {% data variables.actions.hosted_runner %} 的访问。' +product: '{% data reusables.gated-features.hosted-runners %}' +versions: + feature: actions-hosted-runners +type: tutorial +shortTitle: 'Controlling access to {% data variables.actions.hosted_runner %}s' +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + +## About runner groups + +{% data reusables.actions.about-runner-groups %} {% ifversion fpt %}For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/actions/using-github-hosted-runners/controlling-access-to-larger-runners).{% endif %} + +{% ifversion ghec or ghes or ghae %} + +## Creating a runner group for an organization + +{% data reusables.actions.hosted-runner-security-admonition %} +{% data reusables.actions.creating-a-runner-group-for-an-organization %} + +## Creating a runner group for an enterprise + +{% data reusables.actions.hosted-runner-security-admonition %} +{% data reusables.actions.creating-a-runner-group-for-an-enterprise %} + +{% endif %} + +## Changing the access policy of a runner group + +{% data reusables.actions.hosted-runner-security-admonition %} +{% data reusables.actions.changing-the-access-policy-of-a-runner-group %} + +## 更改运行器组的名称 + +{% data reusables.actions.changing-the-name-of-a-runner-group %} + +{% ifversion ghec or ghes or ghae %} +## Moving a runner to a group + +{% data reusables.actions.moving-a-runner-to-a-group %} + +## Removing a runner group + +{% data reusables.actions.removing-a-runner-group %} + +{% endif %} diff --git a/translations/zh-CN/content/actions/using-github-hosted-runners/index.md b/translations/zh-CN/content/actions/using-github-hosted-runners/index.md index 861149cb186c..ed5dcdc1b47c 100644 --- a/translations/zh-CN/content/actions/using-github-hosted-runners/index.md +++ b/translations/zh-CN/content/actions/using-github-hosted-runners/index.md @@ -7,6 +7,8 @@ versions: ghes: '*' children: - /about-github-hosted-runners + - /using-larger-runners + - /controlling-access-to-larger-runners - /monitoring-your-current-jobs - /customizing-github-hosted-runners - /connecting-to-a-private-network diff --git a/translations/zh-CN/content/actions/using-github-hosted-runners/using-larger-runners.md b/translations/zh-CN/content/actions/using-github-hosted-runners/using-larger-runners.md new file mode 100644 index 000000000000..22ea0079197c --- /dev/null +++ b/translations/zh-CN/content/actions/using-github-hosted-runners/using-larger-runners.md @@ -0,0 +1,135 @@ +--- +title: Using larger runners +intro: '{% data variables.product.prodname_dotcom %} offers larger runners with more RAM and CPU.' +miniTocMaxHeadingLevel: 3 +product: '{% data reusables.gated-features.hosted-runners %}' +versions: + feature: 'actions-hosted-runners' +shortTitle: Using {% data variables.actions.hosted_runner %}s +--- + +## Overview of {% data variables.actions.hosted_runner %}s + +In addition to the [standard {% data variables.product.prodname_dotcom %}-hosted runners](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources), {% data variables.product.prodname_dotcom %} also offers customers on {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %} plans a range of {% data variables.actions.hosted_runner %}s with more RAM and CPU. These runners are hosted by {% data variables.product.prodname_dotcom %} and have the runner application and other tools preinstalled. + +When you add a {% data variables.actions.hosted_runner %} to an organization, you are defining a type of machine from a selection of available hardware specifications and operating system images. {% data variables.product.prodname_dotcom %} will then create multiple instances of this runner that scale up and down to match the job demands of your organization, based on the autoscaling limits you define. + +## Architectural overview of {% data variables.actions.hosted_runner %}s + +The {% data variables.actions.hosted_runner %}s are managed at the organization level, where they are arranged into groups that can contain multiple instances of the runner. They can also be created at the enterprise level and shared with organizations in the hierarchy. Once you've created a group, you can then add a runner to the group and update your workflows to target the label assigned to the {% data variables.actions.hosted_runner %}. You can also control which repositories are permitted to send jobs to the group for processing. For more information about groups, see "[Controlling access to {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/controlling-access-to-larger-runners)." + +In the following diagram, a class of hosted runner named `ubuntu-20.04-16core` has been defined with customized hardware and operating system configuration. + +![Diagram explaining {% data variables.actions.hosted_runner %}](/assets/images/hosted-runner.png) + +1. Instances of this runner are automatically created and added to a group called `ubuntu-20.04-16core`. +2. The runners have been assigned the label `ubuntu-20.04-16core`. +3. Workflow jobs use the `ubuntu-20.04-16core` label in their `runs-on` key to indicate the type of runner they need to execute the job. +4. {% data variables.product.prodname_actions %} checks the runner group to see if your repository is authorized to send jobs to the runner. +5. The job runs on the next available instance of the `ubuntu-20.04-16core` runner. + +## Autoscaling {% data variables.actions.hosted_runner %}s + +Your {% data variables.actions.hosted_runner %}s can be configured to automatically scale to suit your needs. When jobs are submitted for processing, more machines can be automatically provisioned to run the jobs, until reaching a pre-defined maximum limit. Each machine only handles one job at a time, so these settings effectively determine the number of jobs that can be run concurrently. + +During the runner deployment process, you can configure the _Max_ option, which allows you to control your costs by setting the maximum parallel number of machines that are created in this set. A higher value here can help avoid workflows being blocked due to parallelism. + +## Networking for {% data variables.actions.hosted_runner %}s + +By default, {% data variables.actions.hosted_runner %}s receive a dynamic IP address that changes for each job run. Optionally, {% data variables.product.prodname_ghe_cloud %} customers can configure their {% data variables.actions.hosted_runner %}s to receive a static IP address from {% data variables.product.prodname_dotcom %}'s IP address pool. When enabled, instances of the {% data variables.actions.hosted_runner %} will receive an address from a range that is unique to the runner, allowing you to use this range to configure a firewall allowlist. You can use up to 10 static IP address ranges in total across all your {% data variables.actions.hosted_runner %}s. + +{% note %} + +**Note**: If runners are unused for more than 30 days, their IP address ranges are automatically removed and cannot be recovered. + +{% endnote %} + +## Planning for {% data variables.actions.hosted_runner %}s + +### Create a runner group + +Runner groups are used to collect sets of virtual machines and create a security boundary around them. You can then decide which organizations or repositories are permitted to run jobs on those sets of machines. During the {% data variables.actions.hosted_runner %} deployment process, the runner can be added to an existing group, or otherwise it will join a default group. You can create a group by following the steps in "[Controlling access to {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/controlling-access-to-larger-runners)." + +### Understanding billing + +Compared to standard {% data variables.product.prodname_dotcom %}-hosted runners, {% data variables.actions.hosted_runner %}s are billed differently. For more information, see "[Per-minute rates](/billing/managing-billing-for-github-actions/about-billing-for-github-actions#per-minute-rates)". + +## Adding a {% data variables.actions.hosted_runner %} to an enterprise + +You can add {% data variables.actions.hosted_runner %}s to an enterprise, where they can be assigned to multiple organizations. The organization admins can then control which repositories can use the runners. To add a {% data variables.actions.hosted_runner %} to an enterprise, you must be an enterprise owner. + +{% data reusables.actions.add-hosted-runner-overview %} + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.policies-tab %} +{% data reusables.enterprise-accounts.actions-tab %} +{% data reusables.enterprise-accounts.actions-runners-tab %} +{% data reusables.actions.add-hosted-runner %} +1. To allow organizations to access your {% data variables.actions.hosted_runner %}s, you specify the list of organizations that can use it. For more information, see "[Managing access to your runners](#managing-access-to-your-runners)." + +## Adding a {% data variables.actions.hosted_runner %} to an organization + +You can add a {% data variables.actions.hosted_runner %} to an organization, where the organization admins can control which repositories can use it. + +{% data reusables.actions.add-hosted-runner-overview %} + +{% data reusables.organizations.navigate-to-org %} +{% data reusables.organizations.org_settings %} +{% data reusables.organizations.settings-sidebar-actions-runners %} +{% data reusables.actions.add-hosted-runner %} +1. To allow repositories to access your {% data variables.actions.hosted_runner %}s, add them to the list of repositories that can use it. For more information, see "[Managing access to your runners](#managing-access-to-your-runners)." + +## Running jobs on your runner + +Once your runner type has been been defined, you can update your workflows to send jobs to the runner instances for processing. In this example, a runner group is populated with Ubuntu 16-core runners, which have been assigned the label `ubuntu-20.04-16core`. If you have a runner matching this label, the `check-bats-version` job then uses the `runs-on` key to target that runner whenever the job is run: + +```yaml +name: learn-github-actions +on: [push] +jobs: + check-bats-version: + runs-on: ubuntu-20.04-16core + steps: + - uses: {% data reusables.actions.action-checkout %} + - uses:{% data reusables.actions.action-setup-node %} + with: + node-version: '14' + - run: npm install -g bats + - run: bats -v +``` + +## Managing access to your runners + +{% note %} + +**Note**: Before your workflows can send jobs to {% data variables.actions.hosted_runner %}s, you must first configure permissions for the runner group. See the following sections for more information. + +{% endnote %} + +Runner groups are used to control which repositories can run jobs on your {% data variables.actions.hosted_runner %}s. You must grant access to the group from each level of the management hierarchy, depending on where you've defined the {% data variables.actions.hosted_runner %}: + +- **Runners at the enterprise level**: Configure the runner group to grant access to all the required organizations. In addition, for each organization, you must configure the group to specify which repositories are allowed access. +- **Runners at the organization level**: Configure the runner group by specifying which repositories are allowed access. + +For example, the following diagram has a runner group named `grp-ubuntu-20.04-16core` at the enterprise level. Before the repository named `octo-repo` can use the runners in the group, you must first configure the group at the enterprise level to allow access from the `octo-org` organization; you must then configure the group at the organization level to allow access from `octo-repo`: + +![Diagram explaining {% data variables.actions.hosted_runner %} groups](/assets/images/hosted-runner-mgmt.png) + +### Allowing repositories to access a runner group + +This procedure demonstrates how to configure group permissions at the enterprise and organization levels: + +{% data reusables.actions.runner-groups-navigate-to-repo-org-enterprise %} +{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %} + - For runner groups in an enterprise: under **Organization access**, modify which organizations can access the runner group. + - For runner groups in an organization: under **Repository access**, modify which repositories can access the runner group. + +{% warning %} + +**Warning**: + +{% data reusables.actions.hosted-runner-security %} + +For more information, see "[Controlling access to {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/controlling-access-to-larger-runners)." + +{% endwarning %} diff --git a/translations/zh-CN/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md b/translations/zh-CN/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md index 16c47f1261fe..e26a9bb8ce4d 100644 --- a/translations/zh-CN/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md +++ b/translations/zh-CN/content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md @@ -51,7 +51,7 @@ miniTocMaxHeadingLevel: 3 工作流程可以访问和还原当前分支、基础分支(包括复刻的仓库的基本分支)或默认分支(通常是 `main`)中创建的缓存 例如,在默认分支上创建的缓存可从任何拉取请求访问。 另外,如果分支 `feature-b` 具有基础分支 `feature-a`,则触发于 `feature-b` 的工作流程可以访问默认分支 (`main`)、`feature-a` 和 `feature-b` 中创建的缓存。 -访问限制通过在不同分支之间创建逻辑边界来提供缓存隔离和安全。 例如, 为分支 `feature-a`(具有基础分支 `main`)创建的缓存将无法访问分支 `feature-c`(具有基础分支 `main`)的拉取请求。 +Access restrictions provide cache isolation and security by creating a logical boundary between different branches or tags. 例如, 为分支 `feature-a`(具有基础分支 `main`)创建的缓存将无法访问分支 `feature-c`(具有基础分支 `main`)的拉取请求。 On similar lines, a cache created for the tag `release-a` (from the base `main`) would not be accessible to a workflow triggered for the tag `release-b` (with the base `main`). 仓库中的多个工作流程共享缓存条目。 可以从同一仓库和分支的另一个工作流程访问和恢复为工作流程中的分支创建的缓存。 diff --git a/translations/zh-CN/content/actions/using-workflows/reusing-workflows.md b/translations/zh-CN/content/actions/using-workflows/reusing-workflows.md index bbdf28e7fee3..676a5f6f4139 100644 --- a/translations/zh-CN/content/actions/using-workflows/reusing-workflows.md +++ b/translations/zh-CN/content/actions/using-workflows/reusing-workflows.md @@ -23,7 +23,7 @@ topics: Rather than copying and pasting from one workflow to another, you can make workflows reusable. You and anyone with access to the reusable workflow can then call the reusable workflow from another workflow. -Reusing workflows avoids duplication. This makes workflows easier to maintain and allows you to create new workflows more quickly by building on the work of others, just as you do with actions. Workflow reuse also promotes best practice by helping you to use workflows that are well designed, have already been tested, and have been proved to be effective. Your organization can build up a library of reusable workflows that can be centrally maintained. +Reusing workflows avoids duplication. This makes workflows easier to maintain and allows you to create new workflows more quickly by building on the work of others, just as you do with actions. Workflow reuse also promotes best practice by helping you to use workflows that are well designed, have already been tested, and have been proven to be effective. Your organization can build up a library of reusable workflows that can be centrally maintained. The diagram below shows three build jobs on the left of the diagram. After each of these jobs completes successfully a dependent job called "Deploy" runs. This job calls a reusable workflow that contains three jobs: "Staging", "Review", and "Production." The "Production" deployment job only runs after the "Staging" job has completed successfully. Using a reusable workflow to run deployment jobs allows you to run those jobs for each build without duplicating code in workflows. @@ -127,7 +127,7 @@ You can define inputs and secrets, which can be passed from the caller workflow runs-on: ubuntu-latest environment: production steps: - - uses: ./.github/workflows/my-action + - uses: octo-org/my-action@v1 with: username: ${{ inputs.username }} token: ${{ secrets.envPAT }} @@ -168,12 +168,13 @@ jobs: name: Pass input and secrets to my-action runs-on: ubuntu-latest steps: - - uses: ./.github/workflows/my-action + - uses: octo-org/my-action@v1 with: username: ${{ inputs.username }} token: ${{ secrets.token }} ``` {% endraw %} + {% ifversion actions-reusable-workflow-matrix %} ## Using a matrix strategy with a reusable workflow diff --git a/translations/zh-CN/content/actions/using-workflows/workflow-commands-for-github-actions.md b/translations/zh-CN/content/actions/using-workflows/workflow-commands-for-github-actions.md index 37869a815e8e..56a9a4652e40 100644 --- a/translations/zh-CN/content/actions/using-workflows/workflow-commands-for-github-actions.md +++ b/translations/zh-CN/content/actions/using-workflows/workflow-commands-for-github-actions.md @@ -329,6 +329,12 @@ Write-Output "::add-mask::Mona The Octocat" {% endpowershell %} +{% warning %} + +**Warning:** Make sure you register the secret with 'add-mask' before outputting it in the build logs or using it in any other workflow commands. + +{% endwarning %} + ### 示例:屏蔽环境变量 当您在日志中打印变量 `MY_NAME` 或值 `"Mona The Octocat"` 时,您将看到 `"***"` 而不是 `"Mona The Octocat"`。 diff --git a/translations/zh-CN/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-dependency-review-for-your-appliance.md b/translations/zh-CN/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-dependency-review-for-your-appliance.md new file mode 100644 index 000000000000..0403decab743 --- /dev/null +++ b/translations/zh-CN/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-dependency-review-for-your-appliance.md @@ -0,0 +1,52 @@ +--- +title: Configuring dependency review for your appliance +shortTitle: 配置依赖项审查 +intro: 'To helps users understand dependency changes when reviewing pull requests, you can enable, configure, and disable dependency review for {% data variables.product.product_location %}.' +product: '{% data reusables.gated-features.dependency-review %}' +miniTocMaxHeadingLevel: 3 +versions: + feature: dependency-review-action-ghes +type: how_to +topics: + - Advanced Security + - Enterprise + - Dependency review + - Security +--- + +{% data reusables.dependency-review.beta %} + +## 关于依赖项审查 + +{% data reusables.dependency-review.feature-overview %} + +Some additional features, such as license checks, blocking of pull requests, and CI/CD integration, are available with the [dependency review action](https://github.com/actions/dependency-review-action). + +## 检查您的许可是否包含 {% data variables.product.prodname_GH_advanced_security %} + +{% data reusables.advanced-security.check-for-ghas-license %} + +## Prerequisites for dependency review + +- A license for {% data variables.product.prodname_GH_advanced_security %}{% ifversion ghes %} (see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)").{% endif %} + +- The dependency graph enabled for the instance. Site administrators can enable the dependency graph via the management console or the administrative shell (see "[Enabling the dependency graph for your enterprise](/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise)"). + +- {% data variables.product.prodname_github_connect %} enabled to download and synchronize vulnerabilities from the {% data variables.product.prodname_advisory_database %}. This is usually configured as part of setting up {% data variables.product.prodname_dependabot %} (see "[Enabling Dependabot for your enterprise](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)"). + +## Enabling and disabling dependency review + +To enable or disable dependency review, you need to enable or disable the dependency graph for your instance. + +更多信息请参阅“[为企业启用依赖关系图](/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise)”。 + +## Running dependency review using {% data variables.product.prodname_actions %} + +{% data reusables.dependency-review.dependency-review-action-beta-note %} + +The dependency review action is included in your installation of {% data variables.product.prodname_ghe_server %}. It is available for all repositories that have {% data variables.product.prodname_GH_advanced_security %} and dependency graph enabled. + +{% data reusables.dependency-review.dependency-review-action-overview %} + +Users run the dependency review action using a {% data variables.product.prodname_actions %} workflow. If you have not already set up runners for {% data variables.product.prodname_actions %}, you must do this to enable users to run workflows. 您可以在仓库、组织或企业帐户级别预配自托管运行器。 For information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners)" and "[Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners)." + diff --git a/translations/zh-CN/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/index.md b/translations/zh-CN/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/index.md index f3a53bcf69ba..45243ffe4ecc 100644 --- a/translations/zh-CN/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/index.md +++ b/translations/zh-CN/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/index.md @@ -14,6 +14,7 @@ topics: children: - /enabling-github-advanced-security-for-your-enterprise - /configuring-code-scanning-for-your-appliance + - /configuring-dependency-review-for-your-appliance - /configuring-secret-scanning-for-your-appliance --- diff --git a/translations/zh-CN/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise.md b/translations/zh-CN/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise.md index 594883ae7daf..9fd5e92d725b 100644 --- a/translations/zh-CN/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise.md +++ b/translations/zh-CN/content/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise.md @@ -23,7 +23,7 @@ topics: ## 通过 {% data variables.enterprise.management_console %} 启用依赖关系图 -如果您的 {% data variables.product.product_location %} 使用群集,则无法使用 {% data variables.enterprise.management_console %} 启用依赖关系图,而必须改用管理 shell。 更多信息请参阅“[通过管理 shell 启用依赖关系图](#enabling-the-dependency-graph-via-the-administrative-shell)”。 +If {% data variables.product.product_location %} uses clustering, you cannot enable the dependency graph with the {% data variables.enterprise.management_console %} and must use the administrative shell instead. 更多信息请参阅“[通过管理 shell 启用依赖关系图](#enabling-the-dependency-graph-via-the-administrative-shell)”。 {% data reusables.enterprise_site_admin_settings.sign-in %} {% data reusables.enterprise_site_admin_settings.access-settings %} diff --git a/translations/zh-CN/content/admin/configuration/configuring-network-settings/configuring-a-hostname.md b/translations/zh-CN/content/admin/configuration/configuring-network-settings/configuring-a-hostname.md index f55aca1b8fbb..868e142b9484 100644 --- a/translations/zh-CN/content/admin/configuration/configuring-network-settings/configuring-a-hostname.md +++ b/translations/zh-CN/content/admin/configuration/configuring-network-settings/configuring-a-hostname.md @@ -19,6 +19,8 @@ topics: {% data variables.enterprise.management_console %} 中的主机名设置应设置为合适的完全限定域名 (FQDN),此域名可在互联网上或您的内部网络内解析。 例如,您的主机名设置可能是 `github.companyname.com。` Web 和 API 请求将自动重定向到 {% data variables.enterprise.management_console %} 中配置的主机名。 请注意,`localhost` 不是有效的主机名设置。 +Hostnames must be less than 63 characters in length per [Section 2.3.4 of the Domain Names Specification RFC](https://datatracker.ietf.org/doc/html/rfc1035#section-2.3.4). + 配置主机名后,可以启用子域隔离以进一步提高 {% data variables.product.product_location %} 的安全性。 更多信息请参阅“[启用子域隔离](/enterprise/admin/guides/installation/enabling-subdomain-isolation/)”。 有关支持的主机名类型的详细信息,请参阅 [HTTP RFC 2.1 节](https://tools.ietf.org/html/rfc1123#section-2)。 diff --git a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md index 6d65887989e9..17677f78e705 100644 --- a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md +++ b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md @@ -78,6 +78,14 @@ shortTitle: 配置电子邮件通知 您可以对所有传入的 SMTP 连接强制实施 TLS 加密,这有助于满足 ISO-27017 认证要求。 +{%- ifversion ghes = 3.6 %} +{% note %} + +**Note**: Enforcement of TLS for SMTP connections is unavailable in {% data variables.product.product_name %} 3.6.0. The feature will be available in an upcoming release. + +{% endnote %} +{%- endif %} + {% data reusables.enterprise_site_admin_settings.email-settings %} 1. 在“Authentication(身份验证)”下,选择 **Enforce TLS auth (recommended)(强制实施 TLS 身份验证[推荐])**。 diff --git a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md index e074b64fd8d5..5bd322dcae97 100644 --- a/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md +++ b/translations/zh-CN/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md @@ -131,46 +131,49 @@ Key | Description {% ifversion ghes %} ## Indexing -GitHub's [code search][] features are powered by [ElasticSearch][]. This section of the site admin dashboard shows you the current status of your ElasticSearch cluster and provides you with several tools to control the behavior of searching and indexing. These tools are split into the following three categories. +GitHub's search features are powered by Elasticsearch. This section of the site admin dashboard shows you the current status of your Elasticsearch cluster and provides you with several tools to control search and index behavior. - [Code Search]: https://github.com/blog/1381-a-whole-new-code-search - [ElasticSearch]: http://www.elasticsearch.org/ +For more information about code search, see "[Searching for information on {% data variables.product.prodname_dotcom %}](/search-github)." For more information about Elasticsearch, see the [Elasticsearch website](https://elastic.co). -### Code search +{% note %} -This allows you to enable or disable both search and index operations on source code. +**Note**: In normal use, site administrators do not need to create new indices or schedule repair jobs. For troubleshooting or other support purposes, {% data variables.contact.github_support %} may instruct you to run a repair job. -### Code search index repair +{% endnote %} -This controls how the code search index is repaired. You can +### Index management -- enable or disable index repair jobs -- start a new index repair job -- reset all index repair state +{% data variables.product.product_name %} reconciles the state of the search index with data on the instance automatically and regularly. -{% data variables.product.prodname_enterprise %} uses repair jobs to reconcile the state of the search index with data stored in a database (issues, pull requests, repositories, and users) and data stored in Git repositories (source code). This happens when +- Issues, pull requests, repositories, and users in the database +- Git repositories (source code) on disk -- a new search index is created; -- missing data needs to be backfilled; or -- old search data needs to be updated. +Your instance uses repair jobs to reconcile the data, and schedules a repair job in the background when the following events occur. -In other words, repair jobs are started as needed and run in the background—they are not scheduled by site admins in any way. +- A new search index is created. +- Missing data needs to be backfilled. +- Old search data needs to be updated. -Furthermore, repair jobs use a "repair offset" for parallelization. This is an offset into the database table for the record being reconciled. Multiple background jobs can synchronize work based on this offset. +You can create a new index, or you can click on an existing index in the list to manage the index. You can perform the following operations on an index. -A progress bar shows the current status of a repair job across all of its background workers. It is the percentage difference of the repair offset with the highest record ID in the database. Don't worry about the value shown in the progress bar after a repair job has completed: because it shows the difference between the repair offset and the highest record ID in the database, it will decrease as more repositories are added to {% data variables.product.product_location %} even though those repositories are actually indexed. +- Make the index searchable. +- Make the index writable. +- Update the index. +- Delete the index +- Reset the index repair state. +- Start a new index repair job. +- Enable or disable index repair jobs. -You can start a new code-search index repair job at any time. It will use a single CPU as it reconciles the search index with database and Git repository data. To minimize the effects this will have on I/O performance and reduce the chances of operations timing out, try to run a repair job during off-peak hours first. Monitor your system's load averages and CPU usage with a utility like `top`; if you don't notice any significant changes, it should be safe to run an index repair job during peak hours, as well. +A progress bar shows the current status of a repair job across background workers. The bar is the percentage difference of the repair offset with the highest record ID in the database. You can ignore the value shown in the progress bar after a repair job has completed. The progress bar shows the difference between the repair offset and the highest record ID in the database, and will decrease as more repositories are added to {% data variables.product.product_location %} even though those repositories are actually indexed. -### Issues index repair +To minimize the effects on I/O performance and reduce the chances of operations timing out, run the repair job during off-peak hours. As the job reconciles the search index with database and Git repository data, one CPU will be used. Monitor your system's load averages and CPU usage with a utility like `top`. If you don't notice any significant increase in resource consumption, it should also be safe to run an index repair job during peak hours. -This controls how the [Issues][] index is repaired. You can +Repair jobs use a "repair offset" for parallelization. This is an offset into the database table for the record being reconciled. Multiple background jobs can synchronize work based on this offset. - [Issues]: https://github.com/blog/831-issues-2-0-the-next-generation +### Code search + +This allows you to enable or disable both search and index operations on source code. -- enable or disable index repair jobs -- start a new index repair job -- reset all index repair state {% endif %} ## Reserved logins diff --git a/translations/zh-CN/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md b/translations/zh-CN/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md index 57013e8ab65e..16983abf1f44 100644 --- a/translations/zh-CN/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md +++ b/translations/zh-CN/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md @@ -15,7 +15,7 @@ topics: shortTitle: 启动故障转移到设备 --- -故障转移所需的时间取决于手动升级副本和重定向流量所需的时长。 平均时间范围为 2-10 分钟。 +故障转移所需的时间取决于手动升级副本和重定向流量所需的时长。 平均时间范围为 20-30 分钟。 {% data reusables.enterprise_installation.promoting-a-replica %} diff --git a/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md b/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md index dbc7885a8181..eaf7abed76e3 100644 --- a/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md +++ b/translations/zh-CN/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md @@ -83,7 +83,7 @@ You can create a runner group to manage access to the runner that you added to y {% data variables.product.product_name %} adds all new runners to a group. Runners can be in one group at a time. By default, {% data variables.product.product_name %} adds new runners to the "Default" group. -{% data reusables.actions.self-hosted-runner-groups-add-to-enterprise-first-steps %} +{% data reusables.actions.runner-groups-add-to-enterprise-first-steps %} 1. To choose a policy for organization access, under "Organization access", select the **Organization access** drop-down, and click **Selected organizations**. 1. To the right of the drop-down with the organization access policy, click {% octicon "gear" aria-label="The Gear icon" %}. 1. Select the organizations you'd like to grant access to the runner group. @@ -100,7 +100,7 @@ You can create a runner group to manage access to the runner that you added to y {% endwarning %} {%- endif %} -{% data reusables.actions.self-hosted-runner-create-group %} +{% data reusables.actions.create-runner-group %} {%- ifversion ghec or ghes > 3.3 or ghae-issue-5091 %} 1. Click the "Runners" tab. 1. In the list of runners, click the runner that you deployed in the previous section. diff --git a/translations/zh-CN/content/admin/guides.md b/translations/zh-CN/content/admin/guides.md index ad37b307aae7..9f0235631ebf 100644 --- a/translations/zh-CN/content/admin/guides.md +++ b/translations/zh-CN/content/admin/guides.md @@ -45,6 +45,7 @@ includeGuides: - /admin/configuration/configuring-built-in-firewall-rules - /admin/configuration/configuring-code-scanning-for-your-appliance - /admin/configuration/configuring-data-encryption-for-your-enterprise + - /admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-dependency-review-for-your-appliance - /admin/configuration/configuring-dns-nameservers - /admin/configuration/configuring-rate-limits - /admin/configuration/configuring-secret-scanning-for-your-appliance diff --git a/translations/zh-CN/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md b/translations/zh-CN/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md index 851db4fda672..e9ee55ce39e2 100644 --- a/translations/zh-CN/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md +++ b/translations/zh-CN/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md @@ -44,7 +44,8 @@ Enterprise owners can set up{% ifversion pause-audit-log-stream %}, pause,{% end - [Amazon S3](#setting-up-streaming-to-amazon-s3) - [Azure Blob Storage](#setting-up-streaming-to-azure-blob-storage) -- [Azure Event Hubs](#setting-up-streaming-to-azure-event-hubs) +- [Azure Event Hubs](#setting-up-streaming-to-azure-event-hubs){% ifversion streaming-datadog %} +- [Datadog](#setting-up-streaming-to-datadog){% endif %} - [Google Cloud Storage](#setting-up-streaming-to-google-cloud-storage) - [Splunk](#setting-up-streaming-to-splunk) @@ -231,6 +232,32 @@ Then, set up streaming with access keys until the vulnerability is resolved. For {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} +{% ifversion streaming-datadog %} +### Setting up streaming to Datadog + +To set up streaming to Datadog, you must create a client token or an API key in Datadog, then configure audit log streaming in {% data variables.product.product_name %} using the token for authentication. You do not need to create a bucket or other storage container in Datadog. + +After you set up streaming to Datadog, you can see your audit log data by filtering by "github.audit.streaming." For more information, see [Log Management](https://docs.datadoghq.com/logs/). + +1. If you don't already have a Datadog account, create one. +1. In Datadog, generate a client token or an API key, then click **Copy key**. For more information, see [API and Application Keys](https://docs.datadoghq.com/account_management/api-app-keys/) in Datadog Docs. +{% data reusables.enterprise.navigate-to-log-streaming-tab %} +1. Select the **Configure stream** dropdown menu and click **Datadog**. + + ![Screenshot of the "Configure stream" dropdown menu with "Datadog" highlighted](/assets/images/help/enterprises/audit-stream-choice-datadog.png) +1. Under "Token", paste the token you copied earlier. + + ![Screenshot of the "Token" field](/assets/images/help/enterprises/audit-stream-datadog-token.png) +1. Select the "Site" dropdown menu and click your Datadog site. To determine your Datadog site, compare your Datadog URL to the table in [Datadog sites](https://docs.datadoghq.com/getting_started/site/) in Datadog Docs. + + ![Screenshot of the "Site" dropdown menu](/assets/images/help/enterprises/audit-stream-datadog-site.png) +1. To verify that {% data variables.product.prodname_dotcom %} can connect and write to the Datadog endpoint, click **Check endpoint**. + + ![检查端点](/assets/images/help/enterprises/audit-stream-check.png) +{% data reusables.enterprise.verify-audit-log-streaming-endpoint %} +1. After a few minutes, confirm that audit log data is appearing on the **Logs** tab in Datadog. If audit log data is not appearing, confirm that your token and site are correct in {% data variables.product.prodname_dotcom %}. +{% endif %} + ### 设置流式传输到 Google Cloud Storage 要设置流式传输到 Google Cloud Storage,您必须在 Google Cloud 中使用适当的凭据和权限创建一个服务帐户,然后使用服务帐户的凭据在 {% data variables.product.product_name %} 中配置审核日志流以进行身份验证。 @@ -291,6 +318,10 @@ Then, set up streaming with access keys until the vulnerability is resolved. For 暂停流允许您对接收应用程序执行维护,而不会丢失审核数据。 审核日志在 {% data variables.product.product_location %} 上最多存储七天,然后在取消暂停流时导出。 +{% ifversion streaming-datadog %} +Datadog only accepts logs from up to 18 hours in the past. If you pause a stream to a Datadog endpoint for more than 18 hours, you risk losing logs that Datadog won't accept after you resume streaming. +{% endif %} + {% data reusables.enterprise.navigate-to-log-streaming-tab %} 1. 单击 **Pause stream(暂停流)**。 diff --git a/translations/zh-CN/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md b/translations/zh-CN/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md index 0b948fde591a..aa1b84b5b1ad 100644 --- a/translations/zh-CN/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md +++ b/translations/zh-CN/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md @@ -121,7 +121,7 @@ GraphQL API 对每个查询最多返回 100 个节点。 要检索其他结果 下面的查询搜索在 `avocado-corp` 企业中搜索 2022 年 1 月 1 日创建的审核日志事件,并使用 [REST API 分页](/rest/overview/resources-in-the-rest-api#pagination)返回第一页,每页最多包含 100 个项: ```shell -curl -H "Authorization: token TOKEN" \ +curl -H "Authorization: Bearer TOKEN" \ --request GET \ "https://api.github.com/enterprises/avocado-corp/audit-log?phrase=created:2022-01-01&page=1&per_page=100" ``` @@ -133,7 +133,7 @@ curl -H "Authorization: token TOKEN" \ 下面的查询搜索拉取请求的审核日志事件,其中事件发生在 `avocado-corp` 企业中的 2022 年 1 月 1 日或之后,并且该操作由 `octocat` 用户执行: ```shell -curl -H "Authorization: token TOKEN" \ +curl -H "Authorization: Bearer TOKEN" \ --request GET \ "https://api.github.com/enterprises/avocado-corp/audit-log?phrase=action:pull_request+created:>=2022-01-01+actor:octocat" ``` diff --git a/translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md b/translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md index b673ea767cda..49a87dbefdb2 100644 --- a/translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md +++ b/translations/zh-CN/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise.md @@ -79,6 +79,8 @@ shortTitle: 安全设置策略 {% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %} +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.security-tab %} diff --git a/translations/zh-CN/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md b/translations/zh-CN/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md index 77c7fffea004..d3757186dbe4 100644 --- a/translations/zh-CN/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md +++ b/translations/zh-CN/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md @@ -44,7 +44,7 @@ The Migrations API is currently in a preview period, which means that the endpoi * Your access token for authentication. * A [list of the repositories](/free-pro-team@latest/rest/repos#list-organization-repositories) you want to migrate: ```shell - curl -H "Authorization: token GITHUB_ACCESS_TOKEN" \ + curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" \ -X POST \ -H "Accept: application/vnd.github+json" \ -d'{"lock_repositories":true,"repositories":["orgname/reponame", "orgname/reponame"]}' \ @@ -59,7 +59,7 @@ The Migrations API is currently in a preview period, which means that the endpoi * Your access token for authentication. * The unique `id` of the migration: ```shell - curl -H "Authorization: token GITHUB_ACCESS_TOKEN" \ + curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" \ -H "Accept: application/vnd.github+json" \ https://api.github.com/orgs/orgname/migrations/id ``` @@ -74,7 +74,7 @@ The Migrations API is currently in a preview period, which means that the endpoi * Your access token for authentication. * The unique `id` of the migration: ```shell - curl -H "Authorization: token GITHUB_ACCESS_TOKEN" \ + curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" \ -H "Accept: application/vnd.github+json" \ -L -o migration_archive.tar.gz \ https://api.github.com/orgs/orgname/migrations/id/archive @@ -84,7 +84,7 @@ The Migrations API is currently in a preview period, which means that the endpoi * Your access token for authentication. * The unique `id` of the migration: ```shell - curl -H "Authorization: token GITHUB_ACCESS_TOKEN" \ + curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" \ -X DELETE \ -H "Accept: application/vnd.github+json" \ https://api.github.com/orgs/orgname/migrations/id/archive diff --git a/translations/zh-CN/content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md b/translations/zh-CN/content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md index baeb7225df01..a3c8983c0d60 100644 --- a/translations/zh-CN/content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md +++ b/translations/zh-CN/content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md @@ -134,7 +134,7 @@ $ ghe-migrator audit -s failed_import,failed_map,failed_rename,failed_merge -g < * 迁移的唯一 `id` * 要解锁的仓库的名称 ```shell -curl -H "Authorization: token GITHUB_ACCESS_TOKEN" -X DELETE \ +curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" -X DELETE \ -H "Accept: application/vnd.github.wyandotte-preview+json" \ https://api.github.com/orgs/orgname/migrations/id/repos/repo_name/lock ``` @@ -143,7 +143,7 @@ curl -H "Authorization: token GITHUB_ACCESS_TOKEN" -X DELETE \ 在解锁 {% data variables.product.prodname_dotcom_the_website %} 组织的仓库后,您应当使用[仓库删除端点](/rest/repos/#delete-a-repository)删除之前迁移的每一个仓库。 您需要身份验证的访问令牌: ```shell -curl -H "Authorization: token GITHUB_ACCESS_TOKEN" -X DELETE \ +curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" -X DELETE \ https://api.github.com/repos/orgname/repo_name ``` diff --git a/translations/zh-CN/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md b/translations/zh-CN/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md index 7caea0a09c55..b7cf6f3f0359 100644 --- a/translations/zh-CN/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md +++ b/translations/zh-CN/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md @@ -29,11 +29,11 @@ topics: {% data reusables.command_line.open_the_multi_os_terminal %} 3. 生成 GPG 密钥对。 由于 GPG 有多个版本,因此您可能需要查询相关的[_手册页_](https://en.wikipedia.org/wiki/Man_page)以找到适当的密钥生成命令。 密钥必须使用 RSA。 - 如果您使用的是 2.1.17 或更高版本,请粘贴以下文本以生成 GPG 密钥对。 - ```shell + ```shell{:copy} $ gpg --full-generate-key ``` - 如果使用的不是 2.1.17 或更高版本,则 `gpg --full-generate-key` 命令无效。 请粘贴以下文本并跳到第 6 步。 - ```shell + ```shell{:copy} $ gpg --default-new-key-algo rsa4096 --gen-key ``` 4. 在提示时,指定要生成的密钥类型,或按 `Enter` 键接受默认值。 @@ -52,10 +52,10 @@ topics: {% data reusables.gpg.list-keys-with-note %} {% data reusables.gpg.copy-gpg-key-id %} 10. 粘贴下面的文本(替换为您要使用的 GPG 密钥 ID)。 在此例中,GPG 密钥 ID 是 `3AA5C34371567BD2`: - ```shell - $ gpg --armor --export 3AA5C34371567BD2 - # Prints the GPG key ID, in ASCII armor format - ``` + ```shell{:copy} + $ gpg --armor --export 3AA5C34371567BD2 + # Prints the GPG key ID, in ASCII armor format + ``` 11. 复制 GPG 密钥,从 `-----BEGIN PGP PUBLIC KEY BLOCK-----` 开始,到 `-----END PGP PUBLIC KEY BLOCK-----` 结束。 12. [将 GPG 密钥添加到 GitHub 帐户](/articles/adding-a-gpg-key-to-your-github-account)。 diff --git a/translations/zh-CN/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md b/translations/zh-CN/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md index 41f9cebff2f6..f951f234197a 100644 --- a/translations/zh-CN/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md +++ b/translations/zh-CN/content/billing/managing-billing-for-github-actions/about-billing-for-github-actions.md @@ -1,6 +1,7 @@ --- title: 关于 GitHub Actions 的计费 intro: '如果要对 {% data variables.product.prodname_actions %} 的使用超出帐户所含存储容量或分钟数,您需要支付额外的使用费。' +miniTocMaxHeadingLevel: 3 redirect_from: - /github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions - /github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions/about-billing-for-github-actions @@ -28,6 +29,13 @@ shortTitle: GitHub Actions 的计费 ### 包括存储和分钟数 +{% ifversion actions-hosted-runners %} +{% note %} + +**Note**: Entitlement minutes cannot be used for Windows and Ubuntu runners over 2-cores. These runners will always be charged for, including in public repos. For more information, see "[Per-minute rates for runners](/billing/managing-billing-for-github-actions/about-billing-for-github-actions#per-minute-rates)." + +{% endnote %} +{% endif %} | 产品 | 存储器 | 分钟数(每月) | | ----------------------------------------------------- | ------ | ------- | | {% data variables.product.prodname_free_user %} | 500 MB | 2,000 | @@ -58,15 +66,15 @@ shortTitle: GitHub Actions 的计费 ### 每分钟费率 -| 操作系统 | 每分钟费率(美元) | -| ------- | --------- | -| Linux | $0.008 | -| macOS | $0.08 | -| Windows | $0.016 | - -可在用户或组织帐户的所有仓库中同时运行的作业数量取决于您的 GitHub 计划。 更多信息请参阅“[使用限制和计费](/actions/reference/usage-limits-billing-and-administration)”(对于 {% data variables.product.prodname_dotcom %} 托管的运行器)和“[关于自托管运行器](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)”(对于自托管运行器使用限制)。 +{% data reusables.billing.billing-standard-runners %} +{% ifversion actions-hosted-runners %}{% data reusables.billing.billing-hosted-runners %}{% endif %} -{% data reusables.user-settings.context_switcher %} +- 可在用户或组织帐户的所有仓库中同时运行的作业数量取决于您的 GitHub 计划。 更多信息请参阅“[使用限制和计费](/actions/reference/usage-limits-billing-and-administration)”(对于 {% data variables.product.prodname_dotcom %} 托管的运行器)和“[关于自托管运行器](/actions/hosting-your-own-runners/about-self-hosted-runners/#usage-limits)”(对于自托管运行器使用限制)。 +- {% data reusables.user-settings.context_switcher %} +{% ifversion actions-hosted-runners %} +- For {% data variables.actions.hosted_runner %}s, there is no additional cost for configurations that assign public static IP addresses to a {% data variables.actions.hosted_runner %}. For more information on {% data variables.actions.hosted_runner %}s, see "[Using {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/using-larger-runners)." +- Entitlement minutes cannot be used for {% data variables.actions.hosted_runner %}s. +{% endif %} ## 计算分钟和存储支出 diff --git a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md index 89a7a591d444..693aff8c64ec 100644 --- a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md +++ b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md @@ -359,7 +359,7 @@ In the following example, the `+` symbol ensures that the specified additional { ## Using a custom configuration file -A custom configuration file is an alternative way to specify additional {% ifversion codeql-packs %}packs and {% endif %}queries to run. You can also use the file to disable the default queries and to specify which directories to scan during analysis. +A custom configuration file is an alternative way to specify additional {% ifversion codeql-packs %}packs and {% endif %}queries to run. You can also use the file to disable the default queries{% ifversion code-scanning-exclude-queries-from-analysis %}, exclude or include specific queries,{% endif %} and to specify which directories to scan during analysis. In the workflow file, use the `config-file` parameter of the `init` action to specify the path to the configuration file you want to use. This example loads the configuration file _./.github/codeql/codeql-config.yml_. @@ -442,6 +442,41 @@ Optionally, you can give each array element a name, as shown in the example conf If you only want to run custom queries, you can disable the default security queries by using `disable-default-queries: true`. +{% ifversion code-scanning-exclude-queries-from-analysis %} +### Excluding specific queries from analysis + +You can add `exclude` and `include` filters to your custom configuration file, to specify the queries you want to exclude or include in the analysis. + +This is useful if you want to exclude, for example: +- Specific queries from the default suites (`security`, `security-extended` and `security-and-quality`). +- Specific queries whose results do not interest you. +- All the queries that generate warnings and recommendations. + +You can use `exclude` filters similar to those in the configuration file below to exclude queries that you want to remove from the default analysis. In the example of configuration file below, both the `js/redundant-assignment` and the `js/useless-assignment-to-local` queries are excluded from analysis. + +```yaml +query-filters: + - exclude: + id: js/redundant-assignment + - exclude: + id: js/useless-assignment-to-local +``` +To find the id of a query, you can click the alert in the list of alerts in the Security tab. This opens the alert details page. The `Rule ID` field contains the query id. For more information about the alert details page, see "[About {% data variables.product.prodname_code_scanning %} alerts](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts#about-alert-details)." + +{% tip %} + +**Tips:** +- The order of the filters is important. The first filter instruction that appears after the instructions about the queries and query packs determines whether the queries are included or excluded by default. +- Subsequent instructions are executed in order and the instructions that appear later in the file take precedence over the earlier instructions. + +{% endtip %} + +You can find another example illustrating the use of these filters in the "[Example configuration files](#example-configuration-files)" section. + +For more information about using `exclude` and `include` filters in your custom configuration file, see "[Creating {% data variables.product.prodname_codeql %} query suites](https://codeql.github.com/docs/codeql-cli/creating-codeql-query-suites/#filtering-the-queries-in-a-query-suite)." For information on the query metadata you can filter on, see "[Metadata for CodeQL queries](https://codeql.github.com/docs/writing-codeql-queries/metadata-for-codeql-queries/)." + +{% endif %} + ### Specifying directories to scan For the interpreted languages that {% data variables.product.prodname_codeql %} supports (Python{% ifversion fpt or ghes > 3.3 or ghae-issue-5017 %}, Ruby{% endif %} and JavaScript/TypeScript), you can restrict {% data variables.product.prodname_code_scanning %} to files in specific directories by adding a `paths` array to the configuration file. You can exclude the files in specific directories from analysis by adding a `paths-ignore` array. diff --git a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md index a5948aba46cb..23e20a25a332 100644 --- a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md +++ b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository.md @@ -43,8 +43,8 @@ By default, the code scanning alerts page is filtered to show alerts for the def ![Summary of alerts](/assets/images/help/repository/code-scanning-click-alert.png) {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %} - {% data reusables.code-scanning.alert-default-branch %} - ![The "Affected branches" section in an alert](/assets/images/help/repository/code-scanning-affected-branches.png){% endif %} + {% data reusables.code-scanning.alert-default-branch %} + ![The "Affected branches" section in an alert](/assets/images/help/repository/code-scanning-affected-branches.png){% endif %} 1. Optionally, if the alert highlights a problem with data flow, click **Show paths** to display the path from the data source to the sink where it's used. {% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-6249 %} ![The "Show paths" link on an alert](/assets/images/help/repository/code-scanning-show-paths.png) diff --git a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md index 52e0b98fd34f..32cea9db26fa 100644 --- a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md +++ b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository.md @@ -151,25 +151,29 @@ The names of the {% data variables.product.prodname_code_scanning %} analysis ch ![{% data variables.product.prodname_code_scanning %} pull request checks](/assets/images/help/repository/code-scanning-pr-checks.png) -When the {% data variables.product.prodname_code_scanning %} jobs complete, {% data variables.product.prodname_dotcom %} works out whether any alerts were added by the pull request and adds the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" entry to the list of checks. After {% data variables.product.prodname_code_scanning %} has been performed at least once, you can click **Details** to view the results of the analysis. If you used a pull request to add {% data variables.product.prodname_code_scanning %} to the repository, you will initially see {% ifversion fpt or ghes > 3.2 or ghae or ghec %}an "Analysis not found"{% else %}a "Missing analysis"{% endif %} message when you click **Details** on the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" check. +When the {% data variables.product.prodname_code_scanning %} jobs complete, {% data variables.product.prodname_dotcom %} works out whether any alerts were added by the pull request and adds the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" entry to the list of checks. After {% data variables.product.prodname_code_scanning %} has been performed at least once, you can click **Details** to view the results of the analysis. -{% ifversion fpt or ghes > 3.2 or ghae or ghec %} - ![Analysis not found for commit message](/assets/images/help/repository/code-scanning-analysis-not-found.png) +{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-7095 %} + +{% elsif ghes < 3.5 or ghae %} +If you used a pull request to add {% data variables.product.prodname_code_scanning %} to the repository, you will initially see {% ifversion ghes > 3.2 or ghae %}an "Analysis not found"{% elsif ghes = 3.2 %}a "Missing analysis"{% endif %} message when you click **Details** on the "{% data variables.product.prodname_code_scanning_capc %} results / TOOL NAME" check. + +{% ifversion ghes > 3.2 or ghae %} + ![Analysis not found for commit message](/assets/images/enterprise/3.4/repository/code-scanning-analysis-not-found.png) The table lists one or more categories. Each category relates to specific analyses, for the same tool and commit, performed on a different language or a different part of the code. For each category, the table shows the two analyses that {% data variables.product.prodname_code_scanning %} attempted to compare to determine which alerts were introduced or fixed in the pull request. For example, in the screenshot above, {% data variables.product.prodname_code_scanning %} found an analysis for the merge commit of the pull request, but no analysis for the head of the main branch. -{% else %} - ![Missing analysis for commit message](/assets/images/enterprise/3.2/repository/code-scanning-missing-analysis.png) -{% endif %} -{% ifversion fpt or ghes > 3.2 or ghae or ghec %} ### Reasons for the "Analysis not found" message -{% else %} + +{% elsif ghes = 3.2 %} + ![Missing analysis for commit message](/assets/images/enterprise/3.2/repository/code-scanning-missing-analysis.png) + ### Reasons for the "Missing analysis" message {% endif %} -After {% data variables.product.prodname_code_scanning %} has analyzed the code in a pull request, it needs to compare the analysis of the topic branch (the branch you used to create the pull request) with the analysis of the base branch (the branch into which you want to merge the pull request). This allows {% data variables.product.prodname_code_scanning %} to compute which alerts are newly introduced by the pull request, which alerts were already present in the base branch, and whether any existing alerts are fixed by the changes in the pull request. Initially, if you use a pull request to add {% data variables.product.prodname_code_scanning %} to a repository, the base branch has not yet been analyzed, so it's not possible to compute these details. In this case, when you click through from the results check on the pull request you will see the {% ifversion fpt or ghes > 3.2 or ghae or ghec %}"Analysis not found"{% else %}"Missing analysis for base commit SHA-HASH"{% endif %} message. +After {% data variables.product.prodname_code_scanning %} has analyzed the code in a pull request, it needs to compare the analysis of the topic branch (the branch you used to create the pull request) with the analysis of the base branch (the branch into which you want to merge the pull request). This allows {% data variables.product.prodname_code_scanning %} to compute which alerts are newly introduced by the pull request, which alerts were already present in the base branch, and whether any existing alerts are fixed by the changes in the pull request. Initially, if you use a pull request to add {% data variables.product.prodname_code_scanning %} to a repository, the base branch has not yet been analyzed, so it's not possible to compute these details. In this case, when you click through from the results check on the pull request you will see the {% ifversion ghes > 3.2 or ghae %}"Analysis not found"{% elsif ghes = 3.2 %}"Missing analysis for base commit SHA-HASH"{% endif %} message. There are other situations where there may be no analysis for the latest commit to the base branch for a pull request. These include: @@ -177,7 +181,7 @@ There are other situations where there may be no analysis for the latest commit To check whether a branch has been scanned, go to the {% data variables.product.prodname_code_scanning_capc %} page, click the **Branch** drop-down and select the relevant branch. -![Choose a branch from the Branch drop-down menu](/assets/images/help/repository/code-scanning-branch-dropdown.png) + ![Choose a branch from the Branch drop-down menu](/assets/images/help/repository/code-scanning-branch-dropdown.png) The solution in this situation is to add the name of the base branch to the `on:push` and `on:pull_request` specification in the {% data variables.product.prodname_code_scanning %} workflow on that branch and then make a change that updates the open pull request that you want to scan. @@ -189,6 +193,8 @@ There are other situations where there may be no analysis for the latest commit Merge a trivial change into the base branch to trigger {% data variables.product.prodname_code_scanning %} on this latest commit, then push a change to the pull request to retrigger {% data variables.product.prodname_code_scanning %}. +{% endif %} + ## Next steps After setting up {% data variables.product.prodname_code_scanning %}, and allowing its actions to complete, you can: diff --git a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md index ffde7428bc4b..8c803f3cc9f6 100644 --- a/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md +++ b/translations/zh-CN/content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests.md @@ -33,8 +33,6 @@ topics: - 拉取请求的 **Conversation(对话)** 选项卡,作为拉取请求审查的一部分{% endif %} - 拉取请求的 **Files changed(文件已更改)**选项卡 -{% ifversion code-scanning-pr-conversations-tab %} {% endif %} - 如果您拥有仓库的写入权限,您可以在 **Security(安全)**选项卡中查看任何现有的 {% data variables.product.prodname_code_scanning %} 警报。 有关仓库警报的更多信息,请参阅“[管理仓库的 {% data variables.product.prodname_code_scanning %} 警报](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository)”。 {% ifversion fpt or ghes > 3.2 or ghae or ghec %} diff --git a/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md b/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md index daeb17e4833c..74df7049d25c 100644 --- a/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md +++ b/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md @@ -45,9 +45,15 @@ If you upload a second SARIF file for a commit with the same category and from t If you're new to SARIF and want to learn more, see Microsoft's [`SARIF tutorials`](https://github.com/microsoft/sarif-tutorials) repository. -## Preventing duplicate alerts using fingerprints +## Providing data to track {% data variables.product.prodname_code_scanning %} alerts across runs -Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the right line of code when files are edited. +Each time the results of a new code scan are uploaded, the results are processed and alerts are added to the repository. To prevent duplicate alerts for the same problem, {% data variables.product.prodname_code_scanning %} uses fingerprints to match results across various runs so they only appear once in the latest run for the selected branch. This makes it possible to match alerts to the correct line of code when files are edited. The `ruleID` for a result has to be the same across analysis. + +### Reporting consistent filepaths + +The filepath has to be consistent across the runs to enable a computation of a stable fingerprint. If the filepaths differ for the same result, each time there is a new analysis a new alert will be created, and the old one will be closed. This will cause having multiple alerts for the same result. + +### Including data for fingerprint generation {% data variables.product.prodname_dotcom %} uses the `partialFingerprints` property in the OASIS standard to detect when two results are logically identical. For more information, see the "[partialFingerprints property](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012611)" entry in the OASIS documentation. @@ -77,6 +83,12 @@ You can check a SARIF file is compatible with {% data variables.product.prodname If you use a code analysis engine other than {% data variables.product.prodname_codeql %}, you can review the supported SARIF properties to optimize how your analysis results will appear on {% data variables.product.prodname_dotcom %}. +{% note %} + +**Note:** You must supply an explicit value for any property marked as "required". The empty string is not supported for required properties. + +{% endnote %} + Any valid SARIF 2.1.0 output file can be uploaded, however, {% data variables.product.prodname_code_scanning %} will only use the following supported properties. ### `sarifLog` object @@ -138,7 +150,7 @@ Each `result` object contains details for one alert in the codebase. Within the | `level`| **Optional.** The severity of the result. This level overrides the default severity defined by the rule. {% data variables.product.prodname_code_scanning_capc %} uses the level to filter results by severity on {% data variables.product.prodname_dotcom %}. | `message.text`| **Required.** A message that describes the result. {% data variables.product.prodname_code_scanning_capc %} displays the message text as the title of the result. Only the first sentence of the message will be displayed when visible space is limited. | `locations[]`| **Required.** The set of locations where the result was detected up to a maximum of 10. Only one location should be included unless the problem can only be corrected by making a change at every specified location. **Note:** At least one location is required for {% data variables.product.prodname_code_scanning %} to display a result. {% data variables.product.prodname_code_scanning_capc %} will use this property to decide which file to annotate with the result. Only the first value of this array is used. All other values are ignored. -| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Preventing duplicate alerts using fingerprints](#preventing-duplicate-alerts-using-fingerprints)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. +| `partialFingerprints`| **Required.** A set of strings used to track the unique identity of the result. {% data variables.product.prodname_code_scanning_capc %} uses `partialFingerprints` to accurately identify which results are the same across commits and branches. {% data variables.product.prodname_code_scanning_capc %} will attempt to use `partialFingerprints` if they exist. If you are uploading third-party SARIF files with the `upload-action`, the action will create `partialFingerprints` for you when they are not included in the SARIF file. For more information, see "[Providing data to track code scanning alerts across runs](#providing-data-to-track-code-scanning-alerts-across-runs)." **Note:** {% data variables.product.prodname_code_scanning_capc %} only uses the `primaryLocationLineHash`. | `codeFlows[].threadFlows[].locations[]`| **Optional.** An array of `location` objects for a `threadFlow` object, which describes the progress of a program through a thread of execution. A `codeFlow` object describes a pattern of code execution used to detect a result. If code flows are provided, {% data variables.product.prodname_code_scanning %} will expand code flows on {% data variables.product.prodname_dotcom %} for the relevant result. For more information, see the [`location` object](#location-object). | `relatedLocations[]`| A set of locations relevant to this result. {% data variables.product.prodname_code_scanning_capc %} will link to related locations when they are embedded in the result message. For more information, see the [`location` object](#location-object). @@ -204,7 +216,7 @@ These example SARIF output files show supported properties and example values. ### Example with minimum required properties -This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties or don't include values, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. +This SARIF output file has example values to show the minimum required properties for {% data variables.product.prodname_code_scanning %} results to work as expected. If you remove any properties, omit values, or use an empty string, this data will not be displayed correctly or sync on {% data variables.product.prodname_dotcom %}. ```json { diff --git a/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md b/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md index 1e03a239f38e..193ee54f5aa9 100644 --- a/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md +++ b/translations/zh-CN/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md @@ -58,7 +58,7 @@ For more information see the [`upload-sarif` action](https://github.com/github/c The `upload-sarif` action can be configured to run when the `push` and `scheduled` event occur. For more information about {% data variables.product.prodname_actions %} events, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." -If your SARIF file doesn't include `partialFingerprints`, the `upload-sarif` action will calculate the `partialFingerprints` field for you and attempt to prevent duplicate alerts. {% data variables.product.prodname_dotcom %} can only create `partialFingerprints` when the repository contains both the SARIF file and the source code used in the static analysis. For more information about preventing duplicate alerts, see "[About SARIF support for code scanning](/code-security/secure-coding/sarif-support-for-code-scanning#preventing-duplicate-alerts-using-fingerprints)." +If your SARIF file doesn't include `partialFingerprints`, the `upload-sarif` action will calculate the `partialFingerprints` field for you and attempt to prevent duplicate alerts. {% data variables.product.prodname_dotcom %} can only create `partialFingerprints` when the repository contains both the SARIF file and the source code used in the static analysis. For more information about preventing duplicate alerts, see "[About SARIF support for code scanning](/code-security/secure-coding/sarif-support-for-code-scanning#providing-data-to-track-code-scanning-alerts-across-runs)." {% data reusables.code-scanning.upload-sarif-alert-limit %} diff --git a/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md b/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md index 54ca86d3afa0..a9c8d47e23ff 100644 --- a/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md +++ b/translations/zh-CN/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md @@ -78,7 +78,8 @@ You can display the command-line help for any command using the `--help``--command` | | Recommended. Use to specify the build command or script that invokes the build process for the codebase. Commands are run from the current folder or, where it is defined, from `--source-root`. Not needed for Python and JavaScript/TypeScript analysis. | | `--db-cluster` | | Optional. Use in multi-language codebases to generate one database for each language specified by `--language`. | `--no-run-unnecessary-builds` | | Recommended. Use to suppress the build command for languages where the {% data variables.product.prodname_codeql_cli %} does not need to monitor the build (for example, Python and JavaScript/TypeScript). -| `--source-root` | | Optional. Use if you run the CLI outside the checkout root of the repository. By default, the `database create` command assumes that the current directory is the root directory for the source files, use this option to specify a different location. | +| `--source-root` | | Optional. Use if you run the CLI outside the checkout root of the repository. By default, the `database create` command assumes that the current directory is the root directory for the source files, use this option to specify a different location. |{% ifversion fpt or ghec or ghes > 3.2 or ghae %} +| `--codescanning-config` | | Optional (Advanced). Use if you have a configuration file that specifies how to create the {% data variables.product.prodname_codeql %} databases and what queries to run in later steps. For more information, see "[Using a custom configuration file](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-a-custom-configuration-file)" and "[database create](https://codeql.github.com/docs/codeql-cli/manual/database-create/#cmdoption-codeql-database-create-codescanning-config)." |{% endif %} For more information, see [Creating {% data variables.product.prodname_codeql %} databases](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/) in the documentation for the {% data variables.product.prodname_codeql_cli %}. diff --git a/translations/zh-CN/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md b/translations/zh-CN/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md index 25ac6542b667..b99c74265b70 100644 --- a/translations/zh-CN/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md +++ b/translations/zh-CN/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md @@ -416,7 +416,7 @@ updates: ### `open-pull-requests-limit` -默认情况下, {% data variables.product.prodname_dependabot %} 最多打开五个版本更新的拉取请求。 一旦有五个打开的拉取请求,新的请求将被阻止,直到您合并或关闭一些打开的请求,之后可以在后续更新中打开新的拉取请求。 使用 `open-pull-requests-limit` 可更改此限制。 这也提供了一个简单的方法来暂时禁用包管理器的版本更新。 +默认情况下, {% data variables.product.prodname_dependabot %} 最多打开五个版本更新的拉取请求。 Once there are five open pull requests from {% data variables.product.prodname_dependabot %}, {% data variables.product.prodname_dependabot %} will not open any new requests until some of those open requests are merged or closed. 使用 `open-pull-requests-limit` 可更改此限制。 这也提供了一个简单的方法来暂时禁用包管理器的版本更新。 此选项对安全更新没有影响,因为安全更新具有单独的内部限制:10 个打开的拉取请求。 diff --git a/translations/zh-CN/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review.md b/translations/zh-CN/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review.md index 0fb2c150c677..10c794f29423 100644 --- a/translations/zh-CN/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review.md +++ b/translations/zh-CN/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review.md @@ -72,7 +72,7 @@ topics: {% endtip %} {% endif %} -此 {% data variables.product.prodname_dependency_review_action %} 示例文件说明了如何使用这些配置选项。 +此 {% data variables.product.prodname_dependency_review_action %} 示例文件说明了如何使用这些配置选项。 Notice that the example uses short version number for the action (`v2`) instead of a semver release number (for example, `v2.0.8`). This ensures that you use the most recent minor version of the action. ```yaml{:copy} name: 'Dependency Review' diff --git a/translations/zh-CN/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md b/translations/zh-CN/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md index a5ab209231e0..c9a6991945c7 100644 --- a/translations/zh-CN/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md +++ b/translations/zh-CN/content/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry.md @@ -12,25 +12,25 @@ shortTitle: 私有映像注册表 ## 关于私人映像注册表和 {% data variables.product.prodname_github_codespaces %} -注册表是用于存储、管理和提取专用容器映像的安全空间。 您可以使用一个来存储一个或多个映像。 注册表的示例很多,例如 {% data variables.product.prodname_dotcom %} 容器注册表、Azure 容器注册表或 DockerHub。 +注册表是用于存储、管理和提取专用容器映像的安全空间。 您可以使用一个来存储一个或多个映像。 There are many examples of registries, such as {% data variables.product.prodname_container_registry %}, {% data variables.product.prodname_npm_registry %}, Azure Container Registry, or DockerHub. -{% data variables.product.prodname_dotcom %} 容器注册表可以配置为无缝拉取容器映像,而无需向 {% data variables.product.prodname_github_codespaces %} 提供任何身份验证凭据。 对于其他映像注册表,必须在 {% data variables.product.prodname_dotcom %} 中创建机密以存储访问详细信息,这将允许 {% data variables.product.prodname_codespaces %} 访问存储在该注册表中的映像。 +{% data variables.product.prodname_ghcr_and_npm_registry %} can be configured to allow container images to be pulled seamlessly into {% data variables.product.prodname_github_codespaces %} during codespace creation, without having to provide any authentication credentials. 对于其他映像注册表,必须在 {% data variables.product.prodname_dotcom %} 中创建机密以存储访问详细信息,这将允许 {% data variables.product.prodname_codespaces %} 访问存储在该注册表中的映像。 -## 访问存储在 {% data variables.product.prodname_dotcom %} 容器注册表中的映像 +## Accessing images stored in {% data variables.product.prodname_ghcr_and_npm_registry %} -{% data variables.product.prodname_dotcom %} 容器注册表是 {% data variables.product.prodname_codespaces %} 使用 devcontainer 容器映像的最简单方法。 +{% data variables.product.prodname_ghcr_and_npm_registry %} provide the easiest way for {% data variables.product.prodname_codespaces %} to consume dev container images. -更多信息请参阅“[使用容器注册表](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)”。 +For more information, see "[Working with the Container registry](/packages/working-with-a-github-packages-registry/working-with-the-container-registry)" and "[Working with the npm registry](/packages/working-with-a-github-packages-registry/working-with-the-npm-registry)". ### 访问发布到与代码空间相同的仓库的映像 -如果将容器映像发布到启动代码空间的同一仓库中的 {% data variables.product.prodname_dotcom %} 容器注册表,则在创建代码空间时将自动能够获取该映像。 无需提供任何其他凭据,除非在发布容器映像时未选中 **Inherit access from repo(从仓库继承访问权限)**选项。 +If you publish a container image to {% data variables.product.prodname_ghcr_or_npm_registry %} in the same repository that the codespace is being launched in, you will automatically be able to fetch that image on codespace creation. 无需提供任何其他凭据,除非在发布容器映像时未选中 **Inherit access from repo(从仓库继承访问权限)**选项。 #### 从发布映像的仓库继承访问权限 -默认情况下,将容器映像发布到 {% data variables.product.prodname_dotcom %} 容器注册表时,该映像将继承从中发布映像的仓库的访问设置。 例如,如果仓库是公共的,则映像也是公共的。 如果仓库是私有的,则映像也是私有的,但可以从仓库访问。 +By default, when you publish a container image to {% data variables.product.prodname_ghcr_or_npm_registry %}, the image inherits the access setting of the repository from which the image was published. 例如,如果仓库是公共的,则映像也是公共的。 如果仓库是私有的,则映像也是私有的,但可以从仓库访问。 -此行为由 **Inherit access from repo(从仓库继承访问权限)**选项控制。 **通过** {% data variables.product.prodname_actions %} 发布时,默认情况下会选择从仓库继承访问权限,但在使用个人访问令牌 (PAT) 直接发布到 {% data variables.product.prodname_dotcom %} 容器注册表时,不会选择从仓库继承访问权限。 +此行为由 **Inherit access from repo(从仓库继承访问权限)**选项控制。 **Inherit access from repo** is selected by default when publishing via {% data variables.product.prodname_actions %}, but not when publishing directly to {% data variables.product.prodname_ghcr_or_npm_registry %} using a Personal Access Token (PAT). 如果在发布映像时未选择 **Inherit access from repo(从仓库继承访问权限)**选项,则可以手动将仓库添加到已发布容器映像的访问控制中。 更多信息请参阅“[配置包的访问控制和可见性](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#inheriting-access-for-a-container-image-from-a-repository)”。 @@ -46,13 +46,13 @@ shortTitle: 私有映像注册表 ### 从代码空间发布容器映像 -从代码空间到容器注册表 {% data variables.product.prodname_dotcom %} 的无缝访问仅限于拉取容器映像。 如果要从代码空间内部发布容器映像,则必须结合使用个人访问令牌 (PAT) 与 `write:packages` 作用域。 +Seamless access from a codespace to {% data variables.product.prodname_ghcr_or_npm_registry %} is limited to pulling container images. 如果要从代码空间内部发布容器映像,则必须结合使用个人访问令牌 (PAT) 与 `write:packages` 作用域。 -我们建议通过 {% data variables.product.prodname_actions %} 发布映像。 更多信息请参阅“[发布 Docker 映像](/actions/publishing-packages/publishing-docker-images)”。 +我们建议通过 {% data variables.product.prodname_actions %} 发布映像。 For more information, see "[Publishing Docker images](/actions/publishing-packages/publishing-docker-images)" and "[Publishing Node.js packages](/actions/publishing-packages/publishing-nodejs-packages)." ## 访问存储在其他容器注册表中的映像 -如果要从不是 {% data variables.product.prodname_dotcom %} 容器注册表的注册表访问容器映像,{% data variables.product.prodname_codespaces %} 将检查是否存在三个机密,这些机密定义了容器注册表的服务器名称、用户名和个人访问令牌 (PAT)。 如果找到这些密钥,{% data variables.product.prodname_github_codespaces %} 将在代码空间中提供注册表。 +If you are accessing a container image from a registry that isn't {% data variables.product.prodname_ghcr_or_npm_registry %}, {% data variables.product.prodname_codespaces %} checks for the presence of three secrets, which define the server name, username, and personal access token (PAT) for a container registry. 如果找到这些密钥,{% data variables.product.prodname_github_codespaces %} 将在代码空间中提供注册表。 - `<*>_CONTAINER_REGISTRY_SERVER` - `<*>_CONTAINER_REGISTRY_USER` diff --git a/translations/zh-CN/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md b/translations/zh-CN/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md index a824b7760076..a9ad5628ef7a 100644 --- a/translations/zh-CN/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md +++ b/translations/zh-CN/content/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces.md @@ -17,7 +17,7 @@ redirect_from: ## 关于 {% data variables.product.prodname_vscode_command_palette %} -命令面板是 {% data variables.product.prodname_vscode %} 的焦点功能之一,可用于 {% data variables.product.prodname_github_codespaces %}。 {% data variables.product.prodname_vscode_command_palette %} 允许您访问 {% data variables.product.prodname_codespaces %} 和 {% data variables.product.prodname_vscode_shortname %} 的许多命令。 有关使用 {% data variables.product.prodname_vscode_command_palette_shortname %} 的更多信息,请参阅 {% data variables.product.prodname_vscode_shortname %} 文档中的[用户界面](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette)。 +命令面板是 {% data variables.product.prodname_vscode %} 的焦点功能之一,可用于 {% data variables.product.prodname_github_codespaces %}。 命令调色板允许您访问 {% data variables.product.prodname_codespaces %} 和 {% data variables.product.prodname_vscode_shortname %} 的许多命令。 有关使用 {% data variables.product.prodname_vscode_command_palette_shortname %} 的更多信息,请参阅 {% data variables.product.prodname_vscode_shortname %} 文档中的[用户界面](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette)。 ## 访问 {% data variables.product.prodname_vscode_command_palette_shortname %} diff --git a/translations/zh-CN/content/codespaces/developing-in-codespaces/getting-started-with-github-codespaces-for-machine-learning.md b/translations/zh-CN/content/codespaces/developing-in-codespaces/getting-started-with-github-codespaces-for-machine-learning.md new file mode 100644 index 000000000000..cb601c4d9dfe --- /dev/null +++ b/translations/zh-CN/content/codespaces/developing-in-codespaces/getting-started-with-github-codespaces-for-machine-learning.md @@ -0,0 +1,120 @@ +--- +title: Getting started with GitHub Codespaces for machine learning +shortTitle: Machine learning +intro: 'Learn about working on machine learning projects with {% data variables.product.prodname_github_codespaces %} and its out-of-the-box tools.' +product: '{% data reusables.gated-features.codespaces %}' +versions: + fpt: '*' + ghec: '*' +type: tutorial +topics: + - Codespaces + - Developer +--- + +## 简介 + +This guide introduces you to machine learning with {% data variables.product.prodname_github_codespaces %}. You’ll build a simple image classifier, learn about some of the tools that come preinstalled in {% data variables.product.prodname_github_codespaces %}, configure your development environment for NVIDIA CUDA, and use {% data variables.product.prodname_cli %} to open your codespace in JupyterLab. + +## Prerequisite + +You have access to {% data variables.product.prodname_github_codespaces %}. 更多信息请参阅“[创建代码空间](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-github-codespaces)”。 + +## Build a simple image classifier + +We'll use a Jupyter notebook to build a simple image classifier. + +Jupyter notebooks are sets of cells that you can execute one after another. The notebook we'll use includes a number of cells that build an image classifier using [PyTorch](https://pytorch.org/). Each cell is a different phase of that process: download a dataset, set up a neural network, train a model, and then test that model. + +We'll run all of the cells, in sequence, to perform all phases of building the image classifier. When we do this Jupyter saves the output back into the notebook so that you can examine the results. + +### Creating a repository and a codespace + +1. Go to the [github/codespaces-getting-started-ml](https://github.com/github/codespaces-getting-started-ml) template repository and click **Use this template**. +{% data reusables.codespaces.open-codespace-from-template-repo %} + + By default, a codespace for this repository opens in a web-based version of {% data variables.product.prodname_vscode %}. + +### Open the image classifier notebook + +The default container image that's used by {% data variables.product.prodname_github_codespaces %} includes a set of machine learning libraries that are preinstalled in your codespace. For example, Numpy, pandas, SciPy, Matplotlib, seaborn, scikit-learn, TensorFlow, Keras, PyTorch, Requests, and Plotly. For more information about the default image, see "[Introduction to dev containers](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers#using-the-default-dev-container-configuration)" and [the `devcontainers/images` repository](https://github.com/devcontainers/images/tree/main/src/codespaces#github-codespaces-default-linux-universal). + +1. In the {% data variables.product.prodname_vscode_shortname %} editor, close any "Get Started" tabs that are displayed. +1. Open the `image-classifier.ipynb` notebook file. +1. Click the Python kernel link at the top right of the editor. + + ![Screenshot of the Python kernal link](/assets/images/help/codespaces/jupyter-python-kernel-link.png) + +1. In the drop-down menu, choose the kernel in the directory `/opt/python/latest/bin/python`. + + ![Screenshot of the Python kernal drop-down menu](/assets/images/help/codespaces/jupyter-python-kernel-dropdown.png) + +### Build the image classifier + +The image classifier notebook contains all the code you need to download a dataset, train a neural network, and evaluate its performance. + +1. Click **Run All** to execute all of the notebook’s cells. + + ![Screenshot of the Run All button](/assets/images/help/codespaces/jupyter-run-all.png) + +1. Scroll down to view the output of each cell. + + ![Screenshot of Step 3 in the editor](/assets/images/help/codespaces/jupyter-notebook-step3.png) + +## Configure NVIDIA CUDA for your codespace + +Some software, such as TensorFlow, requires you to install NVIDIA CUDA to use your codespace’s GPU. Where this is the case, you can create your own custom configuration, by using a `devcontainer.json` file, and specify that CUDA should be installed. For more information on creating a custom configuration, see "[Introduction to dev containers](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers#creating-a-custom-dev-container-configuration)." + +{% note %} + +**Note**: For full details of the script that's run when you add the `nvidia-cuda` feature, see [the devcontainers/features repository](https://github.com/devcontainers/features/tree/main/src/nvidia-cuda). + +{% endnote %} + +1. Within a codespace, open the `.devcontainer/devcontainer.json` file in the editor. +1. Add a top-level `features` object with the following contents: + + ```json{:copy} + “features”: { + "ghcr.io/devcontainers/features/nvidia-cuda:1": { + "installCudnn": true + } + } + ``` + + For more information about the `features` object, see the [development containers specification](https://containers.dev/implementors/features/#devcontainer-json-properties). + + If you are using the `devcontainer.json` file from the image classifier repository you created for this tutorial, your `devcontainer.json` file will now look like this: + + ``` + { + "customizations": { + "vscode": { + "extensions": [ + "ms-python.python", + "ms-toolsai.jupyter" + ] + } + }, + “features”: { + "ghcr.io/devcontainers/features/nvidia-cuda:1": { + "installCudnn": true + } + } + } + ``` + +1. Save the change. +{% data reusables.codespaces.rebuild-command %} + The codespace container will be rebuilt. This will take several minutes. When the rebuild is complete the codespace is automatically reopened. +1. Commit the change to the repository so that CUDA will be installed in any new codespaces you create from this repository in future. + +## Open your codespace in JupyterLab + +The default container image that's used by {% data variables.product.prodname_github_codespaces %} includes JupyterLab, the web-based Jupyter IDE. You can use {% data variables.product.prodname_cli %} to open your codespace in JupyterLab without having to install anything else on your codespace. + +1. In the terminal, enter the {% data variables.product.prodname_cli %} command `gh cs jupyter`. +1. Choose the codespace you want to open. + + ![Screenshot of opening a codespace from the terminal](/assets/images/help/codespaces/open-codespace-in-jupyter.png) + diff --git a/translations/zh-CN/content/codespaces/developing-in-codespaces/index.md b/translations/zh-CN/content/codespaces/developing-in-codespaces/index.md index d6a331fdbd47..07c43accbf0b 100644 --- a/translations/zh-CN/content/codespaces/developing-in-codespaces/index.md +++ b/translations/zh-CN/content/codespaces/developing-in-codespaces/index.md @@ -18,6 +18,7 @@ children: - /forwarding-ports-in-your-codespace - /default-environment-variables-for-your-codespace - /connecting-to-a-private-network + - /getting-started-with-github-codespaces-for-machine-learning - /using-github-codespaces-in-visual-studio-code - /using-github-codespaces-with-github-cli --- diff --git a/translations/zh-CN/content/codespaces/getting-started/deep-dive.md b/translations/zh-CN/content/codespaces/getting-started/deep-dive.md index e6c2ba90068f..685ff9360a45 100644 --- a/translations/zh-CN/content/codespaces/getting-started/deep-dive.md +++ b/translations/zh-CN/content/codespaces/getting-started/deep-dive.md @@ -73,7 +73,7 @@ topics: ### 关闭或停止代码空间 -要停止代码空间,您可以 [使用 {% data variables.product.prodname_vscode_command_palette %}](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces#suspending-or-stopping-a-codespace) (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows))。 如果在未运行停止命令的情况下退出代码空间(例如,关闭浏览器选项卡),或者让代码空间在没有交互的情况下运行,则代码空间及其正在运行的进程将继续运行,直到出现不活动窗口,之后代码空间将停止。 默认情况下,不活动窗口为 30 分钟。 +To stop your codespace you can [use the {% data variables.product.prodname_vscode_command_palette %}](/codespaces/codespaces-reference/using-the-vs-code-command-palette-in-codespaces#suspending-or-stopping-a-codespace) (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)). 如果在未运行停止命令的情况下退出代码空间(例如,关闭浏览器选项卡),或者让代码空间在没有交互的情况下运行,则代码空间及其正在运行的进程将继续运行,直到出现不活动窗口,之后代码空间将停止。 默认情况下,不活动窗口为 30 分钟。 关闭或停止代码空间时,将保留所有未提交的更改,直到您再次连接到代码空间。 diff --git a/translations/zh-CN/content/codespaces/getting-started/quickstart.md b/translations/zh-CN/content/codespaces/getting-started/quickstart.md index 40de312ef3f8..adc7543b50ae 100644 --- a/translations/zh-CN/content/codespaces/getting-started/quickstart.md +++ b/translations/zh-CN/content/codespaces/getting-started/quickstart.md @@ -25,12 +25,7 @@ From this quickstart, you'll learn how to create a codespace, connect to a forwa ## 创建代码空间 1. 导航到 [template repository(模板存储库)](https://github.com/github/haikus-for-codespaces) 并选择 **Use this template(使用此模板)**。 - -1. Choose an owner for the new repository, enter a repository name, select your preferred privacy setting, and click **Create repository from template**. - -1. 导航到新创建的存储库的主页。 在存储库名称下,使用 **{% octicon "code" aria-label="The code icon" %} 代码**下拉菜单,然后在**Codespaces(代码空间)**选项卡中,单击 **Create codespace on main(在主分支上创建代码空间)**。 - - ![新建代码空间按钮](/assets/images/help/codespaces/new-codespace-button.png) +{% data reusables.codespaces.open-codespace-from-template-repo %} ## 运行应用程序 diff --git a/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md b/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md index 485b1341ab5b..c68bb1876da1 100644 --- a/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md +++ b/translations/zh-CN/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md @@ -155,9 +155,9 @@ RUN apt-get update && bash /tmp/library-scripts/github-debian.sh 您可以通过在配置预定义容器时选择一些最常用的功能来添加这些功能。 有关可用功能的详细信息,请参阅 `vscode-dev-containers` 存储库中的[脚本库](https://github.com/microsoft/vscode-dev-containers/tree/main/script-library#scripts) 。 -1. 访问命令面板 (`Shift + Command + P` / `Ctrl + Shift + P`),然后开始键入 "configure"。 选择 **Codespaces: Configure Devcontainer Features(代码空间:配置开发容器功能)**。 +1. Access the Command Palette (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)), then start typing "configure". 选择 **Codespaces: Configure Devcontainer Features(代码空间:配置开发容器功能)**。 - ![命令面板中的 Configure Devcontainer Features 命令](/assets/images/help/codespaces/codespaces-configure-features.png) + ![The Configure Devcontainer Features command in the Command Palette](/assets/images/help/codespaces/codespaces-configure-features.png) 1. 更新您的功能选择,然后单击**确定**。 @@ -165,7 +165,7 @@ RUN apt-get update && bash /tmp/library-scripts/github-debian.sh 1. 要应用更改,请在屏幕右下角单击 **Rebuild now(立即重建)**。 有关重建容器的更多信息,请参阅“[应用对配置的更改](#applying-configuration-changes-to-a-codespace)”。 - ![命令面板中的"Codespaces:重建容器"](/assets/images/help/codespaces/rebuild-prompt.png) + !["Codespaces: Rebuild Container" in the Command Palette](/assets/images/help/codespaces/rebuild-prompt.png) ## 创建自定义开发容器配置 diff --git a/translations/zh-CN/content/codespaces/troubleshooting/github-codespaces-logs.md b/translations/zh-CN/content/codespaces/troubleshooting/github-codespaces-logs.md index 788b32e4ca12..abe4aee2e9ef 100644 --- a/translations/zh-CN/content/codespaces/troubleshooting/github-codespaces-logs.md +++ b/translations/zh-CN/content/codespaces/troubleshooting/github-codespaces-logs.md @@ -28,7 +28,7 @@ redirect_from: {% webui %} 1. 如果在浏览器中使用 {% data variables.product.prodname_codespaces %} ,请确保已连接到要调试的代码空间。 -1. 打开 {% data variables.product.prodname_vscode %} 命令面板 (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) ,然后键入 **Export logs**。 从列表中选择 **odespaces: Export Logs(代码空间:导出日志)**以下载日志。 +1. Open the {% data variables.product.prodname_vscode_command_palette_shortname %} (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)) and type **Export logs**. 从列表中选择 **odespaces: Export Logs(代码空间:导出日志)**以下载日志。 1. 定义保存日志 zip 存档的位置,然后单击 **Save(保存)**(桌面),或单击 **OK(确定)** (web)。 1. 如果在浏览器中使用 {% data variables.product.prodname_codespaces %} ,请右键单击资源管理器视图中日志的 zip 存档,然后选择 **Download…(下载…)**将其下载到本地计算机。 @@ -36,7 +36,7 @@ redirect_from: {% vscode %} -1. 打开 {% data variables.product.prodname_vscode %} 命令面板 (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) ,然后键入 **Export logs**。 从列表中选择 **odespaces: Export Logs(代码空间:导出日志)**以下载日志。 +1. Open the {% data variables.product.prodname_vscode_command_palette_shortname %} (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)) and type **Export logs**. 从列表中选择 **odespaces: Export Logs(代码空间:导出日志)**以下载日志。 1. 定义保存日志 zip 存档的位置,然后单击 **Save(保存)**(桌面),或单击 **OK(确定)** (web)。 {% endvscode %} @@ -55,7 +55,7 @@ redirect_from: {% webui %} 1. 连接到要调试的代码空间。 -2. 打开 {% data variables.product.prodname_vscode_command_palette %} (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) ,然后键入 **Creation logs**。 从列表中选择 **Codespaces: View Creation Log(代码空间:查看创建日志)**以打开 `creation.log` 文件。 +2. Open the {% data variables.product.prodname_vscode_command_palette_shortname %} (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)) and type **Creation logs**. 从列表中选择 **Codespaces: View Creation Log(代码空间:查看创建日志)**以打开 `creation.log` 文件。 如果要与支持人员共享日志,可以将创建日志中的文本复制到文本编辑器中,并将文件保存在本地。 @@ -63,7 +63,7 @@ redirect_from: {% vscode %} -打开命令面板 (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)),然后键入 **Creation logs**。 从列表中选择 **Codespaces: View Creation Log(代码空间:查看创建日志)**以打开 `creation.log` 文件。 +Open the {% data variables.product.prodname_vscode_command_palette_shortname %} (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)) and type **Creation logs**. 从列表中选择 **Codespaces: View Creation Log(代码空间:查看创建日志)**以打开 `creation.log` 文件。 如果要与支持人员共享日志,可以将创建日志中的文本复制到文本编辑器中,并将文件保存在本地。 diff --git a/translations/zh-CN/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md b/translations/zh-CN/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md index bacc92219c55..722c8cf4cbf7 100644 --- a/translations/zh-CN/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md +++ b/translations/zh-CN/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md @@ -1,5 +1,5 @@ --- -title: 代码空间的创建和删除疑难解答 +title: Troubleshooting creation and deletion of codespaces intro: 本文提供了在创建或删除代码空间时可能遇到的常见问题(包括存储和配置问题)的疑难解答步骤。 product: '{% data reusables.gated-features.codespaces %}' versions: @@ -16,6 +16,8 @@ shortTitle: 创建和删除 ### 没有创建代码空间的权限 {% data variables.product.prodname_codespaces %} 并非对所有存储库都可用。 如果缺少“Open with Codespaces(使用 Codespaces 打开)”按钮,则 {% data variables.product.prodname_github_codespaces %} 可能不适用于该存储库。 更多信息请参阅“[创建代码空间](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces)”。 +You can't create a codespace for a private repository that is owned by an organization, unless you have write access to the repository or the organization has enabled forking for it. + 如果您认为您的组织已启用 [ {% data variables.product.prodname_codespaces %}](/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization#about-enabling-codespaces-for-your-organization),请确保组织所有者或帐单管理员已设置 {% data variables.product.prodname_codespaces %} 的支出限制。 更多信息请参阅“[管理 {% data variables.product.prodname_codespaces %} 的支出限制](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces)”。 ### 代码空间在创建时未打开 diff --git a/translations/zh-CN/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md b/translations/zh-CN/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md index d5a3127bb435..94ee61efa034 100644 --- a/translations/zh-CN/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md +++ b/translations/zh-CN/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md @@ -18,7 +18,7 @@ redirect_from: Codespaces are set to stop after 30 minutes without any activity. If you try to interact with a codespace after it has stopped, you may see a `503 service unavailable` error. - If a **Start** button is shown in {% data variables.product.prodname_vscode %} or in your browser window, click **Start** to reconnect to the codespace. -- Reset your codespace by reloading the window. From the [command palette](/codespaces/codespaces-reference/using-the-command-palette-in-codespaces#accessing-the-command-palette) in {% data variables.product.prodname_vscode %}, click **Developer: Reload Window**. +- Reset your codespace by reloading the window. From the [Command Palette](/codespaces/codespaces-reference/using-the-command-palette-in-codespaces#accessing-the-command-palette) in {% data variables.product.prodname_vscode %}, click **Developer: Reload Window**. ## Browser cannot connect diff --git a/translations/zh-CN/content/developers/apps/building-github-apps/authenticating-with-github-apps.md b/translations/zh-CN/content/developers/apps/building-github-apps/authenticating-with-github-apps.md index 1990deb499e7..48bfe36d8f17 100644 --- a/translations/zh-CN/content/developers/apps/building-github-apps/authenticating-with-github-apps.md +++ b/translations/zh-CN/content/developers/apps/building-github-apps/authenticating-with-github-apps.md @@ -147,18 +147,24 @@ $ curl -i -X POST \ ```shell $ curl -i \ --H "Authorization: token YOUR_INSTALLATION_ACCESS_TOKEN" \ +-H "Authorization: Bearer YOUR_INSTALLATION_ACCESS_TOKEN" \ -H "Accept: application/vnd.github+json" \ {% data variables.product.api_url_pre %}/installation/repositories ``` `YOUR_INSTALLATION_ACCESS_TOKEN` 是必须替换的值。 +{% note %} + +**注意:**{% data reusables.getting-started.bearer-vs-token %} + +{% endnote %} + ## 作为安装访问 API 端点 有关适用于使用安装访问令牌的 {% data variables.product.prodname_github_apps %} 的 REST API 端点列表,请参阅“[可用端点](/rest/overview/endpoints-available-for-github-apps)。” -有关与安装相关的端点的列表,请参阅“[安装](/rest/reference/apps#installations)。” +For a list of endpoints related to installations, see "[Installations](/rest/reference/apps#installations)." ## 由安装验证基于 HTTP 的 Git 访问权限 diff --git a/translations/zh-CN/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md b/translations/zh-CN/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md index d2e6929c106f..1b0d289fb52f 100644 --- a/translations/zh-CN/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md +++ b/translations/zh-CN/content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md @@ -108,13 +108,13 @@ shortTitle: 识别和授权用户 用户的访问令牌允许 GitHub 应用程序代表用户向 API 发出请求。 - Authorization: token OAUTH-TOKEN + Authorization: Bearer OAUTH-TOKEN GET {% data variables.product.api_url_code %}/user 例如,您可以像以下这样在 curl 中设置“授权”标头: ```shell -curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre %}/user +curl -H "Authorization: Bearer OAUTH-TOKEN" {% data variables.product.api_url_pre %}/user ``` ## 设备流程 @@ -133,12 +133,12 @@ curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre 获得用户的 OAuth 令牌后,您可以检查该用户可以访问哪些安装。 - Authorization: token OAUTH-TOKEN + Authorization: Bearer OAUTH-TOKEN GET /user/installations 您还可以检查用户可以访问哪些仓库进行安装。 - Authorization: token OAUTH-TOKEN + Authorization: Bearer OAUTH-TOKEN GET /user/installations/:installation_id/repositories 更多信息请参阅:[列出用户访问令牌可访问的应用程序安装](/rest/apps#list-app-installations-accessible-to-the-user-access-token)和[列出用户访问令牌可访问的仓库](/rest/apps#list-repositories-accessible-to-the-user-access-token)。 diff --git a/translations/zh-CN/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md b/translations/zh-CN/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md index d0e1dd45920b..52e151947999 100644 --- a/translations/zh-CN/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md +++ b/translations/zh-CN/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md @@ -23,6 +23,8 @@ When an organization has an allow list, third-party applications that connect vi ## Adding an IP address allow list to a {% data variables.product.prodname_github_app %} +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.apps.settings-step %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.github_apps %} diff --git a/translations/zh-CN/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md b/translations/zh-CN/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md index ca89fbc56b21..f864c2ad9a3e 100644 --- a/translations/zh-CN/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md +++ b/translations/zh-CN/content/developers/apps/building-github-apps/rate-limits-for-github-apps.md @@ -1,5 +1,5 @@ --- -title: Rate limits for GitHub Apps +title: GitHub 应用程序的速率限制 intro: '{% data reusables.shortdesc.rate_limits_github_apps %}' redirect_from: - /early-access/integrations/rate-limits @@ -14,7 +14,7 @@ versions: ghec: '*' topics: - GitHub Apps -shortTitle: Rate limits +shortTitle: 速率限制 --- {% data reusables.enterprise.rate_limit %} @@ -23,49 +23,49 @@ shortTitle: Rate limits {% ifversion ghec or fpt %} -## About rate limits for apps +## 关于应用程序的速率限制 -Rate limits for {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %} depend on the plan for the organization where you install the application. For more information, see "[{% data variables.product.company_short %}'s products](/get-started/learning-about-github/githubs-products)" and "[Types of {% data variables.product.company_short %} accounts](/get-started/learning-about-github/types-of-github-accounts#organization-accounts)." +{% data variables.product.prodname_github_apps %} 和 {% data variables.product.prodname_oauth_apps %} 的速率限制取决于安装应用程序的组织的计划。 更多信息请参阅“[{% data variables.product.company_short %} 的产品](/get-started/learning-about-github/githubs-products)”和“[{% data variables.product.company_short %} 帐户类型](/get-started/learning-about-github/types-of-github-accounts#organization-accounts)”。 {% endif %} -## Server-to-server requests +## 服务器到服务器请求 {% ifversion ghec or fpt %} -### Default server-to-server rate limits for {% data variables.product.prodname_dotcom_the_website %} +### {% data variables.product.prodname_dotcom_the_website %} 的默认服务器到服务器速率限制 {% endif %} -{% data variables.product.prodname_github_apps %} making server-to-server requests use the installation's minimum rate limit of 5,000 requests per hour. If an application is installed on an organization with more than 20 users, the application receives another 50 requests per hour for each user. Installations that have more than 20 repositories receive another 50 requests per hour for each repository. The maximum rate limit for an installation is 12,500 requests per hour. +发出服务器-服务器请求的 {% data variables.product.prodname_github_apps %} 使用安装的最低速率限制为每小时 5,000 个请求。 如果应用程序安装在具有 20 个以上用户的组织中,则该应用程序每小时为每个用户再接收 50 个请求。 具有 20 个以上仓库的安装每小时会为每个仓库再接收 50 个请求。 安装的最大速率限制为每小时 12,500 个请求。 {% ifversion fpt or ghec %} -### Server-to-server rate limits for {% data variables.product.prodname_ghe_cloud %} +### {% data variables.product.prodname_ghe_cloud %} 的服务器到服务器速率限制 {% endif %} {% ifversion fpt or ghec %} -{% data variables.product.prodname_github_apps %} that are installed on an organization or a repository within an enterprise on {% data variables.product.product_location %} are subject to a limit of 15,000 requests per hour. +{% data variables.product.prodname_github_apps %} that are installed on an organization within an enterprise on {% data variables.product.product_location %} are subject to a limit of 15,000 requests per hour per organization that has installed the app. {% endif %} -## User-to-server requests +## 用户到服务器请求 -{% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %} can also act on behalf of a user, making user-to-server requests after the user authorizes the app. For more information, see "[Authorizing {% data variables.product.prodname_github_apps %}](/authentication/keeping-your-account-and-data-secure/authorizing-github-apps)" and "[Authorizing {% data variables.product.prodname_oauth_apps %}](/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps)." +{% data variables.product.prodname_github_apps %} 和 {% data variables.product.prodname_oauth_apps %} 还可以代表用户执行操作,在用户授权应用后发出用户到服务器的请求。 更多信息请参阅“[授权 {% data variables.product.prodname_github_apps %}](/authentication/keeping-your-account-and-data-secure/authorizing-github-apps)”和“[授权 {% data variables.product.prodname_oauth_apps %}](/authentication/keeping-your-account-and-data-secure/authorizing-oauth-apps)”。 -User-to-server requests from {% data variables.product.prodname_oauth_apps %} are authenticated with an OAuth token. User-to-server requests from {% data variables.product.prodname_github_apps %} are authenticated with either an OAuth token or an expiring user access token. For more information, see "[Identifying and authorizing users for {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps#identifying-and-authorizing-users-for-github-apps)" and "[Authorizing {% data variables.product.prodname_oauth_apps %}](/developers/apps/building-oauth-apps/authorizing-oauth-apps)." +来自 {% data variables.product.prodname_oauth_apps %} 的用户到服务器请求使用 OAuth 令牌进行身份验证。 来自 {% data variables.product.prodname_github_apps %} 的用户到服务器请求使用 OAuth 令牌或即将过期的用户访问令牌进行身份验证。 更多信息请参阅“[识别和授权 {% data variables.product.prodname_github_apps %} 的用户](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps#identifying-and-authorizing-users-for-github-apps)”和“[授权 {% data variables.product.prodname_oauth_apps %}](/developers/apps/building-oauth-apps/authorizing-oauth-apps)”。 {% ifversion fpt or ghec %} -### Default user-to-server rate limits for {% data variables.product.prodname_dotcom_the_website %} +### {% data variables.product.prodname_dotcom_the_website %} 的默认用户到服务器速率限制 {% endif %} {% ifversion ghec %} -The rate limits for user-to-server requests made by {% data variables.product.prodname_github_apps %} depend on where the app is installed. If the app is installed on organizations or repositories owned by an enterprise on {% data variables.product.product_location %}, then the rate is higher than for installations outside an enterprise. +{% data variables.product.prodname_github_apps %} 发出的用户到服务器请求的速率限制取决于应用程序的安装位置。 如果应用程序安装在 {% data variables.product.product_location %} 上由企业拥有的组织或存储库上,则速率高于企业外部的安装。 {% endif %} @@ -73,13 +73,13 @@ The rate limits for user-to-server requests made by {% data variables.product.pr {% ifversion fpt or ghec %} -### User-to-server rate limits for {% data variables.product.prodname_ghe_cloud %} +### {% data variables.product.prodname_ghe_cloud %} 的用户到服务器速率限制 {% data reusables.apps.user-to-server-rate-limits-ghec %} {% endif %} -## Further reading +## 延伸阅读 -- "[Rate limiting](/rest/overview/resources-in-the-rest-api#rate-limiting)" in the REST API documentation -- "[Resource limitations](/graphql/overview/resource-limitations)" in the GraphQL API documentation +- REST API 文档中的“[速率限制](/rest/overview/resources-in-the-rest-api#rate-limiting)” +- GraphQL API 文档中的“[资源限制](/graphql/overview/resource-limitations)” diff --git a/translations/zh-CN/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md b/translations/zh-CN/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md index 7c9a7105052a..9b6ca40f263b 100644 --- a/translations/zh-CN/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md +++ b/translations/zh-CN/content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md @@ -107,13 +107,13 @@ Accept: application/xml 访问令牌可用于代表用户向 API 提出请求。 - Authorization: token OAUTH-TOKEN + Authorization: Bearer OAUTH-TOKEN GET {% data variables.product.api_url_code %}/user 例如,您可以像以下这样在 curl 中设置“授权”标头: ```shell -curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre %}/user +curl -H "Authorization: Bearer OAUTH-TOKEN" {% data variables.product.api_url_pre %}/user ``` ## 设备流程 diff --git a/translations/zh-CN/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md b/translations/zh-CN/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md index c3f1afcd313e..e4a02df7541a 100644 --- a/translations/zh-CN/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md +++ b/translations/zh-CN/content/developers/apps/building-oauth-apps/scopes-for-oauth-apps.md @@ -28,7 +28,7 @@ topics: 检查标头以查看您拥有哪些 OAuth 作用域,以及 API 操作接受什么: ```shell -$ curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre %}/users/codertocat -I +$ curl -H "Authorization: Bearer OAUTH-TOKEN" {% data variables.product.api_url_pre %}/users/codertocat -I HTTP/2 200 X-OAuth-Scopes: repo, user X-Accepted-OAuth-Scopes: user diff --git a/translations/zh-CN/content/developers/overview/github-developer-program.md b/translations/zh-CN/content/developers/overview/github-developer-program.md index 9bbfe66e3d09..07317a3f4057 100644 --- a/translations/zh-CN/content/developers/overview/github-developer-program.md +++ b/translations/zh-CN/content/developers/overview/github-developer-program.md @@ -23,9 +23,9 @@ topics: ## 有适用于 GitHub 的集成? 太棒了! 我们希望您加入计划。 以下是您可以使用的推广方式:

-* [让我们知道您的集成](https://support.github.com/contact?tags=rr-general-technical&form[subject]=New+GitHub+Integration) -* 使用 [Octocat 或 GitHub 徽标](https://github.com/logos)来标识您的产品适用于 GitHub -* 在您的网站上发布有关您的集成的视频或博客 +* [Let us know about your integration](https://support.github.com/contact?tags=rr-general-technical&form[subject]=New+GitHub+Integration). +* 使用 [Octocat 或 GitHub 徽标](https://github.com/logos)来标识您的产品适用于 GitHub. +* 在您的网站上发布有关您的集成的视频或博客. ## 准备加入 GitHub 开发者计划吗? diff --git a/translations/zh-CN/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md b/translations/zh-CN/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md index bc200e024307..863cf930645a 100644 --- a/translations/zh-CN/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md +++ b/translations/zh-CN/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md @@ -37,12 +37,12 @@ $ export SECRET_TOKEN=your_token ## 验证来自 GitHub 的有效负载 -设置密钥令牌后,{% data variables.product.product_name %} 使用它为每个有效负载创建一个哈希签名。 此哈希签名包含在每个请求的标头中,作为 `X-Hub-Signature-256`。 +设置密钥令牌后,{% data variables.product.product_name %} 使用它为每个有效负载创建一个哈希签名。 This hash signature is included with the headers of each request as `x-hub-signature-256`. {% ifversion fpt or ghes or ghec %} {% note %} -**注:** 为了向后兼容,我们还包括使用 SHA-1 哈希函数生成的 `X-Hub-Signature` 标头。 如果可能,我们建议您使用 `X-Hub-Signature-256` 标头以提高安全性。 下面的示例演示使用 `X-Hub-Signature-256` 标头。 +**Note:** For backward-compatibility, we also include the `x-hub-signature` header that is generated using the SHA-1 hash function. If possible, we recommend that you use the `x-hub-signature-256` header for improved security. The example below demonstrates using the `x-hub-signature-256` header. {% endnote %} {% endif %} diff --git a/translations/zh-CN/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-to-github-classroom.md b/translations/zh-CN/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-to-github-classroom.md index 5d789c03d4e9..11233a214b6f 100644 --- a/translations/zh-CN/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-to-github-classroom.md +++ b/translations/zh-CN/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-to-github-classroom.md @@ -25,23 +25,22 @@ shortTitle: 连接 LMS ## 支持的 LMSes -{% data variables.product.prodname_classroom %} 支持从实施学习工具互操作性 (LTI) 标准的 LMS 导入名册数据。 +{% note %} -- LTI 版本 1.0 和/或 1.1 -- 配置 1.X 的 LTI 名称和角色 +**Note:** {% data variables.product.prodname_classroom %} previously supported import of roster data from LMSes that implement Learning Tools Interoperability (LTI) versions 1.0 and 1.1. On June 30, 2022, the Instructional Management System (IMS) Global Learning Consortium [ended support for LTI versions 1.0 and 1.1](https://www.imsglobal.org/lti-security-announcement-and-deprecation-schedule). In the interest of keeping sensitive student information safe and secure, {% data variables.product.company_short %} has temporarily disabled importing roster data from LTI-compliant LMSes.

-使用 LTI 有助于确保您的信息安全。 LTI 是一个行业标准协议,GitHub Classroom 对 LTI 的使用得到了教学管理系统 (IMS) 全球学习联盟的认证。 更多信息请参阅[学习工具互操作性](https://www.imsglobal.org/activity/learning-tools-interoperability)和 IMS 全球学习联盟网站上的[关于 IMS 全球学习联盟](http://www.imsglobal.org/aboutims.html)。 +Support for the latest version of Learning Tools Interoperability, [LTI 1.3](https://www.imsglobal.org/activity/learning-tools-interoperability), is currently being worked on and will be made available in {% data variables.product.prodname_classroom %} very soon. + +{% endnote %} + +LTI 是一个行业标准协议,GitHub Classroom 对 LTI 的使用得到了教学管理系统 (IMS) 全球学习联盟的认证。 更多信息请参阅[学习工具互操作性](https://www.imsglobal.org/activity/learning-tools-interoperability)和 IMS 全球学习联盟网站上的[关于 IMS 全球学习联盟](http://www.imsglobal.org/aboutims.html)。 {% data variables.product.company_short %} 测试了名册数据从以下 LMS 到 {% data variables.product.prodname_classroom %} 的导入。 -- Canvas - Google Classroom -- Moodle -- Sakai -目前, {% data variables.product.prodname_classroom %} 不支持从 Blackboard 或 Brightspace 导入名册数据. -## 为教室生成配置凭据 +## Connecting to Google Classroom {% data reusables.classroom.sign-into-github-classroom %} {% data reusables.classroom.click-classroom-in-list %} @@ -49,88 +48,15 @@ shortTitle: 连接 LMS 1. 如果您的教室已有名册,您可以更新名册或删除名册并创建新的名册。 - 有关删除和创建名册的更多信息,请参阅“[删除教室名册](/education/manage-coursework-with-github-classroom/manage-classrooms#deleting-a-roster-for-a-classroom)”和“[创建教室名册](/education/manage-coursework-with-github-classroom/manage-classrooms#creating-a-roster-for-your-classroom)”。 - 有关更新名册的更多信息,请参阅“[将学生添加到教室的名册](/education/manage-coursework-with-github-classroom/manage-classrooms#adding-students-to-the-roster-for-your-classroom)”。 -1. 在 LMS 列表中,单击您的 LMS。 如果您的 LMS 不受支持,请单击**其他 LMS**。 ![LMS 列表](/assets/images/help/classroom/classroom-settings-click-lms.png) -1. 阅读有关连接 LMS 的操作,然后单击 **连接到 _LMS_**。 -1. 复制用于连接到教室的“消费者密钥”、“共享密钥”和“启动 URL”。 ![复制凭据](/assets/images/help/classroom/classroom-copy-credentials.png) - -## 配置通用 LMS - -您必须为 LMS 配置隐私设置,以允许外部工具接收名册信息。 - -1. 导航到 LMS。 -1. 配置外部工具。 -1. 提供您在 {% data variables.product.prodname_classroom %} 中生成的配置凭据。 - - 消费者密钥 - - 共享机密 - - 启动 URL(有时称为“工具 URL”或类似名称) - -## 配置 Canvas - -您可以将 {% data variables.product.prodname_classroom %} 配置为 Canvas 的外部应用以将名册数据导入到您的教室。 有关 Canvas 的更多信息,请参阅 [Canvas 网站](https://www.instructure.com/canvas/)。 - -1. 登录到 [Canvas](https://www.instructure.com/canvas/#login)。 -1. 选择要与 {% data variables.product.prodname_classroom %} 集成的 Canvas 课程。 -1. 在左边栏中,单击 **Settings(设置)**。 -1. 单击 **Apps(应用程序)**选项卡。 -1. 单击 **View app configurations(查看应用程序配置)**。 -1. 单击 **+App**。 -1. 选择 **Configuration Type(配置类型)**下拉菜单,然后单击 **By URL(通过 URL)**。 -1. 从 {% data variables.product.prodname_classroom %} 粘贴配置凭据。 更多信息请参阅“[为教室生成配置凭据](#generating-configuration-credentials-for-your-classroom)”。 - - | Canvas 应用程序配置中的字段 | 值或设置 | - |:------------------------- |:-------------------------------------------------------- | - | **消费者密钥** | {% data variables.product.prodname_classroom %} 中的消费者密钥 | - | **共享秘密** | {% data variables.product.prodname_classroom %} 中的共享密钥 | - | **允许此工具访问 IMS 名称和角色预配服务** | 已启用 | - | **配置 URL** | {% data variables.product.prodname_classroom %} 中的启动 URL | - - {% note %} - - **注意**: 如果您在 Canvas 中看不到名为“Allow this tool to access the IMS Names and Role Provisioning Service(允许此工具访问 IMS 名称和角色预配服务)”的复选框,则您的 Canvas 管理员必须联系 Canvas 支持,以为您的 Canvas 帐户启用会员服务配置。 如果不启用此功能,您将无法从 Canvas 同步名册。 更多信息请参阅 Canvas 网站上的[如何联系 Canvas 支持?](https://community.canvaslms.com/t5/Canvas-Basics-Guide/How-do-I-contact-Canvas-Support/ta-p/389767)。 - - {% endnote %} - -1. 单击 **Submit(提交)**。 -1. 在左侧边栏中,单击 **Home(主页)**。 -1. 要提示 Canvas 发送确认电子邮件,请在左侧栏中单击 **GitHub Classroom**。 按照电子邮件中的说明完成链接 {% data variables.product.prodname_classroom %}。 - -## 配置 Moodle - -您可以将 {% data variables.product.prodname_classroom %} 配置为 Moodle 的活动以将名册数据导入到您的教室。 有关 Moodle 的更多信息,请参阅 [Moodle 网站](https://moodle.org)。 - -您必须使用 Moodle 版本 3.0 或更高版本。 - -1. 登录 [Moodle](https://moodle.org/login/)。 -1. 选择要与 {% data variables.product.prodname_classroom %} 集成的 Moodle 课程。 -1. 单击 **Turn editing on(打开编辑)**。 -1. 当希望 {% data variables.product.prodname_classroom %} 在 Moodle 中可用时,单击 **Add an activity or resource(添加活动或资源)**。 -1. 选择 **External tool(外部工具)**并单击 **Add(添加)**。 -1. 在“Activity name(活动名称)”字段中,键入 "GitHub Classroom"。 -1. 在 **Preconfigured tool(预配置的工具)**字段的下拉菜单右侧,单击 **+**。 -1. 在“External tool configuration(外部工具配置)”下,从 {% data variables.product.prodname_classroom %} 粘贴配置凭据。 更多信息请参阅“[为教室生成配置凭据](#generating-configuration-credentials-for-your-classroom)”。 - - | Moodle 应用程序配置中的字段 | 值或设置 | - |:----------------- |:--------------------------------------------------------------------------------------------------------------------------------- | - | **工具名称** | {% data variables.product.prodname_classroom %} - _YOUR CLASSROOM NAME_

**注意**:您可以使用任何名称,但为明确起见,我们建议使用这个值。 | - | **工具 URL** | {% data variables.product.prodname_classroom %} 中的启动 URL | - | **LTI 版本** | LTI 1.0/1.1 | - | **默认启动容器** | 新窗口 | - | **消费者密钥** | {% data variables.product.prodname_classroom %} 中的消费者密钥 | - | **共享机密** | {% data variables.product.prodname_classroom %} 中的共享密钥 | - -1. 滚动到 **Services(服务)**并单击。 -1. 在“IMS LTI Names and Role Provisioning(IMS LTI 名称和角色预配)”的右侧,选择下拉菜单并单击 **Use this service to retrieve members' information as per privacy settings(根据隐私设置使用此服务检索成员的信息)**。 -1. 滚动到 **Privacy(隐私)**并单击。 -1. 在 **Share launcher's name with tool(使用工具共享启动者的名称)**和 **Share launcher's email with tool(使用工具共享启动者的电子邮件)**右侧,选择下拉菜单以单击 **Always(始终)**。 -1. 在页面底部,单击 **Save changes(保存更改)**。 -1. 在 **Preconfigure tool(预配置工具)**菜单中,单击 **GitHub Classroom - _YOUR CLASSROOM NAME_**。 -1. 在“Common module settings(通用模块设置)”下“Availability(可用性)”的右侧,选择下拉菜单并单击 **Hide from students(对学生隐藏)**。 -1. 在页面底部,单击 **Save and return to course(保存并返回课程)**。 -1. 导航到您选择显示 {% data variables.product.prodname_classroom %} 的任何位置,然后单击 {% data variables.product.prodname_classroom %} 活动。 - -## 从 LMS 导入名册 - -有关从将名册从 LMS 导入到 {% data variables.product.prodname_classroom %} 的更多信息,请参阅“[管理教室](/education/manage-coursework-with-github-classroom/manage-classrooms#creating-a-roster-for-your-classroom)”。 +1. In the list of LMSes, click Google Classroom. ![Google Classroom](/assets/images/help/classroom/classroom-settings-click-google-classroom.png) +1. Sign in to Google, then select the Classroom to link to. + + +## Connecting to Canvas, Moodle, Sakai, and other LMSes + +Connecting to other LMSes is temporarily unavailable as {% data variables.product.company_short %} updates to Learning Tools Interoperability (LTI) version 1.3. For more information, see "[Supported LMSes](#supported-lmses)." + +In the meantime, you may manually input your roster for your class. For more information about manually importing the roster from your LMS into {% data variables.product.prodname_classroom %}, see "[Manage classrooms](/education/manage-coursework-with-github-classroom/manage-classrooms#creating-a-roster-for-your-classroom)." ## 断开 LMS 连接 diff --git a/translations/zh-CN/content/get-started/exploring-projects-on-github/following-organizations.md b/translations/zh-CN/content/get-started/exploring-projects-on-github/following-organizations.md index 64d714439626..b3e02489cad9 100644 --- a/translations/zh-CN/content/get-started/exploring-projects-on-github/following-organizations.md +++ b/translations/zh-CN/content/get-started/exploring-projects-on-github/following-organizations.md @@ -7,15 +7,11 @@ topics: - Profile --- -{% note %} - -**Note:** The ability to follow organizations is currently in public beta and subject to change. - -{% endnote %} +{% data reusables.organizations.follow-organizations-beta %} ## About followers on {% data variables.product.product_name %} -When you follow organizations, you'll see their public activity on your personal dashboard. For more information, see "[About your personal dashboard](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard#staying-updated-with-activity-from-the-community)." +{% data reusables.organizations.about-following-organizations %} For more information, see "[About your personal dashboard](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard#staying-updated-with-activity-from-the-community)." You can unfollow an organization if you do not wish to see their {% ifversion fpt or ghec %}public{% endif %} activity on {% data variables.product.product_name %}. diff --git a/translations/zh-CN/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md b/translations/zh-CN/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md index 97b049d2dee3..30a25ec8ae0a 100644 --- a/translations/zh-CN/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md +++ b/translations/zh-CN/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md @@ -58,11 +58,21 @@ If you have existing source code or repositories stored locally on your computer ![Create New Repository drop-down](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. Change the current working directory to your local project. -4. Initialize the local directory as a Git repository. - ```shell - $ git init -b main - ``` +4. Use the `init` command to initialize the local directory as a Git repository. By default, the initial branch is called `master`. + + If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using `-b`. + + ``` shell + $ git init -b main + ``` + + If you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using `&& git branch -m`. + + ``` shell + $ git init && git branch -m main + ``` 5. Add the files in your new local repository. This stages them for the first commit. + ```shell $ git add . # Adds the files in the local repository and stages them for commit. {% data reusables.git.unstage-codeblock %} @@ -95,10 +105,19 @@ If you have existing source code or repositories stored locally on your computer ![Create New Repository drop-down](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. Change the current working directory to your local project. -4. Initialize the local directory as a Git repository. - ```shell - $ git init -b main - ``` +4. Use the `init` command to initialize the local directory as a Git repository. By default, the initial branch is called `master`. + + If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using `-b`. + + ``` shell + $ git init -b main + ``` + + If you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using `&& git branch -m`. + + ``` shell + $ git init && git branch -m main + ``` 5. Add the files in your new local repository. This stages them for the first commit. ```shell $ git add . @@ -132,10 +151,19 @@ If you have existing source code or repositories stored locally on your computer ![Create New Repository drop-down](/assets/images/help/repository/repo-create.png) {% data reusables.command_line.open_the_multi_os_terminal %} 3. Change the current working directory to your local project. -4. Initialize the local directory as a Git repository. - ```shell - $ git init -b main - ``` +4. Use the `init` command to initialize the local directory as a Git repository. By default, the initial branch is called `master`. + + If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using `-b`. + + ``` shell + $ git init -b main + ``` + + If you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using `&& git branch -m`. + + ``` shell + $ git init && git branch -m main + ``` 5. Add the files in your new local repository. This stages them for the first commit. ```shell $ git add . diff --git a/translations/zh-CN/content/get-started/quickstart/be-social.md b/translations/zh-CN/content/get-started/quickstart/be-social.md index 496c283694ce..fe037d3c37a5 100644 --- a/translations/zh-CN/content/get-started/quickstart/be-social.md +++ b/translations/zh-CN/content/get-started/quickstart/be-social.md @@ -58,7 +58,23 @@ topics: ![切换帐户上下文下拉列表](/assets/images/help/overview/dashboard-contextswitcher.png) -### 在 {% data variables.product.prodname_dotcom %} 上探索其他项目 +{% ifversion for-you-feed %} + +## 关注组织 + +{% data reusables.organizations.follow-organizations-beta %} + +{% data reusables.organizations.about-following-organizations %} + +To follow an organization, in the header of the organization's page, click **Follow**. + +![组织标题的屏幕截图,突出显示了“关注”按钮](/assets/images/help/profile/organization-profile-following.png) + +For more information, see "[Following organizations](/get-started/exploring-projects-on-github/following-organizations)." + +{% endif %} + +## 在 {% data variables.product.prodname_dotcom %} 上探索其他项目 您可以在 {% data variables.product.prodname_dotcom %} 的 Explore(探索)页面上发现新的和有趣的项目。 您可以为有趣的项目加注星标,以便以后再次轻松找到它们。 访问您的星标页面,查看所有已加星标的项目。 有关星标的更多信息,请参阅“[使用星标保存仓库](/get-started/exploring-projects-on-github/saving-repositories-with-stars)”。 diff --git a/translations/zh-CN/content/get-started/quickstart/fork-a-repo.md b/translations/zh-CN/content/get-started/quickstart/fork-a-repo.md index 9702c1024d98..e6dc54b566b9 100644 --- a/translations/zh-CN/content/get-started/quickstart/fork-a-repo.md +++ b/translations/zh-CN/content/get-started/quickstart/fork-a-repo.md @@ -113,7 +113,7 @@ gh repo fork repository --org "octo-org" > Cloning into `Spoon-Knife`... > remote: Counting objects: 10, done. > remote: Compressing objects: 100% (8/8), done. - > remove: Total 10 (delta 1), reused 10 (delta 1) + > remote: Total 10 (delta 1), reused 10 (delta 1) > Unpacking objects: 100% (10/10), done. ``` diff --git a/translations/zh-CN/content/graphql/guides/migrating-graphql-global-node-ids.md b/translations/zh-CN/content/graphql/guides/migrating-graphql-global-node-ids.md index 2964dcb1b9eb..fbb8b688b828 100644 --- a/translations/zh-CN/content/graphql/guides/migrating-graphql-global-node-ids.md +++ b/translations/zh-CN/content/graphql/guides/migrating-graphql-global-node-ids.md @@ -32,7 +32,7 @@ shortTitle: 迁移全局节点 ID ``` $ curl \ - -H "Authorization: token $GITHUB_TOKEN" \ + -H "Authorization: Bearer $GITHUB_TOKEN" \ -H "X-Github-Next-Global-ID: 1" \ https://api.github.com/graphql \ -d '{ "query": "{ node(id: \"MDQ6VXNlcjM0MDczMDM=\") { id } }" }' diff --git a/translations/zh-CN/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md b/translations/zh-CN/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md index cbe09228de1f..c80ed69f85a4 100644 --- a/translations/zh-CN/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md +++ b/translations/zh-CN/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md @@ -70,7 +70,7 @@ gh api graphql -f query=' ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"query{organization(login: \"ORGANIZATION\") {projectV2(number: NUMBER){id}}}"}' ``` {% endcurl %} @@ -94,7 +94,7 @@ gh api graphql -f query=' ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"{organization(login: \"ORGANIZATION\") {projectsV2(first: 20) {nodes {id title}}}}"}' ``` {% endcurl %} @@ -125,7 +125,7 @@ gh api graphql -f query=' ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"query{user(login: \"USER\") {projectV2(number: NUMBER){id}}}"}' ``` {% endcurl %} @@ -149,7 +149,7 @@ gh api graphql -f query=' ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"{user(login: \"USER\") {projectsV2(first: 20) {nodes {id title}}}}"}' ``` {% endcurl %} @@ -180,7 +180,7 @@ gh api graphql -f query=' ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2Field { id name } ... on ProjectV2IterationField { id name configuration { iterations { startDate id }}} ... on ProjectV2SingleSelectField { id name options { id name }}}}}}}"}' ``` {% endcurl %} @@ -284,7 +284,7 @@ gh api graphql -f query=' ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2FieldCommon { id name }}}}}}"}' ``` {% endcurl %} @@ -354,7 +354,7 @@ gh api graphql -f query=' ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { items(first: 20) { nodes{ id fieldValues(first: 8) { nodes{ ... on ProjectV2ItemFieldTextValue { text field { ... on ProjectV2FieldCommon { name }}} ... on ProjectV2ItemFieldDateValue { date field { ... on ProjectV2FieldCommon { name } } } ... on ProjectV2ItemFieldSingleSelectValue { name field { ... on ProjectV2FieldCommon { name }}}}} content{ ... on DraftIssue { title body } ...on Issue { title assignees(first: 10) { nodes{ login }}} ...on PullRequest { title assignees(first: 10) { nodes{ login }}}}}}}}}"}' ``` {% endcurl %} @@ -446,7 +446,7 @@ gh api graphql -f query=' ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"mutation {addProjectV2ItemById(input: {projectId: \"PROJECT_ID\" contentId: \"CONTENT_ID\"}) {item {id}}}"}' ``` {% endcurl %} @@ -488,8 +488,8 @@ gh api graphql -f query=' ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ - --data '{"query":"mutation {addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) {item {id}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) {projectItem {id}}}"}' ``` {% endcurl %} @@ -498,7 +498,7 @@ curl --request POST \ gh api graphql -f query=' mutation { addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) { - item { + projectItem { id } } @@ -512,7 +512,7 @@ gh api graphql -f query=' { "data": { "addProjectV2ItemById": { - "item": { + "projectItem": { "id": "PVTI_lADOANN5s84ACbL0zgBbxFc" } } @@ -528,7 +528,7 @@ gh api graphql -f query=' ```shell curl --request POST \ --url https://api.github.com/graphql \ ---header 'Authorization: token TOKEN' \ +--header 'Authorization: Bearer TOKEN' \ --data '{"query":"mutation { updateProjectV2(input: { projectId: \"PROJECT_ID\", title: \"Project title\", public: false, readme: \"# Project README\n\nA long description\", shortDescription: \"A short description\"}) { projectV2 { id, title, readme, shortDescription }}}"}' ``` {% endcurl %} @@ -565,7 +565,7 @@ gh api graphql -f query=' ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { text: "Updated text" }}) { projectV2Item { id }}}"}' ``` {% endcurl %} @@ -619,7 +619,7 @@ gh api graphql -f query=' ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { singleSelectOptionId: "OPTION_ID" }}) { projectV2Item { id }}}"}' ``` {% endcurl %} @@ -659,7 +659,7 @@ gh api graphql -f query=' ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { singleSelectOptionId: "OPTION_ID" }}) { projectV2Item { id }}}"}' ``` {% endcurl %} @@ -694,7 +694,7 @@ gh api graphql -f query=' ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: token TOKEN' \ + --header 'Authorization: Bearer TOKEN' \ --data '{"query":"mutation {deleteProjectV2Item(input: {projectId: \"PROJECT_ID\" itemId: \"ITEM_ID\"}) {deletedItemId}}"}' ``` {% endcurl %} diff --git a/translations/zh-CN/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md b/translations/zh-CN/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md index 113f7e274f96..011d82a7f35d 100644 --- a/translations/zh-CN/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md +++ b/translations/zh-CN/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md @@ -24,7 +24,7 @@ shortTitle: 转移议题 {% endnote %} -转让议题时,评论、标签和受理人将保留。 不会保留议题的里程碑。 此议题将留在任何用户拥有或组织范围的项目板上,并从任何仓库项目板中删除。 更多信息请参阅“[关于项目板](/articles/about-project-boards)”。 +转让议题时,评论和受理人将保留。 Labels and milestones are also retained if they're present in the target repository, with labels matching by name and milestones matching by both name and due date. 此议题将留在任何用户拥有或组织范围的项目板上,并从任何仓库项目板中删除。 更多信息请参阅“[关于项目板](/articles/about-project-boards)”。 议题中提及的人员或团队将收到通知,告知他们该议题已转让给新仓库。 原来的 URL 会重定向到新议题的 URL。 在新仓库中没有读取权限的人员将看到一个横幅,告知他们该议题已转让给他们无法访问的新仓库。 diff --git a/translations/zh-CN/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md b/translations/zh-CN/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md index 94c920226f5c..b6e248b0a470 100644 --- a/translations/zh-CN/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md +++ b/translations/zh-CN/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md @@ -38,6 +38,8 @@ permissions: Organization owners can manage allowed IP addresses for an organiza {% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %} +{% data reusables.identity-and-permissions.ipv6-allow-lists %} + {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} {% data reusables.organizations.security %} diff --git a/translations/zh-CN/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md b/translations/zh-CN/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md index a9eba7663975..723c3c29cbe2 100644 --- a/translations/zh-CN/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md +++ b/translations/zh-CN/content/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization.md @@ -1,6 +1,6 @@ --- title: 为组织启用或禁用 GitHub 讨论 -intro: '您可以使用组织中的 {% data variables.product.prodname_discussions %} 作为组织进行对话的位置,这些对话不特定于组织中的单个存储库。' +intro: 'You can use {% data variables.product.prodname_discussions %} in an organization as a place for your organization to have conversations that aren''t specific to a single repository within your organization.' permissions: 'Organization owners can enable {% data variables.product.prodname_discussions %} for their organization.' versions: feature: discussions diff --git a/translations/zh-CN/content/packages/index.md b/translations/zh-CN/content/packages/index.md index 4773b4809fcc..785f176d6859 100644 --- a/translations/zh-CN/content/packages/index.md +++ b/translations/zh-CN/content/packages/index.md @@ -18,6 +18,7 @@ featuredLinks: guideCards: - '{% ifversion docker-ghcr-enterprise-migration %}/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry{% endif %}' - '{% ifversion fpt or ghec or ghes > 3.4 %}/packages/working-with-a-github-packages-registry/working-with-the-container-registry{% else %}/packages/working-with-a-github-packages-registry/working-with-the-docker-registry{% endif %}' + - '{% ifversion packages-npm-v2 %}/packages/working-with-a-github-packages-registry/working-with-the-npm-registry{% endif %}' - /packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry changelog: label: packages diff --git a/translations/zh-CN/content/packages/learn-github-packages/about-permissions-for-github-packages.md b/translations/zh-CN/content/packages/learn-github-packages/about-permissions-for-github-packages.md index c05ba2a02f1d..de17d09ee4c6 100644 --- a/translations/zh-CN/content/packages/learn-github-packages/about-permissions-for-github-packages.md +++ b/translations/zh-CN/content/packages/learn-github-packages/about-permissions-for-github-packages.md @@ -18,20 +18,22 @@ shortTitle: 关于权限 仓库作用域的包从拥有该包的仓库继承权限和可见性。 通过转到仓库的主页并单击页面右侧的 **Packages(包)**链接,您可以找到作用域为仓库的包。 {% ifversion fpt or ghec %}更多信息请参阅“[将仓库连接到包](/packages/learn-github-packages/connecting-a-repository-to-a-package)”。{% endif %} -下面的 {% data variables.product.prodname_registry %} 注册表使用仓库作用域的权限: +The {% data variables.product.prodname_registry %} registries below **only** use repository-scoped permissions: {% ifversion not fpt or ghec %}- Docker 注册表 (`docker.pkg.github.com`){% endif %} - - npm 注册表 + {% ifversion packages-npm-v2 %}{% else %}- npm registry{% endif %} - RubyGems 注册表 - Apache Maven 注册表 - NuGet 注册表 +{% ifversion packages-npm-v2 %}For {% data variables.product.prodname_ghcr_and_npm_registry %}, you can choose to allow packages to be scoped to a user, an organization, or linked to a repository.{% endif %} + {% ifversion fpt or ghec %} ## 用户/组织作用域包的精细权限 具有精细权限的包仅限于个人用户或组织帐户。 您可以从与包相连(或链接)的仓库分别更改包的访问控制和可见性。 -目前,只有 {% data variables.product.prodname_container_registry %} 为容器映像包提供精细权限。 +Currently, the {% data variables.product.prodname_ghcr_and_npm_registry %} offer granular permissions for your container image packages. ## 容器映像的可见性和访问权限 diff --git a/translations/zh-CN/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md b/translations/zh-CN/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md index 4b2ca5591c4a..c0ebb3641ac3 100644 --- a/translations/zh-CN/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md +++ b/translations/zh-CN/content/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility.md @@ -16,7 +16,7 @@ shortTitle: 访问控制和可见性 具有精细权限的包仅限于个人用户或组织帐户。 您可以从与包相连(或链接)的仓库分别更改包的访问控制和可见性。 -目前,您只能对 {% data variables.product.prodname_container_registry %} 使用粒度权限。 我们的其他包注册表(如 npm 注册表)不支持粒度权限。{% ifversion docker-ghcr-enterprise-migration %} 有关迁移到 {% data variables.product.prodname_container_registry %} 的详细信息,请参阅“[从 Docker 注册表迁移到 {% data variables.product.prodname_container_registry %}](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)”。{% endif %} +目前,您只能对 {% data variables.product.prodname_ghcr_and_npm_registry %} 使用粒度权限。 Granular permissions are not supported in our other package registries, such as the RubyGems registry.{% ifversion docker-ghcr-enterprise-migration %} For more information about migration to the {% data variables.product.prodname_container_registry %}, see "[Migrating to the {% data variables.product.prodname_container_registry %} from the Docker registry](/packages/working-with-a-github-packages-registry/migrating-to-the-container-registry-from-the-docker-registry)."{% endif %} 有关仓库作用域的包、与包相关的 PAT 作用域或管理操作工作流程的权限的更多信息,请参阅“[关于 GitHub Packages 的权限](/packages/learn-github-packages/about-permissions-for-github-packages)”。 @@ -95,7 +95,7 @@ shortTitle: 访问控制和可见性 {% ifversion fpt or ghec %} ## 确保 {% data variables.product.prodname_codespaces %} 访问您的软件包 -默认情况下,代码空间可以无缝访问 {% data variables.product.prodname_dotcom %} 容器注册表中的某些包,例如在选中了 **Inherit access(继承访问)**选项的同一仓库中发布的包。 有关自动配置哪些访问权限的详细信息,请参阅“[访问存储在容器注册表 {% data variables.product.prodname_dotcom %} 中的映像](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry#accessing-images-stored-in-github-container-registry)”。 +By default, a codespace can seamlessly access certain packages in the {% data variables.product.prodname_ghcr_and_npm_registry %}, such as those published in the same repository with the **Inherit access** option selected. For more information on which access is automatically configured, see "[Allowing your codespace to access a private image registry](/codespaces/codespaces-reference/allowing-your-codespace-to-access-a-private-image-registry#accessing-images-stored-in-container-registry-and-npm-registry)." 否则,为了确保代码空间能够访问您的软件包,必须授予对启动代码空间的仓库的访问权限。 diff --git a/translations/zh-CN/content/packages/learn-github-packages/deleting-and-restoring-a-package.md b/translations/zh-CN/content/packages/learn-github-packages/deleting-and-restoring-a-package.md index f7e966304946..8e50d7fe16c5 100644 --- a/translations/zh-CN/content/packages/learn-github-packages/deleting-and-restoring-a-package.md +++ b/translations/zh-CN/content/packages/learn-github-packages/deleting-and-restoring-a-package.md @@ -23,12 +23,12 @@ shortTitle: 删除和恢复包 - 整个私有包 - 整个公共包(如果任何包版本不超过 5000 次下载) - 私有包的特定版本 -- 公共包的特定版本(如果包版本不超过 5000 次下载) +- 公共包的特定版本(如果包版本不超过 5,000 次下载) {% note %} **注:** -- 如果任何版本的包下载量超过 5000 次,则无法删除公共包。 在这种情况下,请联系 [GitHub 支持](https://support.github.com/contact?tags=docs-packages) 获取更多帮助。 +- 如果任何版本的包下载量超过 5,000 次,则无法删除公共包。 在这种情况下,请联系 [GitHub 支持](https://support.github.com/contact?tags=docs-packages) 获取更多帮助。 - 删除公共包时,请注意,您可能会破坏依赖于包的项目。 {% endnote %} @@ -46,7 +46,7 @@ shortTitle: 删除和恢复包 {% endif %} -对于从仓库继承其权限和访问权限的包,您可以使用 GraphQL 删除特定的包版本。{% ifversion fpt or ghec %} {% data variables.product.prodname_registry %} GraphQL API 不支持使用包命名空间的容器或 Docker 映像 `https://ghcr.io/OWNER/PACKAGE-NAME`。{% endif %} 有关 GraphQL 支持的更多信息,请参阅“[使用 GraphQL 删除存储库范围包的版本](#deleting-a-version-of-a-repository-scoped-package-with-graphql)”。 +For packages that inherit their permissions and access from repositories, you can use GraphQL to delete a specific package version.{% data reusables.package_registry.no-graphql-to-delete-packages %} For more information about GraphQL support, see "[Deleting a version of a repository-scoped package with GraphQL](#deleting-a-version-of-a-repository-scoped-package-with-graphql)." {% endif %} @@ -54,17 +54,19 @@ shortTitle: 删除和恢复包 对于从仓库继承其访问权限的包,如果您拥有仓库管理权限,则可以删除包。 -{% data variables.product.prodname_registry %} 上仓库范围的包中包括以下包: -- npm -- RubyGems -- maven -- Gradle -- NuGet -{% ifversion not fpt or ghec %}- Docker 映像位于 `docker.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`{% endif %} +The {% data variables.product.prodname_registry %} registries below **only** use repository-scoped permissions: + + {% ifversion not fpt or ghec %}- Docker 映像位于 `docker.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`{% endif %} + {% ifversion packages-npm-v2 %}{% else %}- npm{% endif %} + - RubyGems 注册表 + - Apache Maven 注册表 + - NuGet 注册表 + +{% ifversion packages-npm-v2 %}For {% data variables.product.prodname_ghcr_and_npm_registry %}, you can choose to allow packages to be scoped to a user, an organization, or linked to a repository.{% endif %} {% ifversion fpt or ghec %} -要删除与仓库分开的具有粒度权限的软件包,例如存储在 `https://ghcr.io/OWNER/PACKAGE-NAME` 上的容器映像,您必须对该包具有管理员访问权限。 更多信息请参阅“[关于 {% data variables.product.prodname_registry %} 的权限](/packages/learn-github-packages/about-permissions-for-github-packages)”。 +To delete a package that has granular permissions separate from a repository, such as container images stored at `https://ghcr.io/OWNER/PACKAGE-NAME` or `https://npm.pkg.github.com/OWNER/PACKAGE-NAME`, you must have admin access to the package. 更多信息请参阅“[关于 {% data variables.product.prodname_registry %} 的权限](/packages/learn-github-packages/about-permissions-for-github-packages)”。 {% endif %} @@ -86,9 +88,7 @@ shortTitle: 删除和恢复包 对于从仓库继承其许可和访问权限的包,您可以使用 GraphQL 删除特定的包版本。 -{% ifversion fpt or ghec %} -对于在 `ghcr.io` 上的容器或 Docker 映像,GraphQL 不受支持,但您可以使用 REST API。 更多信息请参阅“[{% data variables.product.prodname_registry %} API](/rest/reference/packages)”。 -{% endif %} +{% data reusables.package_registry.no-graphql-to-delete-packages %}{% ifversion fpt or ghec %} You can however use the REST API. For more information, see the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)."{% endif %} 在 GraphQL API 中使用 `deletePackageVersion` 突变。 必须使用具有 `read:packages`、`delete:packages` 和 `repo` 作用域的令牌。 有关令牌的更多信息,请参阅“[关于 {% data variables.product.prodname_registry %}](/packages/publishing-and-managing-packages/about-github-packages#authenticating-to-github-packages)”。 diff --git a/translations/zh-CN/content/packages/learn-github-packages/introduction-to-github-packages.md b/translations/zh-CN/content/packages/learn-github-packages/introduction-to-github-packages.md index fc5090006ea3..5450ffcff9f3 100644 --- a/translations/zh-CN/content/packages/learn-github-packages/introduction-to-github-packages.md +++ b/translations/zh-CN/content/packages/learn-github-packages/introduction-to-github-packages.md @@ -51,7 +51,7 @@ For more information about the configuration of {% data variables.product.prodna | | | |--------------------|--------------------| -| Permissions | {% ifversion fpt or ghec %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_container_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted.

For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} | +| Permissions | {% ifversion fpt or ghec %}The permissions for a package are either inherited from the repository where the package is hosted or, for packages in the {% data variables.product.prodname_ghcr_and_npm_registry %}, they can be defined for specific user or organization accounts. For more information, see "[Configuring a package’s access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." {% else %}Each package inherits the permissions of the repository where the package is hosted.

For example, anyone with read permissions for a repository can install a package as a dependency in a project, and anyone with write permissions can publish a new package version.{% endif %} | | Visibility | {% data reusables.package_registry.public-or-private-packages %} | For more information, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages)." @@ -101,7 +101,9 @@ For more information about Docker and the {% data variables.product.prodname_con ## Managing packages {% ifversion fpt or ghec %} -You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. For more information, see the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." +You can delete a package in the {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} user interface or using the REST API. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and the "[{% data variables.product.prodname_registry %} API](/rest/reference/packages)." + +{% data reusables.package_registry.no-graphql-to-delete-packages %} {% endif %} {% ifversion ghes %} @@ -112,7 +114,9 @@ You can delete a private or public package in the {% data variables.product.prod You can delete a version of a package in the {% data variables.product.product_name %} user interface or using the GraphQL API. {% endif %} -When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and "[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." +When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. + +For more information, see {% ifversion ghes or ghae %}"[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" and {% endif %}"[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." You can configure webhooks to subscribe to package-related events, such as when a package is published or updated. For more information, see the "[`package` webhook event](/webhooks/event-payloads/#package)." diff --git a/translations/zh-CN/content/packages/learn-github-packages/viewing-packages.md b/translations/zh-CN/content/packages/learn-github-packages/viewing-packages.md index 5b7d3a04e906..40686593f004 100644 --- a/translations/zh-CN/content/packages/learn-github-packages/viewing-packages.md +++ b/translations/zh-CN/content/packages/learn-github-packages/viewing-packages.md @@ -23,15 +23,15 @@ versions: 查看包的权限取决于几个因素。 默认情况下,您可以查看您发布的所有包。 -仓库作用域的包从拥有该包的仓库继承权限和可见性。 下面的注册表使用此类权限:{% ifversion not fpt or ghec %} +仓库作用域的包从拥有该包的仓库继承权限和可见性。 The registries below **only** use this type of permissions:{% ifversion not fpt or ghec %} - Docker 注册表 (`docker.pkg.github.com`){% endif %} -- npm 注册表 +{% ifversion packages-npm-v2 %}{% else %}- npm registry{% endif %} - RubyGems 注册表 - Apache Maven 注册表 - NuGet 注册表 {% ifversion fpt or ghec %} -容器注册表提供粒度权限和可见性设置,可针对个人用户或组织帐户拥有的每个包进行自定义。 您可以选择使用粒度权限或连接包到仓库并继承它的权限。 更多信息请参阅“[将仓库连接到包](/packages/learn-github-packages/connecting-a-repository-to-a-package)”。 +The {% data variables.product.prodname_ghcr_and_npm_registry %} offer you the option of granular permissions and visibility settings that can be customized for each package owned by a personal user or organization account. 您可以选择使用粒度权限或连接包到仓库并继承它的权限。 更多信息请参阅“[将仓库连接到包](/packages/learn-github-packages/connecting-a-repository-to-a-package)”。 {% endif %} 更多信息请参阅“[关于 GitHub Packages 的权限](/packages/learn-github-packages/about-permissions-for-github-packages)”{% ifversion fpt or ghec %} 或“[配置包的访问控制和可见性](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)”。{% endif %} diff --git a/translations/zh-CN/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md b/translations/zh-CN/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md index abf40d843570..6b3f8fc7cddc 100644 --- a/translations/zh-CN/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md +++ b/translations/zh-CN/content/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions.md @@ -24,9 +24,9 @@ shortTitle: Publish & install with Actions You can extend the CI and CD capabilities of your repository by publishing or installing packages as part of your workflow. {% ifversion fpt or ghec %} -### Authenticating to the {% data variables.product.prodname_container_registry %} +### Authenticating to the {% data variables.product.prodname_ghcr_and_npm_registry %} -{% data reusables.package_registry.authenticate_with_pat_for_container_registry %} +{% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} {% endif %} @@ -40,7 +40,7 @@ You can reference the `GITHUB_TOKEN` in your workflow file using the {% raw %}`{ {% note %} -**Note:** Repository-owned packages include RubyGems, npm, Apache Maven, NuGet, {% ifversion fpt or ghec %}and Gradle. {% else %}Gradle, and Docker packages that use the package namespace `docker.pkg.github.com`.{% endif %} +**Note:** Some registries, such as RubyGems, {% ifversion packages-npm-v2 %}{% else %}npm, {% endif %}Apache Maven, NuGet, {% ifversion fpt or ghec %}and Gradle{% else %}Gradle, and Docker packages that use the package namespace `docker.pkg.github.com`{% endif %}, only allow repository-owned packages. With {% data variables.product.prodname_ghcr_and_npm_registry_full %} you can choose to allow packages to be owned by a user, an organization, or linked to a repository. {% endnote %} @@ -49,11 +49,11 @@ When you enable GitHub Actions, GitHub installs a GitHub App on your repository. {% data variables.product.prodname_registry %} allows you to push and pull packages through the `GITHUB_TOKEN` available to a {% data variables.product.prodname_actions %} workflow. {% ifversion fpt or ghec %} -## About permissions and package access for {% data variables.product.prodname_container_registry %} +## About permissions and package access for {% data variables.product.prodname_ghcr_and_npm_registry %} -The {% data variables.product.prodname_container_registry %} (`ghcr.io`) allows users to create and administer containers as free-standing resources at the organization level. Containers can be owned by an organization or personal account and you can customize access to each of your containers separately from repository permissions. +The {% data variables.product.prodname_ghcr_and_npm_registry_full %} allows users to create and administer packages as free-standing resources at the organization level. Packages can be owned by an organization or personal account and you can customize access to each of your packages separately from repository permissions. -All workflows accessing the {% data variables.product.prodname_container_registry %} should use the `GITHUB_TOKEN` instead of a personal access token. For more information about security best practices, see "[Security hardening for GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)." +All workflows accessing the {% data variables.product.prodname_ghcr_and_npm_registry %} should use the `GITHUB_TOKEN` instead of a personal access token. For more information about security best practices, see "[Security hardening for GitHub Actions](/actions/learn-github-actions/security-hardening-for-github-actions#using-secrets)." ## Default permissions and access settings for containers modified through workflows @@ -484,9 +484,9 @@ Installing packages hosted by {% data variables.product.prodname_registry %} thr {% data reusables.package_registry.actions-configuration %} {% ifversion fpt or ghec %} -## Upgrading a workflow that accesses `ghcr.io` +## Upgrading a workflow that accesses a registry using a PAT -The {% data variables.product.prodname_container_registry %} supports the `GITHUB_TOKEN` for easy and secure authentication in your workflows. If your workflow is using a personal access token (PAT) to authenticate to `ghcr.io`, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. +The {% data variables.product.prodname_ghcr_and_npm_registry %} support the `GITHUB_TOKEN` for easy and secure authentication in your workflows. If your workflow is using a personal access token (PAT) to authenticate to the registry, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. For more information about the `GITHUB_TOKEN`, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)." @@ -504,9 +504,9 @@ Using the `GITHUB_TOKEN` instead of a PAT, which includes the `repo` scope, incr {% endnote %} 1. Optionally, using the "role" drop-down menu, select the default access level that you'd like the repository to have to your container image. ![Permission access levels to give to repositories](/assets/images/help/package-registry/repository-permission-options-for-package-access-through-actions.png) -1. Open your workflow file. On the line where you log in to `ghcr.io`, replace your PAT with {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. +1. Open your workflow file. On the line where you log in to the registry, replace your PAT with {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %}. -For example, this workflow publishes a Docker image using {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} to authenticate. +For example, this workflow publishes a Docker image to the {% data variables.product.prodname_container_registry %} and uses {% raw %}`${{ secrets.GITHUB_TOKEN }}`{% endraw %} to authenticate. ```yaml{:copy} name: Demo Push diff --git a/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md b/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md index 02708a404d0d..98ac905c0ad4 100644 --- a/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md +++ b/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md @@ -42,7 +42,9 @@ When installing or publishing a Docker image, the {% data variables.product.prod ## Authenticating to the {% data variables.product.prodname_container_registry %} -{% data reusables.package_registry.authenticate_with_pat_for_container_registry %} +{% ifversion fpt or ghec or ghes > 3.4 %} +To authenticate to the {% data variables.product.prodname_container_registry %} (`ghcr.io`) within a {% data variables.product.prodname_actions %} workflow, use the `GITHUB_TOKEN` for the best security and experience. {% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} +{% endif %} {% ifversion ghes %}Ensure that you replace `HOSTNAME` with {% data variables.product.product_location_enterprise %} hostname or IP address in the examples below.{% endif %} diff --git a/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md b/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md index 993e933de3bb..8007cd2b6f96 100644 --- a/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md +++ b/translations/zh-CN/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md @@ -21,6 +21,8 @@ shortTitle: npm registry {% data reusables.package_registry.admins-can-configure-package-types %} +{% ifversion packages-npm-v2 %} +{% else %} ## Limits for published npm versions If you publish over 1,000 npm package versions to {% data variables.product.prodname_registry %}, you may see performance issues and timeouts occur during usage. @@ -28,12 +30,17 @@ If you publish over 1,000 npm package versions to {% data variables.product.prod In the future, to improve performance of the service, you won't be able to publish more than 1,000 versions of a package on {% data variables.product.prodname_dotcom %}. Any versions published before hitting this limit will still be readable. If you reach this limit, consider deleting package versions or contact Support for help. When this limit is enforced, our documentation will be updated with a way to work around this limit. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" or "[Contacting Support](/packages/learn-github-packages/about-github-packages#contacting-support)." +{% endif %} ## Authenticating to {% data variables.product.prodname_registry %} {% data reusables.package_registry.authenticate-packages %} -{% data reusables.package_registry.authenticate-packages-github-token %} +{% ifversion packages-npm-v2 %} +{% data reusables.package_registry.authenticate_with_pat_for_v2_registry %} + +You can also choose to give access permissions to packages independently for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_actions %}. For more information, see "[Ensuring Codespaces access to your package](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-codespaces-access-to-your-package) and [Ensuring workflow access to your package](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-workflow-access-to-your-package)." +{% endif %} ### Authenticating with a personal access token @@ -94,12 +101,24 @@ $ npm login --scope=@OWNER --registry=https://HOSTNAME/_regist {% endnote %} +{% ifversion packages-npm-v2 %} +The {% data variables.product.prodname_registry %} registry stores npm packages within your organization or personal account, and allows you to associate a package with a repository. You can choose whether to inherit permissions from a repository, or set granular permissions independently of a repository. +{% endif %} + By default, {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the name field of the *package.json* file. For example, you would publish a package named `@my-org/test` to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. If you're running [npm v8.5.3](https://github.com/npm/cli/releases/tag/v8.5.3) or later, you can add a summary for the package listing page by including a *README.md* file in your package directory. For more information, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" and "[How to create Node.js Modules](https://docs.npmjs.com/getting-started/creating-node-modules)" in the npm documentation. You can publish multiple packages to the same {% data variables.product.prodname_dotcom %} repository by including a `URL` field in the *package.json* file. For more information, see "[Publishing multiple packages to the same repository](#publishing-multiple-packages-to-the-same-repository)." +{% ifversion fpt or ghec %} +When a package is published, it isn't automatically linked to a repository. You can however choose to link your published package to a repository using the user interface or command line. For more information, see "[Connecting a repository to a package](/packages/learn-github-packages/connecting-a-repository-to-a-package)." +{% endif %} + You can set up the scope mapping for your project using either a local *.npmrc* file in the project or using the `publishConfig` option in the *package.json*. {% data variables.product.prodname_registry %} only supports scoped npm packages. Scoped packages have names with the format of `@owner/name`. Scoped packages always begin with an `@` symbol. You may need to update the name in your *package.json* to use the scoped name. For example, `"name": "@codertocat/hello-world-npm"`. +{% ifversion packages-npm-v2 %} +When you first publish a package, the default visibility is private. When a package is linked to repository, the package visibility is dependent on the repository's visibility. To change the visibility or set access permissions, see "[Configuring a package's access control and visibility](/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility)." +{% endif %} + {% data reusables.package_registry.viewing-packages %} ### Publishing a package using a local *.npmrc* file diff --git a/translations/zh-CN/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md b/translations/zh-CN/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md index f059be99c258..011aa305cace 100644 --- a/translations/zh-CN/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md +++ b/translations/zh-CN/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md @@ -46,7 +46,7 @@ To set up a `www` or custom subdomain, such as `www.example.com` or `blog.exampl {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} 4. 在 "Custom domain(自定义域)"下,输入自定义域,然后单击 **Save(保存)**。 If you are publishing your site from a branch, this will create a commit that adds a `CNAME` file to the root of your source branch. If you are publishing your site with a custom {% data variables.product.prodname_actions %} workflow , no `CNAME` file is created. For more information about your publishing source, see "[Configuring a publishing source for your GitHub Pages site](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." ![保存自定义域按钮](/assets/images/help/pages/save-custom-subdomain.png) -5. 导航到您的 DNS 提供程序并创建 `CNAME` 记录,使子域指向您站点的默认域。 例如,如果要对您的用户站点使用子域 `www.example.com`,您可以创建 `CNAME` 记录,使 `www.example.com` 指向 `.github.io`。 如果要对您的组织站点使用子域 `www.anotherexample.com`,您可以创建 `CNAME` 记录,使 `www.anotherexample.com` 指向 `.github.io`。 `CNAME` 记录应该始终指向 `.github.io` 或 `.github.io`,不包括仓库名称。 {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} +5. 导航到您的 DNS 提供程序并创建 `CNAME` 记录,使子域指向您站点的默认域。 例如,如果要对您的用户站点使用子域 `www.example.com`,您可以创建 `CNAME` 记录,使 `www.example.com` 指向 `.github.io`。 如果要对您的组织站点使用子域 `another.example.com`,您可以创建 `CNAME` 记录,使 `another.example.com` 指向 `.github.io`。 `CNAME` 记录应该始终指向 `.github.io` 或 `.github.io`,不包括仓库名称。 {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} {% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %} {% data reusables.command_line.open_the_multi_os_terminal %} diff --git a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md index 7d249705e4cf..ac14de0bdfcd 100644 --- a/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md +++ b/translations/zh-CN/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request.md @@ -18,7 +18,7 @@ shortTitle: 自动合并 PR ## 关于自动合并 -如果启用拉取请求自动合并,则拉取请求在满足所有必需审查并且状态检查通过时将自动合并。 自动合并使您无需等待满足要求,可以继续执行其他任务。 +If you enable auto-merge for a pull request, the pull request will merge automatically when all required reviews are met and all required status checks have passed. 自动合并使您无需等待满足要求,可以继续执行其他任务。 在使用拉取请求自动合并之前,必需对仓库启用自动合并。 更多信息请参阅“[管理仓库中的拉取请求自动合并](/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository)”。 diff --git a/translations/zh-CN/content/rest/apps/installations.md b/translations/zh-CN/content/rest/apps/installations.md index a95d0eb5dd4c..3a46f4ce600f 100644 --- a/translations/zh-CN/content/rest/apps/installations.md +++ b/translations/zh-CN/content/rest/apps/installations.md @@ -17,4 +17,4 @@ versions: _安装设施_是指已安装该应用程序的任何用户或组织帐户。 有关如何验证为安装设施和限制访问特定仓库的信息,请参阅“[验证为安装设施](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)”。 -要列出组织的所有 GitHub 应用程序安装设施,请参阅“[列出组织的应用程序安装设施](/rest/reference/orgs#list-app-installations-for-an-organization)”。 +要列出组织的所有 GitHub 应用程序安装设施,请参阅“[列出组织的应用程序安装设施](/rest/orgs/orgs#list-app-installations-for-an-organization)”。 diff --git a/translations/zh-CN/content/rest/guides/getting-started-with-the-checks-api.md b/translations/zh-CN/content/rest/guides/getting-started-with-the-checks-api.md index 2c60bf90f864..fa8cc66f454f 100644 --- a/translations/zh-CN/content/rest/guides/getting-started-with-the-checks-api.md +++ b/translations/zh-CN/content/rest/guides/getting-started-with-the-checks-api.md @@ -1,6 +1,6 @@ --- -title: Getting started with the Checks API -intro: 'The Check Runs API enables you to build GitHub Apps that run powerful checks against code changes in a repository. You can create apps that perform continuous integration, code linting, or code scanning services and provide detailed feedback on commits.' +title: 检查 API 入门指南 +intro: 检查运行 API 使您能够构建 GitHub 应用程序,以针对仓库中的代码更改运行强大的检查。 您可以创建应用程序以执行持续集成 、代码分析或代码扫描服务,并提供有关提交的详细反馈。 versions: fpt: '*' ghes: '*' @@ -8,58 +8,58 @@ versions: ghec: '*' topics: - API -shortTitle: Get started - Checks API +shortTitle: 开始 - 检查 API --- -## Overview +## 概览 -Rather than binary pass/fail build statuses, GitHub Apps can report rich statuses, annotate lines of code with detailed information, and re-run tests. The Checks API functionality is available exclusively to your GitHub Apps. +GitHub 应用程序可以报告丰富的状态信息、提供详细的代码行注释以及重新运行测试,而不是提供二进制的通过/失败构建状态。 Checks API 功能专用于您的 GitHub 应用程序。 -For an example of how to use the Checks API with a {% data variables.product.prodname_github_app %}, see "[Creating CI tests with the Checks API](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/)." +关于如何将检查 API 用于 {% data variables.product.prodname_github_app %} 的示例,请参阅“[使用检查 API 创建 CI 测试](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/)”。 -## About check suites +## 关于检查套件 -When someone pushes code to a repository, GitHub creates a check suite for the last commit. A check suite is a collection of the [check runs](/rest/reference/checks#check-runs) created by a single GitHub App for a specific commit. Check suites summarize the status and conclusion of the check runs that a suite includes. +当有人向仓库推送代码时,GitHub 会为最新的提交创建一个检查套件。 检查套件是单个 GitHub 应用程序为特定提交而创建的[检查运行](/rest/reference/checks#check-runs)的集合。 检查套件汇总了套件所含检查运行的状态和结论。 -![Check suites workflow](/assets/images/check_suites.png) +![检查套件工作流程](/assets/images/check_suites.png) -The check suite reports the highest priority check run `conclusion` in the check suite's `conclusion`. For example, if three check runs have conclusions of `timed_out`, `success`, and `neutral` the check suite conclusion will be `timed_out`. +检查套件在其 `conclusion` 中报告优先级最高的检查运行 `conclusion` 。 例如,如果三个检查运行的结论分别为 `timed_out`、`success` 和 `neutral`,则检查套件的结论将为 `timed_out`。 -By default, GitHub creates a check suite automatically when code is pushed to the repository. This default flow sends the `check_suite` event (with `requested` action) to all GitHub App's that have the `checks:write` permission. When your GitHub App receives the `check_suite` event, it can create new check runs for the latest commit. GitHub automatically adds new check runs to the correct [check suite](/rest/reference/checks#check-suites) based on the check run's repository and SHA. +默认情况下,当代码被推送到仓库时,GitHub 会自动创建一个检查套件。 此默认流程会将 `check_suite` 事件(使用 `requested` 操作)发送到具有 `checks:write` 权限的所有 GitHub 应用程序。 当您的 GitHub 应用程序收到 `check_suite` 事件时,它可以为最新的提交创建新的检查运行。 GitHub 根据检查运行的仓库和 SHA,自动将新的检查运行添加到适当的[检查套件](/rest/reference/checks#check-suites)中。 -If you don't want to use the default automatic flow, you can control when you create check suites. To change the default settings for the creation of check suites, use the [Update repository preferences for check suites](/rest/reference/checks#update-repository-preferences-for-check-suites) endpoint. All changes to the automatic flow settings are recorded in the audit log for the repository. If you have disabled the automatic flow, you can create a check suite using the [Create a check suite](/rest/reference/checks#create-a-check-suite) endpoint. You should continue to use the [Create a check run](/rest/reference/checks#create-a-check-run) endpoint to provide feedback on a commit. +如果您不想使用默认的自动流程,您可以控制何时创建检查套件。 要更改用于创建检查套件的默认设置,请使用[更新检查套件的仓库首选项](/rest/reference/checks#update-repository-preferences-for-check-suites)端点。 对自动流程设置的所有更改都被记录在仓库的审核日志中。 如果您禁用了自动流程,您可以使用[创建检查套件](/rest/reference/checks#create-a-check-suite)端点来创建一个检查套件。 您应该继续使用[创建检查运行](/rest/reference/checks#create-a-check-run)端点来提供对提交的反馈。 {% data reusables.apps.checks-availability %} -To use the check suites API, the GitHub App must have the `checks:write` permission and can also subscribe to the [check_suite](/webhooks/event-payloads/#check_suite) webhook. +要使用检查套件 API,GitHub 应用程序必须具有 `checks:write` 权限并且可以订阅 [check_suite](/webhooks/event-payloads/#check_suite) web 挂钩。 {% data reusables.shortdesc.authenticating_github_app %} -## About check runs +## 关于检查运行 -A check run is an individual test that is part of a check suite. Each run includes a status and conclusion. +检查运行是检查套件中的单个测试。 每个运行都包含状态和结论。 -![Check runs workflow](/assets/images/check_runs.png) +![检查运行工作流程](/assets/images/check_runs.png) -If a check run is in a incomplete state for more than 14 days, then the check run's `conclusion` becomes `stale` and appears on {% data variables.product.prodname_dotcom %} as stale with {% octicon "issue-reopened" aria-label="The issue-reopened icon" %}. Only {% data variables.product.prodname_dotcom %} can mark check runs as `stale`. For more information about possible conclusions of a check run, see the [`conclusion` parameter](/rest/reference/checks#create-a-check-run--parameters). +If a check run is in an incomplete state for more than 14 days, then the check run's `conclusion` becomes `stale` and appears on {% data variables.product.prodname_dotcom %} as stale with {% octicon "issue-reopened" aria-label="The issue-reopened icon" %}. 只有 {% data variables.product.prodname_dotcom %} 可以将检查运行标记为 `stale`。 有关检查运行之可能结论的更多信息,请参阅 [`conclusion` 参数](/rest/reference/checks#create-a-check-run--parameters)。 -As soon as you receive the [`check_suite`](/webhooks/event-payloads/#check_suite) webhook, you can create the check run, even if the check is not complete. You can update the `status` of the check run as it completes with the values `queued`, `in_progress`, or `completed`, and you can update the `output` as more details become available. A check run can contain timestamps, a link to more details on your external site, detailed annotations for specific lines of code, and information about the analysis performed. +一旦收到 [`check_suite`](/webhooks/event-payloads/#check_suite) web 挂钩,您即可创建检查运行,即使检查尚未完成。 您可以在检查运行完成时使用值 `queued`、`in_progress` 或 `completed` 来更新其 `status`, 并且可以在更多详细信息可用时更新 `output`。 检查运行可以包含时间戳、指向外部站点上更多详细信息的链接、特定代码行的详细注释以及有关所执行分析的信息。 -![Check run annotation](/assets/images/check_run_annotations.png) +![检查运行注释](/assets/images/check_run_annotations.png) -A check can also be manually re-run in the GitHub UI. See "[About status checks](/articles/about-status-checks#checks)" for more details. When this occurs, the GitHub App that created the check run will receive the [`check_run`](/webhooks/event-payloads/#check_run) webhook requesting a new check run. If you create a check run without creating a check suite, GitHub creates the check suite for you automatically. +还可以在 GitHub UI 中手动重新运行检查。 更多信息请参阅“[关于状态检查](/articles/about-status-checks#checks)”。 发生这种情况时,创建检查运行的 GitHub 应用程序将收到请求新检查运行的 [`check_run`](/webhooks/event-payloads/#check_run) web 挂钩。 如果您创建检查运行时没有创建检查套件,GitHub 将自动为您创建检查套件。 {% data reusables.apps.checks-availability %} -To use the Check Runs API, the GitHub App must have the `checks:write` permission and can also subscribe to the [check_run](/webhooks/event-payloads#check_run) webhook. +要使用检查运行 API,GitHub 应用程序必须具有 `checks:write` 权限并且可以订阅 [ccheck_run](/webhooks/event-payloads#check_run) web 挂钩。 -## Check runs and requested actions +## 检查运行和请求的操作 -When you set up a check run with requested actions (not to be confused with {% data variables.product.prodname_actions %}), you can display a button in the pull request view on {% data variables.product.prodname_dotcom %} that allows people to request your {% data variables.product.prodname_github_app %} to perform additional tasks. +在设置带有请求操作(不要与 {% data variables.product.prodname_actions %} 混淆)的检查运行时,您可以在 {% data variables.product.prodname_dotcom %} 上的拉取请求视图中显示一个按钮,以允许用户请求您的 {% data variables.product.prodname_github_app %} 执行额外任务。 -For example, a code linting app could use requested actions to display a button in a pull request to automatically fix detected syntax errors. +例如,代码分析应用程序可以使用请求的操作在拉取请求中显示一个按钮,以自动修复检测到的语法错误。 -To create a button that can request additional actions from your app, use the [`actions` object](/rest/reference/checks#create-a-check-run--parameters) when you [Create a check run](/rest/reference/checks/#create-a-check-run). For example, the `actions` object below displays a button in a pull request with the label "Fix this." The button appears after the check run completes. +要创建可从您的程序请求额外操作的按钮,请在[创建检查运行](/rest/reference/checks/#create-a-check-run)时使用 [`actions` 对象](/rest/reference/checks#create-a-check-run--parameters)。 例如,下面的 `actions` 对象在拉取请求中显示一个按钮,标签为“Fix this(修复此问题)”。 该按钮在检查运行完成后显示。 ```json "actions": [{ @@ -69,14 +69,14 @@ To create a button that can request additional actions from your app, use the [` }] ``` - ![Check run requested action button](/assets/images/github-apps/github_apps_checks_fix_this_button.png) + ![检查运行请求操作按钮](/assets/images/github-apps/github_apps_checks_fix_this_button.png) -When a user clicks the button, {% data variables.product.prodname_dotcom %} sends the [`check_run.requested_action` webhook](/webhooks/event-payloads/#check_run) to your app. When your app receives a `check_run.requested_action` webhook event, it can look for the `requested_action.identifier` key in the webhook payload to determine which button was clicked and perform the requested task. +当用户单击该按钮时,{% data variables.product.prodname_dotcom %} 会将 [`check_run.requested_action` web 挂钩](/webhooks/event-payloads/#check_run)发送到您的应用程序。 当您的应用程序收到 `check_run.requested_action` web 挂钩事件时,它可以在 web 挂钩有效负载中查找 `requested_action.identifier` 键,以确定单击了哪个按钮,并执行请求的任务。 -For a detailed example of how to set up requested actions with the Checks API, see "[Creating CI tests with the Checks API](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/#part-2-creating-the-octo-rubocop-ci-test)." +关于如何使用检查 API 设置请求操作的详细示例,请参阅“[使用检查 API 创建 CI 测试](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/#part-2-creating-the-octo-rubocop-ci-test)”。 {% ifversion fpt or ghec %} -## Retention of checks data +## 检查数据的保留 {% data reusables.pull_requests.retention-checks-data %} {% endif %} diff --git a/translations/zh-CN/content/rest/guides/getting-started-with-the-rest-api.md b/translations/zh-CN/content/rest/guides/getting-started-with-the-rest-api.md index 5a497e673738..76e75dfedd7a 100644 --- a/translations/zh-CN/content/rest/guides/getting-started-with-the-rest-api.md +++ b/translations/zh-CN/content/rest/guides/getting-started-with-the-rest-api.md @@ -166,7 +166,7 @@ curl --request GET \ {% note %} -**Note:** In most cases, you can use `Authorization: Bearer` or `Authorization: token`. JSON web tokens (JWTs) will only work with `Authorization: Bearer`. +**注意:**{% data reusables.getting-started.bearer-vs-token %} {% endnote %} diff --git a/translations/zh-CN/content/rest/overview/other-authentication-methods.md b/translations/zh-CN/content/rest/overview/other-authentication-methods.md index b75ab9852500..d8147fdb5d4f 100644 --- a/translations/zh-CN/content/rest/overview/other-authentication-methods.md +++ b/translations/zh-CN/content/rest/overview/other-authentication-methods.md @@ -86,10 +86,16 @@ If you have two-factor authentication enabled, make sure you understand how to [ {% endnote %} +{% note %} + +**Note:** {% data reusables.getting-started.bearer-vs-token %} + +{% endnote %} + If you're using the API to access an organization that enforces [SAML SSO][saml-sso] for authentication, you'll need to create a personal access token (PAT) and [authorize the token][allowlist] for that organization. Visit the URL specified in `X-GitHub-SSO` to authorize the token for the organization. ```shell -$ curl -v -H "Authorization: token TOKEN" {% data variables.product.api_url_pre %}/repos/octodocs-test/test +$ curl -v -H "Authorization: Bearer TOKEN" {% data variables.product.api_url_pre %}/repos/octodocs-test/test > X-GitHub-SSO: required; url=https://github.com/orgs/octodocs-test/sso?authorization_request=AZSCKtL4U8yX1H3sCQIVnVgmjmon5fWxks5YrqhJgah0b2tlbl9pZM4EuMz4 { @@ -101,7 +107,7 @@ $ curl -v -H "Authorization: token TOKEN" {% data variables.product.api When requesting data that could come from multiple organizations (for example, [requesting a list of issues created by the user][user-issues]), the `X-GitHub-SSO` header indicates which organizations require you to authorize your personal access token: ```shell -$ curl -v -H "Authorization: token TOKEN" {% data variables.product.api_url_pre %}/user/issues +$ curl -v -H "Authorization: Bearer TOKEN" {% data variables.product.api_url_pre %}/user/issues > X-GitHub-SSO: partial-results; organizations=21955855,20582480 ``` diff --git a/translations/zh-CN/content/rest/overview/resources-in-the-rest-api.md b/translations/zh-CN/content/rest/overview/resources-in-the-rest-api.md index 19c7f3d34e50..033f0ccd7897 100644 --- a/translations/zh-CN/content/rest/overview/resources-in-the-rest-api.md +++ b/translations/zh-CN/content/rest/overview/resources-in-the-rest-api.md @@ -91,7 +91,7 @@ $ curl -u "username" {% data variables.product.api_url_pre %} ### OAuth2 token (sent in a header) ```shell -$ curl -H "Authorization: token OAUTH-TOKEN" {% data variables.product.api_url_pre %} +$ curl -H "Authorization: Bearer OAUTH-TOKEN" {% data variables.product.api_url_pre %} ``` {% note %} @@ -100,6 +100,12 @@ Note: GitHub recommends sending OAuth tokens using the Authorization header. {% endnote %} +{% note %} + +**Note:** {% data reusables.getting-started.bearer-vs-token %} + +{% endnote %} + Read [more about OAuth2](/apps/building-oauth-apps/). Note that OAuth2 tokens can be acquired using the [web application flow](/developers/apps/authorizing-oauth-apps#web-application-flow) for production applications. {% ifversion fpt or ghes or ghec %} diff --git a/translations/zh-CN/content/rest/overview/troubleshooting.md b/translations/zh-CN/content/rest/overview/troubleshooting.md index 7d4d75cf9fe7..ef3ee5f34f9a 100644 --- a/translations/zh-CN/content/rest/overview/troubleshooting.md +++ b/translations/zh-CN/content/rest/overview/troubleshooting.md @@ -44,13 +44,13 @@ curl -u my_user:my_password https://api.github.com/user/repos 相反,在测试端点或进行本地开发时使用[个人访问令牌](/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line): ```bash -curl -H 'Authorization: token my_access_token' https://api.github.com/user/repos +curl -H 'Authorization: Bearer my_access_token' https://api.github.com/user/repos ``` 对于 OAuth 应用程序,您应该使用 [web 应用程序流程](/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow)生成 OAuth 令牌以用于 API 调用的标头: ```bash -curl -H 'Authorization: token my-oauth-token' https://api.github.com/user/repos +curl -H 'Authorization: Bearer my-oauth-token' https://api.github.com/user/repos ``` ## 超时 diff --git a/translations/zh-CN/content/rest/quickstart.md b/translations/zh-CN/content/rest/quickstart.md index 921fba0090c8..8fc2ac3c4008 100644 --- a/translations/zh-CN/content/rest/quickstart.md +++ b/translations/zh-CN/content/rest/quickstart.md @@ -284,7 +284,7 @@ jobs: {% note %} - **Note:** In most cases, you can use `Authorization: Bearer` or `Authorization: token`. JSON web tokens (JWTs) only work with `Authorization: Bearer`. + **注意:**{% data reusables.getting-started.bearer-vs-token %} {% endnote %} diff --git a/translations/zh-CN/content/rest/teams/external-groups.md b/translations/zh-CN/content/rest/teams/external-groups.md index 0fa02a12f71f..77405ae5f327 100644 --- a/translations/zh-CN/content/rest/teams/external-groups.md +++ b/translations/zh-CN/content/rest/teams/external-groups.md @@ -19,7 +19,7 @@ miniTocMaxHeadingLevel: 3 **注意:** -- 外部组 API 仅适用于属于使用 {% data variables.product.prodname_emus %} 的企业中的组织。 更多信息请参阅“[关于企业管理用户](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)”。 +- The external groups API is only available for organizations that are part of an enterprise using {% data variables.product.prodname_emus %}. 更多信息请参阅“[关于企业管理用户](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)”。 - 如果您的组织使用团队同步,则可以使用团队同步 API。 更多信息请参阅“[团队同步 API](#team-synchronization)”。 {% endnote %} diff --git a/translations/zh-CN/content/rest/users/index.md b/translations/zh-CN/content/rest/users/index.md index 48230c7a08fa..70097ff21a04 100644 --- a/translations/zh-CN/content/rest/users/index.md +++ b/translations/zh-CN/content/rest/users/index.md @@ -19,5 +19,6 @@ children: - /followers - /gpg-keys - /keys + - /ssh-signing-keys --- diff --git a/translations/zh-CN/content/rest/users/ssh-signing-keys.md b/translations/zh-CN/content/rest/users/ssh-signing-keys.md new file mode 100644 index 000000000000..33f57a42788a --- /dev/null +++ b/translations/zh-CN/content/rest/users/ssh-signing-keys.md @@ -0,0 +1,13 @@ +--- +title: SSH signing keys +intro: '' +versions: + fpt: '*' + ghes: '>=3.7' + ghec: '*' +topics: + - API +miniTocMaxHeadingLevel: 3 +allowTitleToDifferFromFilename: true +--- + diff --git a/translations/zh-CN/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md b/translations/zh-CN/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md index 6c68d34ef34c..f663f69d1a2b 100644 --- a/translations/zh-CN/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md +++ b/translations/zh-CN/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md @@ -21,9 +21,9 @@ topics: 通过使用附加产品和特性,您也同意下面列出的适用的 GitHub 条款。 违反 GitHub 关于附加产品和特性的条款便是违反协议。 在本文未定义的任何大写术语采用“协议”中的含义。 **对于企业用户** -- **GitHub Enterprise Cloud** 用户可以访问以下附加产品和特性:Actions、Advanced Security、Advisory Database、Codespaces、Dependabot Preview、GitHub Enterprise Importer、Learning Lab、Packages 和 Pages。 +- **GitHub Enterprise Cloud** users may have access to the following Additional Products and Features: Actions, Advanced Security, Advisory Database, Codespaces, Dependabot Preview, GitHub Enterprise Importer, Packages, and Pages. -- **GitHub Enterprise Server** 用户可以访问以下附加产品和特性:Actions、Advanced Security、Advisory Database、Connect、Dependabot Preview、GitHub Enterprise Importer、Learning Lab、Packages、Pages 和 SQL Server Images。 +- **GitHub Enterprise Server** users may have access to the following Additional Products and Features: Actions, Advanced Security, Advisory Database, Connect, Dependabot Preview, GitHub Enterprise Importer, Packages, Pages, and SQL Server Images. - **GitHub AE** 用户可以访问以下附加产品和特性:Actions、Advanced Security、Advisory Database、Connect、Dependabot Preview、GitHub Enterprise Importer、Packages 和 Pages。 @@ -106,19 +106,6 @@ GitHub Copilot (i) 可能会根据您的首选遥测设置收集您的代码片 ## GitHub Enterprise Importer Importer 是一个从其他来源导出数据到 GitHub 平台的框架。 Importer“按原样”提供。 -## Learning Lab -GitHub Learning Lab 提供已编入GitHub 的免费交互式课程,并提供即时自动反馈和帮助。 - -*课程材料。*GitHub 拥有其提供的任何课程材料,并授予您全球、非独占、有限期、不可转让、免版税的许可,允许您出于与 Learning Lab 使用相关的内部业务目的而复制、维护、使用和运行这些材料。 - -开源许可证条款可能适用于课程材料中提供的源代码部分。 - -您创建的课程材料归您所有,但是您授予 GitHub 全球、非独占、永久、不可转让、免版税的许可,允许 GitHub 复制、维护、使用、托管以及在服务上运行这些课程材料。 - -您对 GitHub 课程材料的使用以及对自己课程材料的创建和存储并不构成对任一方各自知识产权的共同所有权。 - -个人数据的使用受 [GitHub 隐私声明](/github/site-policy/github-privacy-statement)管制。 - ## npm npm 是一种软件包托管服务,允许您私下或公开托管软件包,并将包用作项目中的依赖项。 npm 是 JavaScript 生态系统的记录注册表。 npm 公共注册表可以免费使用,但客户如果想要发布私有包或使用团队管理私有包,则需收取费用。 [npm 文档](https://docs.npmjs.com/) 包含帐户类型限制以及如何管理[私有包](https://docs.npmjs.com/about-private-packages)和[组织](https://docs.npmjs.com/organizations)的详细信息。 [开放源码条款](https://www.npmjs.com/policies/open-source-terms)概述了可接受的 npm 注册表的使用。 npm [solo](https://www.npmjs.com/policies/solo-plan) 和 [org](https://www.npmjs.com/policies/orgs-plan) 计划都有补充条款。 npm [使用条款](https://www.npmjs.com/policies/terms) 适用于您的 npm 使用。 diff --git a/translations/zh-CN/content/site-policy/privacy-policies/github-privacy-statement.md b/translations/zh-CN/content/site-policy/privacy-policies/github-privacy-statement.md index 03e6b165be86..9316fd87a698 100644 --- a/translations/zh-CN/content/site-policy/privacy-policies/github-privacy-statement.md +++ b/translations/zh-CN/content/site-policy/privacy-policies/github-privacy-statement.md @@ -15,7 +15,7 @@ topics: - Legal --- -生效日期:2022 年 5 月 31 日 +Effective date: September 1, 2022 感谢您将源代码、项目和个人数据委托给 GitHub Inc. 或 GitHub B.V.(“GitHub”、“我们”或“我们的”)。 本隐私声明解释了我们在收集、使用和披露您的数据方面的做法,包括我们收集和处理的与我们的网站以及 GitHub 提供的任何应用程序、软件、产品和服务(包括任何 Beta 预览版)相关的任何个人数据(统称为“服务”)。 @@ -25,28 +25,28 @@ topics: ## 精简版 -我们按照本隐私声明所述来使用您的个人信息。 无论您身在何方、居于何处、是何国籍,我们为世界各地的所有用户提供同样的高标准隐私保护,不论其原籍国或所在地。 +我们按照本隐私声明所述来使用您的个人信息。 No matter where you are, where you live, or what your citizenship is, you have the same high standard of privacy protection when using GitHub's products as all our users around the world, regardless of their country of origin or location. 要查看我们给加利福尼亚州居民的隐私声明,请转到 [GitHub 关于加利福尼亚州消费者隐私法案的声明](#githubs-notice-to-california-residents)或向下滚动。 ## 摘要 -| 节 | 说明 | -| ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| [谁负责处理您的信息](#who-is-responsible-for-the-processing-of-your-information) | 除有限的例外情况外,GitHub 是负责处理与网站或服务相关的个人数据的控制者和实体。 | -| [GitHub 收集哪些信息](#what-information-github-collects) | GitHub 直接从您的注册、付款、交易和用户个人资料中收集信息。 我们还自动从您的使用信息、cookie 和设备信息中收集,但在必要时会征得您的同意。 GitHub 还可能从第三方收集个人数据。 我们只收集极少量的必要个人数据,除非您自己选择提供更多信息。 | -| [GitHub 如何使用您的信息](#how-github-uses-your-information) | 在本节中,我们将介绍我们使用您的信息的方式,包括为您提供服务、与您沟通、出于安全性和合规性目的,以及改进我们的网站或服务或开发我们网站或服务的新特性和功能。 我们还介绍了在法律要求的情况下处理个人信息的法律依据。 | -| [我们如何分享所收集的信息](#how-we-share-the-information-we-collect) | 在以下情况下,我们可能会与第三方分享您的信息:经您同意、与我们的服务提供商分享、出于安全目的、为履行我们的法律义务,或者公司实体或业务单位的控制权发生变更或出售。 我们不会出售您的个人信息,也不会在 GitHub 上发布广告。 | -| [您对我们处理您的个人数据的选择](#your-choices-regarding-our-processing-of-your-personal-data) | 我们为您提供访问、更改或删除个人信息的途径。 | -| [Cookie](#cookies) | 我们仅使用绝对必要的 cookie 来提供、保护和改进我们的网站或服务,或开发我们网站或服务的新特性和功能。 我们提供了一个非常透明地说明此技术的网页。 我们不会向第三方分析服务发送任何信息。 | -| [GitHub 如何保护您的信息](#how-github-secures-your-information) | 我们采取一切合理必要的措施来保护您在 GitHub 上个人数据的机密性、完整性和可用性,并保护我们服务器的弹性。 | -| [沟通偏好](#communication-preferences) | 我们通过电子邮件与您通信。 您可以在帐户设置中或通过联系我们来控制我们与您联系的方式。 | -| [解决投诉](#resolving-complaints) | 万一我们无法快速彻底地解决隐私问题,我们提供一条解决争议的途径。 | -| [隐私声明的变更](#changes-to-our-privacy-statement) | 如果本隐私声明发生重大变更,我们会在任何此类变更生效之前 30 天通知您。 您也可以在我们的站点政策仓库中跟踪变更。 | -| [许可](#license) | 本隐私声明的许可采用[知识共享零许可](https://creativecommons.org/publicdomain/zero/1.0/)原则。 | -| [联系 GitHub](#contacting-github) | 如果您对我们的隐私声明有疑问,请随时联系我们。 | -| [翻译](#translations) | 我们提供本隐私声明的一些翻译版本的链接。 | +| 节 | 说明 | +| ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [谁负责处理您的信息](#who-is-responsible-for-the-processing-of-your-information) | Subject to limited exceptions, GitHub is the controller and entity responsible for the processing of your personal data in connection with the Website or Service if you are in North America. For individuals outside North America the data controller is GitHub B.V. | +| [GitHub 收集哪些信息](#what-information-github-collects) | GitHub 直接从您的注册、付款、交易和用户个人资料中收集信息。 我们还自动从您的使用信息、cookie 和设备信息中收集,但在必要时会征得您的同意。 GitHub 还可能从第三方收集个人数据。 我们只收集极少量的必要个人数据,除非您自己选择提供更多信息。 | +| [GitHub 如何使用您的信息](#how-github-uses-your-information) | 在本节中,我们将介绍我们使用您的信息的方式,包括为您提供服务、与您沟通、出于安全性和合规性目的,以及改进我们的网站或服务或开发我们网站或服务的新特性和功能。 我们还介绍了在法律要求的情况下处理个人信息的法律依据。 | +| [我们如何分享所收集的信息](#how-we-share-the-information-we-collect) | 在以下情况下,我们可能会与第三方分享您的信息:经您同意、与我们的服务提供商分享、出于安全目的、为履行我们的法律义务,或者公司实体或业务单位的控制权发生变更或出售。 我们不会出售您的个人信息,也不会在 GitHub 上发布广告。 | +| [您对我们处理您的个人数据的选择](#your-choices-regarding-our-processing-of-your-personal-data) | 我们为您提供访问、更改或删除个人信息的途径。 | +| [Cookie](#cookies) | Except for cookies used on our Enterprise Marketing Pages, we only use strictly necessary cookies to provide, secure, and improve our Website or Service or develop new features and functionality of our Website or Service.

As described below, we may use non-essential cookies on certain pages of our website to support our enterprise marketing efforts and market our products and services to enterprise customers, for example on resources.github.com (collectively “Enterprise Marketing Pages”).

We offer a [page](https://github.com/privacy/cookies) that makes all uses of cookies very transparent. | +| [GitHub 如何保护您的信息](#how-github-secures-your-information) | 我们采取一切合理必要的措施来保护您在 GitHub 上个人数据的机密性、完整性和可用性,并保护我们服务器的弹性。 | +| [沟通偏好](#communication-preferences) | 我们通过电子邮件与您通信。 您可以在帐户设置中或通过联系我们来控制我们与您联系的方式。 | +| [解决投诉](#resolving-complaints) | 万一我们无法快速彻底地解决隐私问题,我们提供一条解决争议的途径。 | +| [隐私声明的变更](#changes-to-our-privacy-statement) | 如果本隐私声明发生重大变更,我们会在任何此类变更生效之前 30 天通知您。 您也可以在我们的站点政策仓库中跟踪变更。 | +| [许可](#license) | 本隐私声明的许可采用[知识共享零许可](https://creativecommons.org/publicdomain/zero/1.0/)原则。 | +| [联系 GitHub](#contacting-github) | 如果您对我们的隐私声明有疑问,请随时联系我们。 | +| [翻译](#translations) | 我们提供本隐私声明的一些翻译版本的链接。 | ## GitHub 隐私声明 @@ -122,13 +122,14 @@ topics: - 通过了解您和您的偏好来个性化我们的服务,以增强您对我们服务的体验和享受。 - 提供客户支持并回答您的问题。 - 向您提供新服务、功能、优惠、促销以及有关服务的其他信息。 +- Personalize and measure the effectiveness of enterprise business ads, promotional communications or marketing you receive related to the Enterprise Marketing Pages. - 向您发送信息,包括确认、发票、技术通知、更新、安全警报、支持和管理消息。 出于这些目的,我们将从不同来源收集的数据结合起来,为您提供更加无缝、一致和个性化的体验。 ## 我们如何分享所收集的信息 -我们会在您同意的情况下或在必要时共享个人数据,以完成您的交易或提供您请求或授权的服务。 此外,出于以下商业目的,我们可能会与下述类型的第三方共享上述每个类别的个人数据: +We share personal data as described below, including with your consent or as necessary to complete your transactions or provide the services you have requested or authorized. In addition, we may share each of the categories of your personal data described above with the types of third parties described below for the following business purposes: ### 公开信息 您可以选择通过我们的服务提供的选项,以公开显示和共享您的姓名和/或用户名以及某些其他信息,例如您的个人资料、人口统计数据、内容和文件或地理位置数据。 例如,如果您希望自己的电子邮件地址保持私密,即使您正在评论公共存储库,[也可以在用户配置文件中将电子邮件地址的设置调整为为私密](https://github.com/settings/emails)。 您还可以[更新本地 Git 配置以使用您的私密电子邮件地址](/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address)。 有关提交消息中电子邮件地址的更多信息,请参阅[此处](/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address)。 @@ -144,9 +145,9 @@ topics: 您可以通过在 GitHub 上的操作来表明您愿意分享自己的个人数据。 如果您与组织协作或成为组织成员,则其帐户所有者可能会收到您的个人数据。 当您接受组织邀请时,您将被告知所有者可以看到的信息类型(更多信息请参阅[关于组织成员](/github/setting-up-and-managing-your-github-user-account/about-organization-membership))。 请联系帐户所有者,详细了解他们在组织中如何处理您的个人数据,以及您访问、更新、更改或删除存储在该帐户中的个人数据的方式。 ### 服务提供商 -我们与代表我们处理信息的服务提供商共享您的个人数据,以提供或改进我们的服务。 例如,我们的服务提供商履行付款处理、客户支持事件单、网络数据传输、安全及其他类似服务。 虽然 GitHub 在美国处理所有个人数据,但我们的服务提供商可能在美国或欧盟外部处理数据。 服务提供商的此类处理将遵守适用法律,包括任何相关的传输机制。 +我们与代表我们处理信息的服务提供商共享您的个人数据,以提供或改进我们的服务。 For example, our service providers may perform payment processing, customer support ticketing, network data transmission, web analytics, marketing operations, security, and other similar services. 虽然 GitHub 在美国处理所有个人数据,但我们的服务提供商可能在美国或欧盟外部处理数据。 服务提供商的此类处理将遵守适用法律,包括任何相关的传输机制。 - ### 关联公司 我们允许跨子公司、关联公司和相关公司访问个人数据,例如,我们共享通用数据系统或需要访问权限来运营和提供服务。 + ### Affiliates We enable access to personal data across our subsidiaries, affiliates, and related companies, for example, where we share common data systems, when affiliates provide services on our behalf, or where access is needed to operate and provide the Service. ### 出于安全目的 如果我们认为是实现以下目的所必需,将公布个人数据: @@ -171,7 +172,7 @@ GitHub 可能会向执法部门或其他政府机构披露我们收集的有关 ## 您对我们处理您的个人数据的选择 我们提供有关我们收集的有关您的个人数据的选择。 您所做的选择将不适用于与您帐户下的组织相关的任何个人数据。 -访问、更正和删除。 如果您是 GitHub 用户,则可以通过[编辑用户个人资料](https://github.com/settings/profile)或联系 [GitHub 支持](https://support.github.com/contact)或 [GitHub 高级支持](https://enterprise.githubsupport.com/hc/en-us),访问、更新、更改或删除您的基本用户个人资料信息。 您可以在个人资料中限制信息、保持更新个人信息或者联系 [GitHub 支持](https://support.github.com/contact)或 [GitHub 高级支持](https://enterprise.githubsupport.com/hc/en-us),以控制我们收集的信息。 +访问、更正和删除。 如果您是 GitHub 用户,则可以通过[编辑用户个人资料](https://github.com/settings/profile)或联系 [GitHub 支持](https://support.github.com/contact)或 [GitHub 高级支持](https://enterprise.githubsupport.com/hc/en-us),访问、更新、更改或删除您的基本用户个人资料信息。 You can control the information we collect about you by limiting what information is in your profile, by keeping your information current, by changing your cookie preferences, or by contacting [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://enterprise.githubsupport.com/hc/en-us). 我们按照本隐私声明中所述保留和使用您的信息,但除非法律要求,否则我们将在您提出请求后的 90 天内删除您的完整个人资料。 删除帐户后,某些数据,例如对其他用户仓库的贡献和对其他议题的评论,仍然保留。 但是,我们通过将其与空用户相关联,从议题、拉取请求和评论的作者字段中删除或去识别化您的个人数据,包括您的用户名和电子邮件地址。 也就是说,您通过 Git 提交设置提供的电子邮件地址将始终与 Git 系统中的提交相关联。 如果您已选择将自己的电子邮件地址设为私密,则还应更新您的 Git 提交设置。 我们无法更改或删除 Git 提交历史记录中的数据 — 虽然 Git 软件设计用于维护记录,但我们让您来控制在该记录中放入哪些信息。 @@ -208,13 +209,65 @@ GitHub 可能会向执法部门或其他政府机构披露我们收集的有关 ### Cookie 和跟踪技术 -GitHub 使用 Cookie 来提供、保护和改进我们的服务,或开发我们服务的新特性和功能。 例如,我们使用它们来保持您的登录状态、记住您的偏好、出于安全目的识别您的设备、编译统计报告以及为 GitHub 的未来发展提供信息。 我们使用自己的 Cookie,在这种情况下不使用任何第三方服务提供商。 如果您禁止浏览器或设备接受这些 cookie,则将无法登录或使用我们的服务。 我们在 [GitHub 子处理器和 Cookie](/github/site-policy/github-subprocessors-and-cookies) 页面上提供有关 [GitHub 上 Cookie](/github/site-policy/github-subprocessors-and-cookies#cookies-on-github) 的更多信息,其中描述了我们设置的 Cookie、我们对这些 Cookie 的需求以及此类 Cookie 的过期时间。 +GitHub uses cookies to provide, secure and improve our Service or to develop new features and functionality of our Service. For example, we use them to (i) keep you logged in, (ii) remember your preferences, (iii) identify your device for security and fraud purposes, including as needed to maintain the integrity of our Service, (iv) compile statistical reports, and (v) provide information and insight for future development of GitHub. We provide more information about [cookies on GitHub](https://github.com/privacy/cookies) that describes the cookies we set, the needs we have for those cookies, and the expiration of such cookies. + +For Enterprise Marketing Pages, we may also use non-essential cookies to (i) gather information about enterprise users’ interests and online activities to personalize their experiences, including by making the ads, content, recommendations, and marketing seen or received more relevant and (ii) serve and measure the effectiveness of targeted advertising and other marketing efforts. If you disable the non-essential cookies on the Enterprise Marketing Pages, the ads, content, and marketing you see may be less relevant. 我们给用户的电子邮件可能包含一个像素标签,它是一个很小的清晰图像,可以告诉我们您是否打开了电子邮件以及您的 IP 地址是什么。 我们使用此像素标签使我们的电子邮件通信对您更有效,并确保我们不会发送您不需要的电子邮件。 -### DNT +The length of time a cookie will stay on your browser or device depends on whether it is a “persistent” or “session” cookie. Session cookies will only stay on your device until you stop browsing. Persistent cookies stay until they expire or are deleted. The expiration time or retention period applicable to persistent cookies depends on the purpose of the cookie collection and tool used. You may be able to delete cookie data as described here. + +#### What are cookies and similar technologies? + +We use cookies and similar technologies, such as web beacons, local storage, and mobile analytics, to operate and provide our Services. When visiting Enterprise Marketing Pages, like resources.github.com, these and additional cookies, like advertising IDs, may be used for sales and marketing purposes. + +Cookies are small text files stored by your browser on your device. A cookie can later be read when your browser connects to a web server in the same domain that placed the cookie. The text in a cookie contains a string of numbers and letters that may uniquely identify your device and can contain other information as well. This allows the web server to recognize your browser over time, each time it connects to that web server. + +Web beacons are electronic images (also called “single-pixel” or “clear GIFs”) that are contained within a website or email. When your browser opens a webpage or email that contains a web beacon, it automatically connects to the web server that hosts the image (typically operated by a third party). This allows that web server to log information about your device and to set and read its own cookies. In the same way, third-party content on our websites (such as embedded videos, plug-ins, or ads) results in your browser connecting to the third-party web server that hosts that content. + +Mobile identifiers for analytics can be accessed and used by apps on mobile devices in much the same way that websites access and use cookies. When visiting Enterprise Marketing pages, like resources.github.com, on a mobile device these may allow us and our third-party analytics and advertising partners to collect data for sales and marketing purposes. + +We may also use so-called “flash cookies” (also known as “Local Shared Objects” or “LSOs”) to collect and store information about your use of our Services. Flash cookies are commonly used for advertisements and videos. + +#### How do we and our partners use cookies and similar technologies? + +The GitHub Services use cookies and similar technologies for a variety of purposes, including to store your preferences and settings, enable you to sign-in, analyze how our Services perform, track your interaction with the Services, develop inferences, combat fraud, and fulfill other legitimate purposes. Some of these cookies and technologies may be provided by third parties, including service providers and advertising partners. For example, our analytics and advertising partners may use these technologies in our Services to collect personal information (such as the pages you visit, the links you click on, and similar usage information, identifiers, and device information) related to your online activities over time and across Services for various purposes, including targeted advertising. GitHub will place non-essential cookies on pages where we market products and services to enterprise customers, for example, on resources.github.com. + +We and/or our partners also share the information we collect or infer with third parties for these purposes. + +The table below provides additional information about how we use different types of cookies: + +| 目的 | 描述 | +|:---------------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Required Cookies | GitHub uses required cookies to perform essential website functions and to provide the services. For example, cookies are used to log you in, save your language preferences, provide a shopping cart experience, improve performance, route traffic between web servers, detect the size of your screen, determine page load times, improve user experience, and for audience measurement. These cookies are necessary for our websites to work. | +| 分析 | We allow third parties to use analytics cookies to understand how you use our websites so we can make them better. For example, cookies are used to gather information about the pages you visit and how many clicks you need to accomplish a task. We also use some analytics cookies to provide personalized advertising. | +| Social Media | GitHub and third parties use social media cookies to show you ads and content based on your social media profiles and activity on GitHub’s websites. This ensures that the ads and content you see on our websites and on social media will better reflect your interests. This also enables third parties to develop and improve their products, which they may use on websites that are not owned or operated by GitHub. | +| Advertising | In addition, GitHub and third parties use advertising cookies to show you new ads based on ads you've already seen. Cookies also track which ads you click or purchases you make after clicking an ad. This is done both for payment purposes and to show you ads that are more relevant to you. For example, cookies are used to detect when you click an ad and to show you ads based on your social media interests and website browsing history. | + +#### What are your cookie choices and controls? + + You have several options to disable non-essential cookies: + + 1. **Specifically on GitHub Enterprise Marketing Pages** + + Any GitHub page that serves non-essential cookies will have a link in the page’s footer to cookie settings. You can express your preferences at any time by clicking on that linking and updating your settings. + + Some users will also be able to manage non-essential cookies via a cookie consent banner, including the options to accept, manage, and reject all non-essential cookies. + 2. **Generally for all websites** + + You can control the cookies you encounter on the web using a variety of widely-available tools. 例如: + - If your browser sends a [Do Not Track](https://en.wikipedia.org/wiki/Do_Not_Track) (DNT) signal, GitHub will not set non-essential cookies and will not load third party resources which set non-essential cookies. + - Many browsers provide cookie controls which may limit the types of cookies you encounter online. Check out the documentation for your browser to learn more. + - If you enable a browser extension designed to block tracking, such as [Privacy Badger](https://en.wikipedia.org/wiki/Privacy_Badger), non-essential cookies set by a website or third parties may be disabled. + - If you enable a browser extension designed to block unwanted content, such as [uBlock Origin](https://en.wikipedia.org/wiki/UBlock_Origin), non-essential cookies will be disabled to the extent that content that sets non-essential cookies will be blocked. + - Advertising controls. Our advertising partners may participate in associations that provide simple ways to opt out of ad targeting, which you can access at: + - United States: [NAI](http://optout.networkadvertising.org) and [DAA](http://optout.aboutads.info/) + - Canada: [Digital Advertising Alliance of Canada](https://youradchoices.ca/) + - Europe: [European Digital Advertising Alliance](http://www.youronlinechoices.com/) + + These choices are specific to the browser you are using. If you access our Services from other devices or browsers, take these actions from those systems to ensure your choices apply to the data collected when you use those systems. + -“[别跟踪](https://www.eff.org/issues/do-not-track)”(DNT) 是有一种隐私首选项,如果您不希望在线服务(特别是广告网络)通过第三方跟踪服务收集和分享有关您在线活动的某类信息,您可以在浏览器中设置该选项。 GitHub 响应浏览器的 DNT 信号,并遵循[关于响应 DNT 信号的 W3C 标准](https://www.w3.org/TR/tracking-dnt/)。 如果您要设置浏览器以传达不希望被跟踪的信号,请查看浏览器的文档以了解如何启用该信号。 还有一些很适合阻止在线跟踪的应用程序,例如 [Privacy Badger](https://privacybadger.org/)。 ## 个人数据的保留 只要有必要,我们就会保留个人数据,以提供服务并完成您请求的交易,遵守我们的法律义务,解决争议,执行我们的协议以及其他合法和合法的商业目的。 由于在不同服务环境中,不同数据类型的这些需求可能会有所不同,因此实际保留期可能会根据用户期望或同意、数据的敏感性、使用户能够删除数据的自动控制的可用性以及我们的法律或合同义务等标准而有很大差异。 例如,出于安全目的,我们可能会在必要时根据适用法律将您的个人数据保留更长时间。 @@ -238,15 +291,11 @@ GitHub 处理美国境内外的个人数据,并依靠标准合同条款等法 ### 解决投诉 如果您对 GitHub 处理您的个人数据的方式有疑问,请立即告诉我们。 我们乐于提供帮助。 您可以通过填写[隐私问题联系表](https://support.github.com/contact/privacy)联系我们。 您也可以直接通过 **(privacy [at] github [dot] com)** 给我们发送主题行为“隐私问题”的电子邮件。 我们将尽快回复 — 最迟不超过 45 天。 -您还可以直接联系我们的数据保护官。 +You may also contact our Data Protection Officer directly at at **github [at]dp-officer [dot] com** + +**If you are in North America:**
GitHub Data Protection Officer
88 Colin P. Kelly Jr. St.
San Francisco, CA 94107
United States
**privacy [at] github [dot] com**
-| 我们的美国总部 | 我们的欧盟办事处 | -| --------------------------------- | --------------------------------- | -| GitHub 数据保护官 | GitHub BV | -| 88 Colin P. Kelly Jr. St. | Vijzelstraat 68-72 | -| San Francisco, CA 94107 | 1017 HL Amsterdam | -| 美国 | 荷兰 | -| **privacy [at] github [dot] com** | **privacy [at] github [dot] com** | +**If you are outside of North America:**
Github Data Protection Officer
c/o DP Dock DPO Services GmbH,
Attn: GitHub BV, Gut Projensdorf,
24161 Altenholz, Germany
github@dp-officer.com cc: **privacy [at] github [dot] com**
CC: GitHub BV, Vijzelstraat 68-72, 1017 HL Amsterdam, The Netherlands ### 争议解决流程 @@ -275,7 +324,7 @@ Cliquez ici pour obtenir la version française: [Déclaration de confidentialit 有关本声明翻译成其他语言的版本,请访问 [https://docs.github.com/](/),然后从“English(英文)”下的下拉菜单中选择语言。 ## GitHub 对加州居民的声明 -2018 年[加州消费者隐私法案](https://leginfo.legislature.ca.gov/faces/billCompareClient.xhtml?bill_id=201720180AB375)(加州 民事 法典第 1798.100 及其后各段,修正案,“CCPA”)赋予加州居民对其个人信息的权利和控制。 GitHub, Inc. ("GitHub"、“我们”)根据 CCPA 的要求向加州居民(“您”)提供本声明,概述如何收集和处理其个人信息。 这是 GitHub 专门向加州居民介绍的在 CCPA 下的消费者隐私权。 至于我们如何将 CCPA 关于控制个人信息的核心权利扩展到美国所有用户,请参阅我们的[隐私声明](/github/site-policy/github-privacy-statement)。 +2018 年[加州消费者隐私法案](https://leginfo.legislature.ca.gov/faces/billCompareClient.xhtml?bill_id=201720180AB375)(加州 民事 法典第 1798.100 及其后各段,修正案,“CCPA”)赋予加州居民对其个人信息的权利和控制。 GitHub, Inc. ("GitHub"、“我们”)根据 CCPA 的要求向加州居民(“您”)提供本声明,概述如何收集和处理其个人信息。 这是 GitHub 专门向加州居民介绍的在 CCPA 下的消费者隐私权。 For information about how we’ve extended the CCPA core rights to control personal information to all of our users in the United States, please see our [Privacy Statement](/github/site-policy/github-privacy-statement). ### 我们对个人信息的处理 虽然下表包含有关我们收集、处理和分享的个人信息类别的信息,但要了解更详细的信息还请参阅 [GitHub 隐私声明](/github/site-policy/github-privacy-statement)。 diff --git a/translations/zh-CN/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md b/translations/zh-CN/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md index ace65862716f..0cb3c83774e6 100644 --- a/translations/zh-CN/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md +++ b/translations/zh-CN/content/site-policy/privacy-policies/github-subprocessors-and-cookies.md @@ -14,74 +14,23 @@ topics: - Legal --- -生效日期:**2021 年 4 月 2 日** +Effective date: **September 1, 2022** -{% note %} - -**Note:** Changes to the list of cookies on this page are currently pending. - -{% endnote %} GitHub 在如何使用您的数据、如何收集您的数据以及与谁分享您的数据方面提供很大的透明度。 为此,我们提供此页面,以详细介绍了我们的[子处理商](#github-subprocessors),以及我们如何使用 [cookie](#cookies-on-github)。 ## GitHub 子处理商 -我们与第三方子处理商(例如我们的供应商和服务提供商)分享您的信息时,我们仍对您的信息负责。 我们在引入新供应商时,会竭尽所能保持您的信任,并且要求所有供应商与我们签订数据保护协议,以约束他们对用户个人信息(定义见[隐私声明](/articles/github-privacy-statement/))的处理。 您可以在[此处](https://www.github.com/privacy/subprocessors)注册以接收子处理器列表更新。 +我们与第三方子处理商(例如我们的供应商和服务提供商)分享您的信息时,我们仍对您的信息负责。 我们在引入新供应商时,会竭尽所能保持您的信任,并且要求所有供应商与我们签订数据保护协议,以约束他们对用户个人信息(定义见[隐私声明](/articles/github-privacy-statement/))的处理。 -| 子处理商名称 | 处理说明 | 处理地点 | 公司地点 | -|:------------------------ |:----------------- |:---- |:---- | -| Automattic | 博客服务 | 美国 | 美国 | -| AWS Amazon | 数据托管 | 美国 | 美国 | -| Braintree (PayPal) | 订阅费用信用卡支付处理商 | 美国 | 美国 | -| Clearbit | 营销数据充实服务 | 美国 | 美国 | -| Discourse | 社区论坛软件提供商 | 美国 | 美国 | -| Eloqua | 营销活动自动化 | 美国 | 美国 | -| Google Apps | 公司内部基础设施 | 美国 | 美国 | -| MailChimp | 客户事件单邮件服务提供商 | 美国 | 美国 | -| Mailgun | 交易邮件服务提供商 | 美国 | 美国 | -| Microsoft | Microsoft 服务 | 美国 | 美国 | -| Nexmo | 短信通知提供商 | 美国 | 美国 | -| Salesforce.com | 客户关系管理 | 美国 | 美国 | -| Sentry.io | 应用程序监控提供商 | 美国 | 美国 | -| Stripe | 支付服务提供商 | 美国 | 美国 | -| Twilio & Twilio Sendgrid | 短信通知提供商和交易邮件服务提供商 | 美国 | 美国 | -| Zendesk | 客户支持事件单系统 | 美国 | 美国 | -| Zuora | 公司计费系统 | 美国 | 美国 | +When we bring on a new subprocessor who handles our Users' Personal Information, or remove a subprocessor, or we change how we use a subprocessor, we will update the list of subprocessors. You can view the current list of subprocessors, and sign up to receive subprocessor list updates, at [https://www.github.com/privacy/subprocessors](https://www.github.com/privacy/subprocessors). -在我们引入新的子处理商来处理用户个人信息、删除子处理商或更改使用子处理商的方式时,我们将更新本页面。 如果您对新的子处理商有疑问或疑虑,我们乐意提供帮助。 请通过 {% data variables.contact.contact_privacy %} 联系我们。 +如果您对新的子处理商有疑问或疑虑,我们乐意提供帮助。 请通过 {% data variables.contact.contact_privacy %} 联系我们。 ## GitHub 上的 Cookie GitHub 使用 Cookie 来提供和保护我们的网站,并分析我们网站的使用情况,以便为您提供出色的用户体验。 如果您想了解有关 Cookie 的更多信息,请查看我们的[隐私声明](/github/site-policy/github-privacy-statement#our-use-of-cookies-and-tracking),了解我们如何以及为什么使用它们。 -由于 Cookie 的数量和名称可能会发生变化,下表可能会不时更新。 - -| Cookie 名称 | 原因 | 描述 | 过期* | -|:--------- |:------------------------------------ |:------------------------------------------------------- |:------------------ | -| GitHub | `app_manifest_token` | 此 cookie 用于表明页面之间的临时应用程序和框架状态,例如用户在多步骤表单中处于哪一步。 | 5 分钟 | -| GitHub | `color_mode` | 此 cookie 用于指示用户选择的主题首选项。 | 会话 | -| GitHub | `_device_id` | 出于安全考虑,此 Cookie 用于跟踪已识别的设备。 | 1 年 | -| GitHub | `dotcom_user` | 此 cookie 用于向我们表明用户已登录。 | 1 年 | -| GitHub | `_gh_ent` | 此 cookie 用于表明页面之间的临时应用程序和框架状态,例如客户在多步骤表单中处于哪一步。 | 两周 | -| GitHub | `_gh_sess` | 此 cookie 用于表明页面之间的临时应用程序和框架状态,例如用户在多步骤表单中处于哪一步。 | 会话 | -| GitHub | `gist_oauth_csrf` | 此 cookie 由 Gist 设置,以确保启动 oauth 流的用户与完成它的用户是同一个用户。 | 验证 oauth 状态时删除 | -| GitHub | `gist_user_session` | 此 cookie 由 Gist 在单独主机上运行时使用。 | 两周 | -| GitHub | `has_recent_activity` | 此 Cookie 用于防止向最近访问过应用程序的用户显示安全插页。 | 1 小时 | -| GitHub | `__Host-gist_user_session_same_site` | 此 cookie 设置为确保支持 SameSite cookie 的浏览器可以检查请求是否来自 GitHub。 | 两周 | -| GitHub | `__Host-user_session_same_site` | 此 cookie 设置为确保支持 SameSite cookie 的浏览器可以检查请求是否来自 GitHub。 | 两周 | -| GitHub | `logged_in` | 此 cookie 用于向我们表明用户已登录。 | 1 年 | -| GitHub | `marketplace_repository_ids` | 此 cookie 用于您的登录。 | 1 小时 | -| GitHub | `marketplace_suggested_target_id` | 此 cookie 用于您的登录。 | 1 小时 | -| GitHub | `_octo` | 此 Cookie 用于会话管理,包括动态内容缓存、条件功能访问、支持请求元数据和第一方分析。 | 1 年 | -| GitHub | `org_transform_notice` | 此 Cookie 用于在组织转换期间提供通知。 | 1 小时 | -| GitHub | `github.com/personal` | 此 cookie 用于 Google Analytics。 | 两周 | -| GitHub | `saml_csrf_token` | 此 cookie 由 SAML 身份验证路径方法设置,以将令牌与客户端相关联。 | 直到用户关闭浏览器或完成身份验证请求 | -| GitHub | `saml_csrf_token_legacy` | 此 cookie 由 SAML 身份验证路径方法设置,以将令牌与客户端相关联。 | 直到用户关闭浏览器或完成身份验证请求 | -| GitHub | `saml_return_to` | 此 cookie 由 SAML 身份验证路径方法设置,以在 SAML 身份验证循环期间维持状态。 | 直到用户关闭浏览器或完成身份验证请求 | -| GitHub | `saml_return_to_legacy` | 此 cookie 由 SAML 身份验证路径方法设置,以在 SAML 身份验证循环期间维持状态。 | 直到用户关闭浏览器或完成身份验证请求 | -| GitHub | `tz` | 此 Cookie 允许我们根据您的时区自定义时间戳。 | 会话 | -| GitHub | `user_session` | 此 cookie 用于您的登录。 | 两周 | - -_*_ 下面列出的 Cookie 的**到期**日期通常以滚动方式适用。 +You can view the current list of cookies on GitHub, and sign up to receive cookie list updates, at [https://github.com/privacy/cookies](https://github.com/privacy/cookies). (!) 请注意,虽然我们将第三方 Cookie 的使用限制在呈现外部内容时提供外部功能的需要,但我们网站上的某些页面可能会设置其他第三方 Cookie。 例如,我们可能会嵌入来自其他网站的内容(例如视频),而该网站可能放置 cookie。 虽然我们尽可能减少这些第三方 cookie,但我们无法始终控制这些第三方内容放置哪些 cookie。 diff --git a/translations/zh-CN/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md b/translations/zh-CN/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md index 096e87b9cdbe..9dfa58adf6bd 100644 --- a/translations/zh-CN/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md +++ b/translations/zh-CN/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md @@ -25,7 +25,7 @@ shortTitle: 赞助贡献者 您可以代表您的个人帐户赞助一个帐户,以投资您个人受益的项目。 您可以代表您的组织赞助帐户,原因有很多。 - 维护组织工作所依赖的特定库 -- 投资于作为一个组织所依赖的生态系统(如区块链) +- Investing in the ecosystem you rely on as an organization (such as blockchain) - 作为重视开源的组织,培养品牌知名度 - 感谢开源开发者构建库来补充您的组织提供的产品 diff --git a/translations/zh-CN/data/features/actions-hosted-runners.yml b/translations/zh-CN/data/features/actions-hosted-runners.yml new file mode 100644 index 000000000000..fcc88d707de7 --- /dev/null +++ b/translations/zh-CN/data/features/actions-hosted-runners.yml @@ -0,0 +1,5 @@ +#Reference: #6458 +#Larger GitHub-hosted runners +versions: + fpt: '*' + ghec: '*' diff --git a/translations/zh-CN/data/features/code-scanning-exclude-queries-from-analysis.yml b/translations/zh-CN/data/features/code-scanning-exclude-queries-from-analysis.yml new file mode 100644 index 000000000000..2157533a6d34 --- /dev/null +++ b/translations/zh-CN/data/features/code-scanning-exclude-queries-from-analysis.yml @@ -0,0 +1,7 @@ +#Issue 7617 +#Users can easily exclude CodeQL queries from code scanning analyses - [GA] +versions: + fpt: '*' + ghec: '*' + ghes: '>3.6' + ghae: 'issue-7617' diff --git a/translations/zh-CN/data/features/dependency-review-action-ghes.yml b/translations/zh-CN/data/features/dependency-review-action-ghes.yml new file mode 100644 index 000000000000..2d8bca37f3b4 --- /dev/null +++ b/translations/zh-CN/data/features/dependency-review-action-ghes.yml @@ -0,0 +1,4 @@ +#Reference: Issue #7753 Dependency review action has shipped with GHES 3.6 and needs admin docs +versions: + ghes: '>3.5' + ghae: 'issue-7753' diff --git a/translations/zh-CN/data/features/packages-npm-v2.yml b/translations/zh-CN/data/features/packages-npm-v2.yml new file mode 100644 index 000000000000..572e412e4a45 --- /dev/null +++ b/translations/zh-CN/data/features/packages-npm-v2.yml @@ -0,0 +1,5 @@ +#Issue 7039 +#npm Package Registry Improvements (v2) GA +versions: + fpt: '*' + ghec: '*' diff --git a/translations/zh-CN/data/features/streaming-datadog.yml b/translations/zh-CN/data/features/streaming-datadog.yml new file mode 100644 index 000000000000..ab90546c8d4e --- /dev/null +++ b/translations/zh-CN/data/features/streaming-datadog.yml @@ -0,0 +1,4 @@ +#Reference #7495 +#Documentation for audit log streaming to a Datadog endpoint +versions: + ghec: '*' diff --git a/translations/zh-CN/data/learning-tracks/admin.yml b/translations/zh-CN/data/learning-tracks/admin.yml index a7aa266e929f..23816673a1ff 100644 --- a/translations/zh-CN/data/learning-tracks/admin.yml +++ b/translations/zh-CN/data/learning-tracks/admin.yml @@ -120,6 +120,7 @@ configure_github_advanced_security: - /admin/advanced-security/about-licensing-for-github-advanced-security - /admin/advanced-security/enabling-github-advanced-security-for-your-enterprise - /admin/advanced-security/configuring-code-scanning-for-your-appliance + - /admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-dependency-review-for-your-appliance - /admin/advanced-security/configuring-secret-scanning-for-your-appliance - /admin/policies/enforcing-policies-for-advanced-security-in-your-enterprise diff --git a/translations/zh-CN/data/release-notes/enterprise-server/3-2/18.yml b/translations/zh-CN/data/release-notes/enterprise-server/3-2/18.yml new file mode 100644 index 000000000000..5d6d2bda6cde --- /dev/null +++ b/translations/zh-CN/data/release-notes/enterprise-server/3-2/18.yml @@ -0,0 +1,16 @@ +date: '2022-08-30' +sections: + bugs: + - Duplicate administrative SSH keys could appear in both the Management Console and the `/home/admin/.ssh/authorized_keys` file. + - In some cases, background tasks could stall due to a library that was used concurrently despite not being thread-safe. + changes: + - Generation of support bundles is faster as a result of parallelized log sanitization. For more information about support bundles, see "[Providing data to GitHub Support](/support/contacting-github-support/providing-data-to-github-support)." + known_issues: + - 在新建的没有任何用户的 {% data variables.product.prodname_ghe_server %} 实例上,攻击者可以创建第一个管理员用户。 + - 自定义防火墙规则在升级过程中被删除。 + - Git LFS 跟踪的文件[通过 Web 界面上传](https://github.com/blog/2105-upload-files-to-your-repositories) 被错误地直接添加到仓库。 + - 如果议题包含文件路径长于 255 个字符的同一仓库中 blob 的永久链接,则议题无法关闭。 + - 当“用户可以搜索 GitHub.com”与 {% data variables.product.prodname_github_connect %} 一起启用时,私有和内部存储库中的议题不会包含在 {% data variables.product.prodname_dotcom_the_website %} 搜索结果中。 + - '{% data variables.product.prodname_registry %} npm 注册表不再返回元数据响应的时间值。这样做是为了大幅改善性能。作为元数据响应的一部分,我们继续拥有返回时间值所需的所有数据,并将在我们解决现有性能问题后恢复返回这个值。' + - 特定于处理预接收挂钩的资源限制可能会导致某些预接收挂钩失败。 + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/zh-CN/data/release-notes/enterprise-server/3-3/13.yml b/translations/zh-CN/data/release-notes/enterprise-server/3-3/13.yml new file mode 100644 index 000000000000..7c6b30b2f67f --- /dev/null +++ b/translations/zh-CN/data/release-notes/enterprise-server/3-3/13.yml @@ -0,0 +1,23 @@ +date: '2022-08-30' +sections: + bugs: + - After unlocking a repository for temporary access, a site administrator was unable to manage settings for security products in the repository. + - Duplicate administrative SSH keys could appear in both the Management Console and the `/home/admin/.ssh/authorized_keys` file. + - In some cases, running `ghe-cluster-config-apply` could replicate an empty configuration to existing nodes in a cluster. + - In some cases, configuration runs started with `ghe-config-apply` did not complete, or returned a `Container count mismatch` error. + - After updating a self-signed TLS certificate on a GitHub Enterprise Server instance, UI elements on some pages in the web interface did not appear. + - In some cases, background tasks could stall due to a library that was used concurrently despite not being thread-safe. + changes: + - Generation of support bundles is faster as a result of parallelized log sanitization. For more information about support bundles, see "[Providing data to GitHub Support](/support/contacting-github-support/providing-data-to-github-support)." + - 'The enterprise audit log now includes more user-generated events, such as `project.create`. The REST API also returns additional user-generated events, such as `repo.create`. For more information, see "[Accessing the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)" and "[Using the audit log API for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise#querying-the-audit-log-rest-api)."' + known_issues: + - 升级到 {% data variables.product.prodname_ghe_server %} 3.3 后,{% data variables.product.prodname_actions %} 可能无法自动启动。要解决此问题,请通过 SSH 连接到设备并运行“ghe-actions-start”命令。 + - 在新建的没有任何用户的 {% data variables.product.prodname_ghe_server %} 实例上,攻击者可以创建第一个管理员用户。 + - 自定义防火墙规则在升级过程中被删除。 + - Git LFS 跟踪的文件[通过 Web 界面上传](https://github.com/blog/2105-upload-files-to-your-repositories) 被错误地直接添加到仓库。 + - 如果议题包含文件路径长于 255 个字符的同一仓库中 blob 的永久链接,则议题无法关闭。 + - 当“用户可以搜索 GitHub.com”与 {% data variables.product.prodname_github_connect %} 一起启用时,私有和内部存储库中的议题不会包含在 {% data variables.product.prodname_dotcom_the_website %} 搜索结果中。 + - '{% data variables.product.prodname_registry %} npm 注册表不再返回元数据响应的时间值。这样做是为了大幅改善性能。作为元数据响应的一部分,我们继续拥有返回时间值所需的所有数据,并将在我们解决现有性能问题后恢复返回这个值。' + - 特定于处理预接收挂钩的资源限制可能会导致某些预接收挂钩失败。 + - '{% data variables.product.prodname_actions %} 存储设置在选择“Force Path Style(强制路径样式)”时无法验证和保存在 {% data variables.enterprise.management_console %} 中,而必须使用“ghe-actions-precheck”命令行实用程序进行配置。' + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/zh-CN/data/release-notes/enterprise-server/3-4/8.yml b/translations/zh-CN/data/release-notes/enterprise-server/3-4/8.yml new file mode 100644 index 000000000000..e346e964583c --- /dev/null +++ b/translations/zh-CN/data/release-notes/enterprise-server/3-4/8.yml @@ -0,0 +1,26 @@ +date: '2022-08-30' +sections: + bugs: + - After unlocking a repository for temporary access, a site administrator was unable to manage settings for security products in the repository. + - Duplicate administrative SSH keys could appear in both the Management Console and the `/home/admin/.ssh/authorized_keys` file. + - The site admin page for individual users at http(s)://HOSTNAME/stafftools/users/USERNAME/admin contained functionality not intended for GitHub Enterprise Server. + - In some cases, running `ghe-cluster-config-apply` could replicate an empty configuration to existing nodes in a cluster. + - In some cases, configuration runs started with `ghe-config-apply` did not complete, or returned a `Container count mismatch` error. + - After updating a self-signed TLS certificate on a GitHub Enterprise Server instance, UI elements on some pages in the web interface did not appear. + - In some cases, background tasks could stall due to a library that was used concurrently despite not being thread-safe. + changes: + - Generation of support bundles is faster as a result of parallelized log sanitization. For more information about support bundles, see "[Providing data to GitHub Support](/support/contacting-github-support/providing-data-to-github-support)." + - APIs that contain the `organization` or `org` route now accept either the organization's slug or ID. Previously, the APIs only accepted slugs, which caused `Link` headers for GitHub Advanced Security endpoints to be inaccessible. For more information, see "[Organizations](https://docs.github.com/rest/orgs/orgs)" in the REST API documentation. + - 'The enterprise audit log now includes more user-generated events, such as `project.create`. The REST API also returns additional user-generated events, such as `repo.create`. For more information, see "[Accessing the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)" and "[Using the audit log API for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise#querying-the-audit-log-rest-api)."' + known_issues: + - 在新建的没有任何用户的 {% data variables.product.prodname_ghe_server %} 实例上,攻击者可以创建第一个管理员用户。 + - 自定义防火墙规则在升级过程中被删除。 + - Git LFS 跟踪的文件[通过 Web 界面上传](https://github.com/blog/2105-upload-files-to-your-repositories) 被错误地直接添加到仓库。 + - 如果议题包含文件路径长于 255 个字符的同一仓库中 blob 的永久链接,则议题无法关闭。 + - 当“用户可以搜索 GitHub.com”与 {% data variables.product.prodname_github_connect %} 一起启用时,私有和内部存储库中的议题不会包含在 {% data variables.product.prodname_dotcom_the_website %} 搜索结果中。 + - '{% data variables.product.prodname_registry %} npm 注册表不再返回元数据响应的时间值。这样做是为了大幅改善性能。作为元数据响应的一部分,我们继续拥有返回时间值所需的所有数据,并将在我们解决现有性能问题后恢复返回这个值。' + - 特定于处理预接收挂钩的资源限制可能会导致某些预接收挂钩失败。 + - | + 在多个级别(例如,企业和组织)上使用“--ephemeral”参数注册自托管运行器后,运行器可能会陷入空闲状态并需要重新注册。[更新时间:2022 年 6 月 17 日] + - After upgrading to {% data variables.product.prodname_ghe_server %} 3.4, releases may appear to be missing from repositories. This can occur when the required Elasticsearch index migrations have not successfully completed. + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/zh-CN/data/release-notes/enterprise-server/3-5/5.yml b/translations/zh-CN/data/release-notes/enterprise-server/3-5/5.yml new file mode 100644 index 000000000000..f33cdfe7bebf --- /dev/null +++ b/translations/zh-CN/data/release-notes/enterprise-server/3-5/5.yml @@ -0,0 +1,27 @@ +date: '2022-08-30' +sections: + bugs: + - After unlocking a repository for temporary access, a site administrator was unable to manage settings for security products in the repository. + - Duplicate administrative SSH keys could appear in both the Management Console and the `/home/admin/.ssh/authorized_keys` file. + - The site admin page for individual users at http(s)://HOSTNAME/stafftools/users/USERNAME/admin contained functionality not intended for GitHub Enterprise Server. + - In some cases, running `ghe-cluster-config-apply` could replicate an empty configuration to existing nodes in a cluster. + - In some cases, configuration runs started with `ghe-config-apply` did not complete, or returned a `Container count mismatch` error. + - After updating a self-signed TLS certificate on a GitHub Enterprise Server instance, UI elements on some pages in the web interface did not appear. + - The site admin bar at the top of the web interface contained a broken link to the SHA for the currently running version of the application. + - In some cases, background tasks could stall due to a library that was used concurrently despite not being thread-safe. + - Alerts from secret scanning for GitHub Advanced Security customers were missing in the web UI and REST API if a site administrator did not upgrade directly to GitHub Enterprise Server 3.4. The alerts are now visible. + - When a user forked a repository into an organization, a long list of organizations would not render properly. + changes: + - Generation of support bundles is faster as a result of parallelized log sanitization. For more information about support bundles, see "[Providing data to GitHub Support](/support/contacting-github-support/providing-data-to-github-support)." + - APIs that contain the `organization` or `org` route now accept either the organization's slug or ID. Previously, the APIs only accepted slugs, which caused `Link` headers for GitHub Advanced Security endpoints to be inaccessible. For more information, see "[Organizations](https://docs.github.com/rest/orgs/orgs)" in the REST API documentation. + - 'The enterprise audit log now includes more user-generated events, such as `project.create`. The REST API also returns additional user-generated events, such as `repo.create`. For more information, see "[Accessing the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)" and "[Using the audit log API for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise#querying-the-audit-log-rest-api)."' + - In some cases, cache replicas could reject some Git operations on recently updated repositories. For more information about repository caching, see "[About repository caching](/admin/enterprise-management/caching-repositories/about-repository-caching)." + known_issues: + - 在新建的没有任何用户的 {% data variables.product.prodname_ghe_server %} 实例上,攻击者可以创建第一个管理员用户。 + - 自定义防火墙规则在升级过程中被删除。 + - Git LFS 跟踪的文件[通过 Web 界面上传](https://github.com/blog/2105-upload-files-to-your-repositories) 被错误地直接添加到仓库。 + - 如果议题包含文件路径长于 255 个字符的同一仓库中 blob 的永久链接,则议题无法关闭。 + - 对 GitHub Connect 启用“用户可以搜索 GitHub.com”后,私有和内部仓库中的议题不包括在 GitHub.com 搜索结果中。 + - '{% data variables.product.prodname_registry %} npm 注册表不再返回元数据响应的时间值。这样做是为了大幅改善性能。作为元数据响应的一部分,我们继续拥有返回时间值所需的所有数据,并将在我们解决现有性能问题后恢复返回这个值。' + - 特定于处理预接收挂钩的资源限制可能会导致某些预接收挂钩失败。 + - Actions services need to be restarted after restoring an appliance from a backup taken on a different host. diff --git a/translations/zh-CN/data/release-notes/enterprise-server/3-6/0.yml b/translations/zh-CN/data/release-notes/enterprise-server/3-6/0.yml index 8f86df75a1c2..8bc43254308d 100644 --- a/translations/zh-CN/data/release-notes/enterprise-server/3-6/0.yml +++ b/translations/zh-CN/data/release-notes/enterprise-server/3-6/0.yml @@ -25,7 +25,9 @@ sections: - "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)" - "[Configuring host keys for your instance](/admin/configuration/configuring-your-enterprise/configuring-host-keys-for-your-instance)" - | - You can require TLS encryption for incoming SMTP connections to your instance. For more information, see "[Configuring email for notifications](/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications)." + You can require TLS encryption for incoming SMTP connections to your instance. For more information, see "[Configuring email for notifications](/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications#enforcing-tls-for-smtp-connections)." + + - **Note**: This feature is unavailable in GitHub Enterprise Server 3.6.0. The feature will be available in an upcoming release. [Updated: 2022-08-26] - heading: 审核日志 notes: @@ -211,3 +213,4 @@ sections: - In a repository's settings, enabling the option to allow users with read access to create discussions does not enable this functionality. - In some cases, users cannot convert existing issues to discussions. - Custom patterns for secret scanning have `.*` as an end delimiter, specifically in the "After secret" field. This delimiter causes inconsistencies in scans for secrets across repositories, and you may notice gaps in a repository's history where no scans completed. Incremental scans may also be impacted. To prevent issues with scans, modify the end of the pattern to remove the `.*` delimiter. + - '{% data reusables.release-notes.ghas-3.4-secret-scanning-known-issue %}' diff --git a/translations/zh-CN/data/release-notes/enterprise-server/3-6/1.yml b/translations/zh-CN/data/release-notes/enterprise-server/3-6/1.yml new file mode 100644 index 000000000000..d9929d35b050 --- /dev/null +++ b/translations/zh-CN/data/release-notes/enterprise-server/3-6/1.yml @@ -0,0 +1,33 @@ +date: '2022-08-30' +sections: + bugs: + - After unlocking a repository for temporary access, a site administrator was unable to manage settings for security products in the repository. + - Duplicate administrative SSH keys could appear in both the Management Console and the `/home/admin/.ssh/authorized_keys` file. + - The site admin page for individual users at http(s)://HOSTNAME/stafftools/users/USERNAME/admin contained functionality not intended for GitHub Enterprise Server. + - In some cases, running `ghe-cluster-config-apply` could replicate an empty configuration to existing nodes in a cluster. + - In some cases, configuration runs started with `ghe-config-apply` did not complete, or returned a `Container count mismatch` error. + - After updating a self-signed TLS certificate on a GitHub Enterprise Server instance, UI elements on some pages in the web interface did not appear. + - In some cases, background tasks could stall due to a library that was used concurrently despite not being thread-safe. + - The site admin bar at the top of the web interface contained a broken link to the SHA for the currently running version of the application. + - Organization owners were unable to set the level of access required to create discussions. + - Discussions users were incorrectly directed to the community guidelines for GitHub.com. + - In some cases, users were incorrectly instructed to verify their email before creating a discussion. + - Alerts from secret scanning for GitHub Advanced Security customers were missing in the web UI and REST API if a site administrator did not upgrade directly to GitHub Enterprise Server 3.4. The alerts are now visible. + changes: + - Generation of support bundles is faster as a result of parallelized log sanitization. For more information about support bundles, see "[Providing data to GitHub Support](/support/contacting-github-support/providing-data-to-github-support)." + - APIs that contain the `organization` or `org` route now accept either the organization's slug or ID. Previously, the APIs only accepted slugs, which caused `Link` headers for GitHub Advanced Security endpoints to be inaccessible. For more information, see "[Organizations](https://docs.github.com/rest/orgs/orgs)" in the REST API documentation. + - 'The enterprise audit log now includes more user-generated events, such as `project.create`. The REST API also returns additional user-generated events, such as `repo.create`. For more information, see "[Accessing the audit log for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/accessing-the-audit-log-for-your-enterprise)" and "[Using the audit log API for your enterprise](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise#querying-the-audit-log-rest-api)."' + - In some cases, cache replicas could reject some Git operations on recently updated repositories. For more information about repository caching, see "[About repository caching](/admin/enterprise-management/caching-repositories/about-repository-caching)." + - 'You can now configure the global announcement banner to be dismissable using the REST API. For more information, see "[Customizing user messages for your enterprise](/admin/user-management/managing-users-in-your-enterprise/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner)."' + known_issues: + - 在新建的没有任何用户的 {% data variables.product.prodname_ghe_server %} 实例上,攻击者可以创建第一个管理员用户。 + - 自定义防火墙规则在升级过程中被删除。 + - Git LFS 跟踪的文件[通过 Web 界面上传](https://github.com/blog/2105-upload-files-to-your-repositories) 被错误地直接添加到仓库。 + - 如果议题包含文件路径长于 255 个字符的同一仓库中 blob 的永久链接,则议题无法关闭。 + - 对 GitHub Connect 启用“用户可以搜索 GitHub.com”后,私有和内部仓库中的议题不包括在 GitHub.com 搜索结果中。 + - '{% data variables.product.prodname_registry %} npm 注册表不再返回元数据响应的时间值。这样做是为了大幅改善性能。作为元数据响应的一部分,我们继续拥有返回时间值所需的所有数据,并将在我们解决现有性能问题后恢复返回这个值。' + - 特定于处理预接收挂钩的资源限制可能会导致某些预接收挂钩失败。 + - Actions services need to be restarted after restoring an instance from a backup taken on a different host. + - In a repository's settings, enabling the option to allow users with read access to create discussions does not enable this functionality. + - In some cases, users cannot convert existing issues to discussions. + - Custom patterns for secret scanning have `.*` as an end delimiter, specifically in the "After secret" field. This delimiter causes inconsistencies in scans for secrets across repositories, and you may notice gaps in a repository's history where no scans completed. Incremental scans may also be impacted. To prevent issues with scans, modify the end of the pattern to remove the `.*` delimiter. diff --git a/translations/zh-CN/data/reusables/actions/about-runner-groups.md b/translations/zh-CN/data/reusables/actions/about-runner-groups.md new file mode 100644 index 000000000000..c557d2b5d2b6 --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/about-runner-groups.md @@ -0,0 +1,18 @@ +{% ifversion fpt %} +{% note %} + +**Note:** All organizations have a single default runner group. Only enterprise accounts and organizations owned by enterprise accounts can create and manage additional runner groups. + +{% endnote %} + +Runner groups are used to control access to runners. 组织管理员可以配置访问策略,用以控制组织中的哪些组织可以访问运行器组。 + +If you use {% data variables.product.prodname_ghe_cloud %}, you can create additional runner groups; enterprise admins can configure access policies that control which organizations in an enterprise have access to the runner group; and organization admins can assign additional granular repository access policies to the enterprise runner group. +{% endif -%} +{% ifversion ghec or ghes or ghae %} + +{% data reusables.actions.runner-group-enterprise-overview %} + +新运行器在创建时,将自动分配给默认组。 运行器每次只能在一个组中。 您可以将运行器从默认组移到另一组。 For more information, see "[Moving a runner to a group](#moving-a-runner-to-a-group)." + +{% endif %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/actions/actions-billing.md b/translations/zh-CN/data/reusables/actions/actions-billing.md index 18766c9e7c12..5cabcccc6d3e 100644 --- a/translations/zh-CN/data/reusables/actions/actions-billing.md +++ b/translations/zh-CN/data/reusables/actions/actions-billing.md @@ -1 +1 @@ -公共仓库和自托管运行器免费使用 {% data variables.product.prodname_actions %}。 对于私有仓库,每个 {% data variables.product.prodname_dotcom %} 帐户可获得一定数量的免费记录和存储,具体取决于帐户所使用的产品。 超出包含金额的任何使用量都由支出限制控制。 +{% data variables.product.prodname_actions %} usage is free for standard {% data variables.product.prodname_dotcom %}-hosted runners in public repositories, and for self-hosted runners. For private repositories, each {% data variables.product.prodname_dotcom %} account receives a certain amount of free minutes and storage for use with {% data variables.product.prodname_dotcom %}-hosted runners, depending on the product used with the account. 超出包含金额的任何使用量都由支出限制控制。 diff --git a/translations/zh-CN/data/reusables/actions/add-hosted-runner-overview.md b/translations/zh-CN/data/reusables/actions/add-hosted-runner-overview.md new file mode 100644 index 000000000000..bdd66230ca0a --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/add-hosted-runner-overview.md @@ -0,0 +1,3 @@ +You can choose an operating system and a hardware configuration from the list of available options. When new instances of this runner are deployed through autoscaling, they'll use the same operating system and hardware configuration you've defined here. + +You can also define the labels that identify the runner, which is how your workflows will be able to send jobs to the runners for processing (using `runs-on`). New runners are automatically assigned to the default group, or you can choose which group the runners must join during the runner creation process. In addition, you can modify the runner's group membership after you've registered the runner. For more information, see "[Controlling access to {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/controlling-access-to-larger-runners)." \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/actions/add-hosted-runner.md b/translations/zh-CN/data/reusables/actions/add-hosted-runner.md new file mode 100644 index 000000000000..d533864a2e21 --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/add-hosted-runner.md @@ -0,0 +1,11 @@ +1. Click **New runner**, then click **{% octicon "mark-github" aria-label="New hosted runner" %} New Github-hosted runner**. +1. Complete the required details to configure your new runner: + + - **Name**: Enter a name for your new runner. For easier identification, this should indicate its hardware and operating configuration, such as `ubuntu-20.04-16core`. + - **Runner image**: Choose an operating system from the available options. Once you've selected an operating system, you will be able to choose a specific version. + - **Runner size**: Choose a hardware configuration from the drop-down list of available options. + - **Auto-scaling**: Choose the maximum number of runners that can be active at any time. + - **Runner group**: Choose the group that your runner will be a member of. This group will host multiple instances of your runner, as they scale up and down to suit demand. + - **Networking**: Only for {% data variables.product.prodname_ghe_cloud %}: Choose whether a static IP address range will be assigned to instances of the {% data variables.actions.hosted_runner %}. You can use up to 10 static IP addresses in total. + +1. Click **Create runner**. \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/actions/automatically-adding-a-runner-to-a-group.md b/translations/zh-CN/data/reusables/actions/automatically-adding-a-runner-to-a-group.md new file mode 100644 index 000000000000..d8e47632727a --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/automatically-adding-a-runner-to-a-group.md @@ -0,0 +1,11 @@ +You can use the configuration script to automatically add a new runner to a group. For example, this command registers a new runner and uses the `--runnergroup` parameter to add it to a group named `rg-runnergroup`. + +```sh +./config.sh --url $org_or_enterprise_url --token $token --runnergroup rg-runnergroup +``` + +如果运行器组不存在,命令将失败: + +``` +找不到名为 "rg-runnergroup" 的任何自托管运行器组。 +``` \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/actions/changing-the-access-policy-of-a-runner-group.md b/translations/zh-CN/data/reusables/actions/changing-the-access-policy-of-a-runner-group.md new file mode 100644 index 000000000000..ce912df8301a --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/changing-the-access-policy-of-a-runner-group.md @@ -0,0 +1,38 @@ +{% comment %} + +Always include a security admonition above this procedure. This is either one of the following, depending on whether the context is self-hosted runners or larger runners. + +{% data reusables.actions.self-hosted-runner-security-admonition %} +{% data reusables.actions.hosted-runner-security-admonition %} + +{% endcomment %} + +对于企业中的运行器组,您可以更改企业中可以访问运行器组的组织{% ifversion restrict-groups-to-workflows %} 或限制运行器组可以运行的工作流程{% endif %}。 对于组织中的运行器组,您可以更改组织中可以访问运行器组的存储库{% ifversion restrict-groups-to-workflows %} 或限制运行器组可以运行的工作流程{% endif %}。 + +### 更改可以访问运行器组的组织或存储库 + +{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %} +{% data reusables.actions.runner-groups-navigate-to-repo-org-enterprise %} +{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %} +1. 对于企业中的运行器组,在 **Organization access(组织访问)**下,修改可以访问运行器组的组织。 对于组织中的运行器组,在 **Repository access(存储库访问)**下,修改可以访问运行器组的存储库。 + +{% elsif ghae or ghes < 3.4 %} +{% data reusables.actions.configure-runner-group-access %} +{% endif %} + +{% ifversion restrict-groups-to-workflows %} +### 更改可以访问运行器组的工作流程 +You can configure a runner group to run either selected workflows or all workflows. For example, you might use this setting to protect secrets that are stored on runners or to standardize deployment workflows by restricting a runner group to run only a specific reusable workflow. 如果配置企业共享的组织的运行组,则不能覆盖此设置。 +{% data reusables.actions.runner-groups-navigate-to-repo-org-enterprise %} +{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %} +1. 在 **Workflow access(工作流程访问)**下,选择下拉菜单,然后单击 **Selected workflows(选定的工作流程)**。 +1. 单击 {% octicon "gear" aria-label="the gear icon" %}。 +1. 输入以逗号分隔的可访问运行器组的工作流程列表。 使用完整路径,包括存储库名称和所有者。 将工作流程固定到分支、标记或完整 SHA。 例如:`octo-org/octo-repo/.github/workflows/build.yml@v2, octo-org/octo-repo/.github/workflows/deploy.yml@d6dc6c96df4f32fa27b039f2084f576ed2c5c2a5, monalisa/octo-test/.github/workflows/test.yml@main`。 + + 只有直接在所选工作流程中定义的作业才能访问运行器组。 + + 组织拥有的运行器组无法访问企业中其他组织的工作流程。相反,您必须创建企业拥有的运行器组。 + +1. 单击 **Save(保存)**。 + +{% endif %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/actions/changing-the-name-of-a-runner-group.md b/translations/zh-CN/data/reusables/actions/changing-the-name-of-a-runner-group.md new file mode 100644 index 000000000000..165e27a249d3 --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/changing-the-name-of-a-runner-group.md @@ -0,0 +1,9 @@ +{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %} +{% data reusables.actions.runner-groups-navigate-to-repo-org-enterprise %} +{% data reusables.actions.settings-sidebar-actions-runner-groups-selection %} +1. 更改运行器组名称。 + +{% elsif ghae or ghes < 3.4 %} +{% data reusables.actions.configure-runner-group %} +1. 更改运行器组名称。 +{% endif %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/actions/self-hosted-runner-configure-runner-group-access.md b/translations/zh-CN/data/reusables/actions/configure-runner-group-access.md similarity index 84% rename from translations/zh-CN/data/reusables/actions/self-hosted-runner-configure-runner-group-access.md rename to translations/zh-CN/data/reusables/actions/configure-runner-group-access.md index 7e2098986bf4..cc6b9d22ede9 100644 --- a/translations/zh-CN/data/reusables/actions/self-hosted-runner-configure-runner-group-access.md +++ b/translations/zh-CN/data/reusables/actions/configure-runner-group-access.md @@ -1,4 +1,4 @@ -{% data reusables.actions.self-hosted-runner-configure-runner-group %} +{% data reusables.actions.configure-runner-group %} 1. 修改策略选项。 {% ifversion not ghae %} diff --git a/translations/zh-CN/data/reusables/actions/self-hosted-runner-configure-runner-group.md b/translations/zh-CN/data/reusables/actions/configure-runner-group.md similarity index 100% rename from translations/zh-CN/data/reusables/actions/self-hosted-runner-configure-runner-group.md rename to translations/zh-CN/data/reusables/actions/configure-runner-group.md diff --git a/translations/zh-CN/data/reusables/actions/self-hosted-runner-create-group.md b/translations/zh-CN/data/reusables/actions/create-runner-group.md similarity index 100% rename from translations/zh-CN/data/reusables/actions/self-hosted-runner-create-group.md rename to translations/zh-CN/data/reusables/actions/create-runner-group.md diff --git a/translations/zh-CN/data/reusables/actions/creating-a-runner-group-for-an-enterprise.md b/translations/zh-CN/data/reusables/actions/creating-a-runner-group-for-an-enterprise.md new file mode 100644 index 000000000000..2aa6c315822f --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/creating-a-runner-group-for-an-enterprise.md @@ -0,0 +1,28 @@ +{% comment %} + +Always include a security admonition above this procedure. This is either one of the following, depending on whether the context is self-hosted runners or larger runners. + +{% data reusables.actions.self-hosted-runner-security-admonition %} +{% data reusables.actions.hosted-runner-security-admonition %} + +{% endcomment %} + +Enterprises can add their runners to groups for access management. Enterprises can create groups of runners that are accessible to specific organizations in the enterprise account{% ifversion restrict-groups-to-workflows %} or to specific workflows{% endif %}. 然后,组织所有者可以为企业运行器组分配更细致的存储库{% ifversion restrict-groups-to-workflows %} 和工作流程{% endif %} 访问策略。 For information about how to create a runner group with the REST API, see the enterprise endpoints in the [{% data variables.product.prodname_actions %} REST API](/rest/reference/actions#self-hosted-runner-groups). + +Runners are automatically assigned to the default group when created, and can only be members of one group at a time. 您可以在注册过程中将运行器分配给特定组,也可以稍后将运行器从默认组移到自定义组。 + +创建组时,必须选择用于定义哪些组织有权访问运行器组的策略。 + +{% data reusables.actions.runner-groups-add-to-enterprise-first-steps %} +1. 要为组织访问选择策略,请选择 **Organization access(组织访问)**下拉列表,然后单击一个策略。 您可以将运行器组配置为可供特定组织列表或企业中的所有组织访问。{% ifversion ghes %} 默认情况下,只有私有存储库可以访问运行器组中的运行器,但您可以覆盖此操作。{% endif %} + + {%- ifversion ghec or ghes %} + + ![添加运行器组选项](/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png) + {%- elsif ghae %} + + ![添加运行器组选项](/assets/images/help/settings/actions-enterprise-account-add-runner-group-options-ae.png) + {%- endif %} +{% data reusables.actions.runner-group-assign-policy-workflow %} +1. 单击 **Save group(保存组)**创建组并应用策略。 + diff --git a/translations/zh-CN/data/reusables/actions/creating-a-runner-group-for-an-organization.md b/translations/zh-CN/data/reusables/actions/creating-a-runner-group-for-an-organization.md new file mode 100644 index 000000000000..d76d4cf769e2 --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/creating-a-runner-group-for-an-organization.md @@ -0,0 +1,38 @@ +{% comment %} + +Always include a security admonition above this procedure. This is either one of the following, depending on whether the context is self-hosted runners or larger runners. + +{% data reusables.actions.self-hosted-runner-security-admonition %} +{% data reusables.actions.hosted-runner-security-admonition %} + +{% endcomment %} + +All organizations have a single default runner group. Organizations within an enterprise account can create additional groups. 组织管理员可以允许单个仓库访问运行器组。 For information about how to create a runner group with the REST API, see "[Self-hosted runner groups](/rest/reference/actions#self-hosted-runner-groups)." + +Runners are automatically assigned to the default group when created, and can only be members of one group at a time. 您可以将运行器从默认组移到您创建的任何组。 + +创建组时,必须选择一个策略,用于定义哪些存储库{% ifversion restrict-groups-to-workflows %} 和工作流程{% endif %} 有权访问运行器组。 + +{% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %} +{% data reusables.organizations.navigate-to-org %} +{% data reusables.organizations.org_settings %} +{% data reusables.organizations.settings-sidebar-actions-runner-groups %} +1. 在“Runner groups(运行器组)”部分,单击 **New runner group(新运行器组)**。 +1. 为运行器组输入名称。 + {% data reusables.actions.runner-group-assign-policy-repo %} +{% data reusables.actions.runner-group-assign-policy-workflow %}{%- ifversion restrict-groups-to-workflows %} 组织拥有的运行器组无法访问企业中其他组织的工作流程;相反,您必须创建企业拥有的运行器组。{% endif %} +{% data reusables.actions.create-runner-group %} +{% elsif ghae or ghes < 3.4 %} +{% data reusables.organizations.navigate-to-org %} +{% data reusables.organizations.org_settings %} +{% data reusables.organizations.settings-sidebar-actions-runner-groups %} +1. 在 {% ifversion ghes or ghae %}“Runners(运行器)”{% endif %} 下,单击 **Add new(新增)**,然后单击 **New group(新建组)**。 + + ![添加运行器组](/assets/images/help/settings/actions-org-add-runner-group.png) +1. 输入运行程序组的名称,并分配仓库访问策略。 + + 您可以将运行器组配置为可供特定的存储库列表或组织中的所有存储库访问。{% ifversion ghec or ghes %} 默认情况下,只有私有存储库可以访问运行器组中的运行器,但您可以覆盖此操作。 如果配置企业共享的组织的运行组,则不能覆盖此设置。{% endif %} + + ![添加运行器组选项](/assets/images/help/settings/actions-org-add-runner-group-options.png) +1. 单击 **Save group(保存组)**创建组并应用策略。 +{% endif %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/actions/hosted-runner-security-admonition.md b/translations/zh-CN/data/reusables/actions/hosted-runner-security-admonition.md new file mode 100644 index 000000000000..8ac0a9a32988 --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/hosted-runner-security-admonition.md @@ -0,0 +1,5 @@ +{% warning %} + +**警告**:{% data reusables.actions.hosted-runner-security %} + +{% endwarning %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/actions/hosted-runner-security.md b/translations/zh-CN/data/reusables/actions/hosted-runner-security.md new file mode 100644 index 000000000000..ed12d189db73 --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/hosted-runner-security.md @@ -0,0 +1,3 @@ +We recommend that you only use {% data variables.actions.hosted_runner %}s with private repositories: +- Forks of your repository can potentially run dangerous code on your {% data variables.actions.hosted_runner %} by creating a pull request that executes the code in a workflow. +- You could incur unexpected costs if you allow forked repositories to run jobs on your {% data variables.actions.hosted_runner %}s. \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/actions/jobs/section-running-jobs-in-a-container.md b/translations/zh-CN/data/reusables/actions/jobs/section-running-jobs-in-a-container.md index 854fb0881a5f..ae92017ede6e 100644 --- a/translations/zh-CN/data/reusables/actions/jobs/section-running-jobs-in-a-container.md +++ b/translations/zh-CN/data/reusables/actions/jobs/section-running-jobs-in-a-container.md @@ -2,6 +2,12 @@ 若不设置 `container`,所有步骤将直接在 `runs-on` 指定的主机上运行,除非步骤引用已配置为在容器中运行的操作。 +{% note %} + +**Note:** The default shell for `run` steps inside a container is `sh` instead of `bash`. This can be overridden with [`jobs..defaults.run`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_iddefaultsrun) or [`jobs..steps[*].shell`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell). + +{% endnote %} + ### 示例:在容器中运行作业 ```yaml{:copy} diff --git a/translations/zh-CN/data/reusables/actions/moving-a-runner-to-a-group.md b/translations/zh-CN/data/reusables/actions/moving-a-runner-to-a-group.md new file mode 100644 index 000000000000..ca8a007c1c84 --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/moving-a-runner-to-a-group.md @@ -0,0 +1,12 @@ +If you don't specify a runner group during the registration process, your new runners are automatically assigned to the default group, and can then be moved to another group. + +{% data reusables.actions.self-hosted-runner-navigate-to-org-enterprise %} +{% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %} +1. 在“Runners(运行器)”列表中,单击您要配置的运行器。 +2. 选择 **Runner group(运行器组)**下拉列表。 +3. 在“Move runner to group(将运行器移动到组)”中,选择运行器的目的地组。 +{% elsif ghae or ghes < 3.4 %} +1. 在设置页面的 {% ifversion ghes or ghae %} Runner groups(运行器组){% endif %} 部分,找到要移动的运行器的当前组,并展开组成员列表。 ![查看运行器组成员](/assets/images/help/settings/actions-org-runner-group-members.png) +2. 选中自托管运行器旁边的复选框,然后单击 **Move to group(移动到组)**以查看可用的目的地。 ![运行器组成员移动](/assets/images/help/settings/actions-org-runner-group-member-move.png) +3. 要移动运行器,请单击目标组。 ![运行器组成员移动](/assets/images/help/settings/actions-org-runner-group-member-move-destination.png) +{% endif %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/actions/removing-a-runner-group.md b/translations/zh-CN/data/reusables/actions/removing-a-runner-group.md new file mode 100644 index 000000000000..063c236afc03 --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/removing-a-runner-group.md @@ -0,0 +1,9 @@ +Runners are automatically returned to the default group when their group is removed. + +{% ifversion ghes or ghae or ghec %} +{% data reusables.actions.runner-groups-navigate-to-repo-org-enterprise %} +1. 在组列表中,在要删除的组右侧,单击 {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}。 +2. 要删除组,请单击 **Remove group(删除组)**。 +3. 查看确认提示,然后单击 **Remove this runner group(删除此运行器组)**。 Any runners still in this group will be automatically moved to the default group, where they will inherit the access permissions assigned to that group. + +{% endif %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/actions/runner-group-enterprise-overview.md b/translations/zh-CN/data/reusables/actions/runner-group-enterprise-overview.md new file mode 100644 index 000000000000..09f88eb9b922 --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/runner-group-enterprise-overview.md @@ -0,0 +1,3 @@ +Runner groups are used to control access to runners at the organization and enterprise level. Enterprise owners can configure access policies that control which organizations {% ifversion restrict-groups-to-workflows %}and workflows {% endif %}in an enterprise have access to the runner group. 组织所有者可以配置访问策略,以控制组织中哪些存储库{% ifversion restrict-groups-to-workflows %} 和工作流程{% endif %} 可以访问运行器组。 + +When an enterprise owner grants access to a runner group, organization owners can see the runner group listed in the organization's runner settings. 然后,组织所有者可以为企业运行器组分配更细致的存储库{% ifversion restrict-groups-to-workflows %} 和工作流程{% endif %} 访问策略。 \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/actions/self-hosted-runner-groups-add-to-enterprise-first-steps.md b/translations/zh-CN/data/reusables/actions/runner-groups-add-to-enterprise-first-steps.md similarity index 100% rename from translations/zh-CN/data/reusables/actions/self-hosted-runner-groups-add-to-enterprise-first-steps.md rename to translations/zh-CN/data/reusables/actions/runner-groups-add-to-enterprise-first-steps.md diff --git a/translations/zh-CN/data/reusables/actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md b/translations/zh-CN/data/reusables/actions/runner-groups-navigate-to-repo-org-enterprise.md similarity index 85% rename from translations/zh-CN/data/reusables/actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md rename to translations/zh-CN/data/reusables/actions/runner-groups-navigate-to-repo-org-enterprise.md index c2aeec4eb092..49ee6879d043 100644 --- a/translations/zh-CN/data/reusables/actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md +++ b/translations/zh-CN/data/reusables/actions/runner-groups-navigate-to-repo-org-enterprise.md @@ -1,9 +1,9 @@ {% ifversion fpt %} -1. 导航到自托管运行器组所在的存储库或组织的主页。 +1. Navigate to the main page of the repository or organization where your runner groups are located. 2. 单击 {% octicon "gear" aria-label="The Settings gear" %} **Settings(设置)**。 {% data reusables.organizations.settings-sidebar-actions-runner-groups %} {% elsif ghec or ghes or ghae %} -1. 导航到自托管运行器组所在的位置: +1. Navigate to where your runner groups are located: * **在组织中**,导航到主页并单击 {% octicon "gear" aria-label="The Settings gear" %} **Settings(设置)**。 * **如果使用企业级组**: diff --git a/translations/zh-CN/data/reusables/actions/self-hosted-runner-add-to-enterprise.md b/translations/zh-CN/data/reusables/actions/self-hosted-runner-add-to-enterprise.md index c6a99ef3213c..c212116f7b66 100644 --- a/translations/zh-CN/data/reusables/actions/self-hosted-runner-add-to-enterprise.md +++ b/translations/zh-CN/data/reusables/actions/self-hosted-runner-add-to-enterprise.md @@ -3,7 +3,7 @@ {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} {% data reusables.enterprise-accounts.actions-runners-tab %} -1. 单击 **New runner(新运行器)**。 +{% ifversion actions-hosted-runners %}1. Click **New runner**, then click **New self-hosted runner**.{% else %}1. Click **New runner**.{% endif %} {% data reusables.actions.self-hosted-runner-configure %} {%- elsif ghae or ghes < 3.4 %} 要将自托管的运行器添加到企业,您必须是组织所有者。 diff --git a/translations/zh-CN/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md b/translations/zh-CN/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md index 8ba85c019063..225c08eea30b 100644 --- a/translations/zh-CN/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md +++ b/translations/zh-CN/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md @@ -3,7 +3,7 @@ 2. 单击 {% octicon "gear" aria-label="The Settings gear" %} **Settings(设置)**。 {% data reusables.organizations.settings-sidebar-actions-runners %} {% elsif ghec or ghes or ghae %} -1. 导航到自托管运行器注册的位置: +1. Navigate to where your runner is registered: * **在组织中**,导航到主页并单击 {% octicon "gear" aria-label="The Settings gear" %} **Settings(设置)**。 * **如果使用企业级运行器**: diff --git a/translations/zh-CN/data/reusables/actions/self-hosted-runner-navigate-to-repo-org-enterprise.md b/translations/zh-CN/data/reusables/actions/self-hosted-runner-navigate-to-repo-org-enterprise.md index 5dc6d365316e..2b8cd78bd69b 100644 --- a/translations/zh-CN/data/reusables/actions/self-hosted-runner-navigate-to-repo-org-enterprise.md +++ b/translations/zh-CN/data/reusables/actions/self-hosted-runner-navigate-to-repo-org-enterprise.md @@ -3,7 +3,7 @@ 2. 单击 {% octicon "gear" aria-label="The Settings gear" %} **Settings(设置)**。 {% data reusables.organizations.settings-sidebar-actions-runners %} {% elsif ghec or ghes or ghae %} -1. 导航到自托管运行器注册的位置: +1. Navigate to where your runner is registered: * **在组织或仓库中**,导航到主页并单击 {% octicon "gear" aria-label="The Settings gear" %} **Settings(设置)**。 * **如果使用企业级运行器**: diff --git a/translations/zh-CN/data/reusables/actions/self-hosted-runner-security-admonition.md b/translations/zh-CN/data/reusables/actions/self-hosted-runner-security-admonition.md new file mode 100644 index 000000000000..0811e2b67c80 --- /dev/null +++ b/translations/zh-CN/data/reusables/actions/self-hosted-runner-security-admonition.md @@ -0,0 +1,7 @@ +{% warning %} + +**警告**:{% data reusables.actions.self-hosted-runner-security %} + +更多信息请参阅“[关于自托管运行器](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)”。 + +{% endwarning %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/actions/self-hosted-runner-security.md b/translations/zh-CN/data/reusables/actions/self-hosted-runner-security.md index c0f3eeedffe6..bbce14b0a857 100644 --- a/translations/zh-CN/data/reusables/actions/self-hosted-runner-security.md +++ b/translations/zh-CN/data/reusables/actions/self-hosted-runner-security.md @@ -1 +1 @@ -建议仅将自托管运行器用于私有仓库。 这是因为,通过创建在工作流程中执行代码的拉取请求,仓库的复刻可能会在您的自托管运行器上运行危险代码。 +建议仅将自托管运行器用于私有仓库。 This is because forks of your public repository can potentially run dangerous code on your self-hosted runner machine by creating a pull request that executes the code in a workflow. \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/billing/billing-hosted-runners.md b/translations/zh-CN/data/reusables/billing/billing-hosted-runners.md new file mode 100644 index 000000000000..288139688468 --- /dev/null +++ b/translations/zh-CN/data/reusables/billing/billing-hosted-runners.md @@ -0,0 +1 @@ +| Linux | 4 | $0.016 | | Linux | 8 | $0.032 | | Linux | 16 | $0.064 | | Linux | 32 | $0.128 | | Linux | 64 | $0.256 | | Windows | 8 | $0.064 | | Windows | 16 | $0.128 | | Windows | 32 | $0.256 | | Windows | 64 | $0.512 | \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/billing/billing-standard-runners.md b/translations/zh-CN/data/reusables/billing/billing-standard-runners.md new file mode 100644 index 000000000000..1083150a9045 --- /dev/null +++ b/translations/zh-CN/data/reusables/billing/billing-standard-runners.md @@ -0,0 +1,5 @@ +| 操作系统 | Cores | 每分钟费率(美元) | +| ------- | ----- | --------- | +| Linux | 2 | $0.008 | +| macOS | 3 | $0.08 | +| Windows | 2 | $0.016 | diff --git a/translations/zh-CN/data/reusables/code-scanning/example-configuration-files.md b/translations/zh-CN/data/reusables/code-scanning/example-configuration-files.md index cb72da50c753..a5debd8119cc 100644 --- a/translations/zh-CN/data/reusables/code-scanning/example-configuration-files.md +++ b/translations/zh-CN/data/reusables/code-scanning/example-configuration-files.md @@ -30,3 +30,22 @@ paths-ignore: - src/node_modules - '**/*.test.js' ``` + +{% ifversion code-scanning-exclude-queries-from-analysis %} + +The following configuration file only runs queries that generate alerts of severity error. The configuration first selects all the default queries, all queries in `./my-queries`, and the default suite in `codeql/java-queries`, then excludes all the queries that generate warnings or recommendations. + +``` yaml +queries: + - name: Use an in-repository QL pack (run queries in the my-queries directory) + uses: ./my-queries +packs: + - codeql/java-queries +query-filters: +- exclude: + problem.severity: + - warning + - recommendation +``` + +{% endif %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/code-scanning/run-additional-queries.md b/translations/zh-CN/data/reusables/code-scanning/run-additional-queries.md index 3f25bd67d1b3..fddae57c6268 100644 --- a/translations/zh-CN/data/reusables/code-scanning/run-additional-queries.md +++ b/translations/zh-CN/data/reusables/code-scanning/run-additional-queries.md @@ -1,5 +1,13 @@ When you use {% data variables.product.prodname_codeql %} to scan code, the {% data variables.product.prodname_codeql %} analysis engine generates a database from the code and runs queries on it. {% data variables.product.prodname_codeql %} analysis uses a default set of queries, but you can specify more queries to run, in addition to the default queries. +{% ifversion code-scanning-exclude-queries-from-analysis %} +{% tip %} + +You can also specify the queries you want to exclude from analysis, or include in the analysis. This requires the use of a custom configuration file. For more information, see "[Using a custom configuration file](#using-a-custom-configuration-file)" and "[Excluding specific queries from analysis](#excluding-specific-queries-from-analysis) " below. + +{% endtip %} +{% endif %} + {% ifversion codeql-packs %} You can run extra queries if they are part of a {% data variables.product.prodname_codeql %} pack (beta) published to the {% data variables.product.company_short %} {% data variables.product.prodname_container_registry %} or a {% data variables.product.prodname_ql %} pack stored in a repository. For more information, see "[About {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}](/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql#about-codeql-queries)." diff --git a/translations/zh-CN/data/reusables/codespaces/codespaces-org-policies-note.md b/translations/zh-CN/data/reusables/codespaces/codespaces-org-policies-note.md index 69e653079137..90604549480a 100644 --- a/translations/zh-CN/data/reusables/codespaces/codespaces-org-policies-note.md +++ b/translations/zh-CN/data/reusables/codespaces/codespaces-org-policies-note.md @@ -1,5 +1,5 @@ {% note %} -**Note**: Organization policies you define for {% data variables.product.prodname_codespaces %} only apply to codespaces for which your organization will be billed. If an individual user creates a codespace for a repository in your organization, and the organization is not billed, then the codespace will not be bound by these policies. For information on how to choose who can create codespaces that are billed to your organization, see "[Enabling {% data variables.product.prodname_github_codespaces %} for your organization](https://docs-internal-29134-ad7bd8.preview.ghdocs.com/en/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization#choose-who-can-create-codespaces-that-are-billed-to-your-organization)." +**Note**: Organization policies you define for {% data variables.product.prodname_codespaces %} only apply to codespaces for which your organization will be billed. If an individual user creates a codespace for a repository in your organization, and the organization is not billed, then the codespace will not be bound by these policies. For information on how to choose who can create codespaces that are billed to your organization, see "[Enabling {% data variables.product.prodname_github_codespaces %} for your organization](/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization#choose-who-can-create-codespaces-that-are-billed-to-your-organization)." {% endnote %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/codespaces/open-codespace-from-template-repo.md b/translations/zh-CN/data/reusables/codespaces/open-codespace-from-template-repo.md new file mode 100644 index 000000000000..d6507d6c066b --- /dev/null +++ b/translations/zh-CN/data/reusables/codespaces/open-codespace-from-template-repo.md @@ -0,0 +1,8 @@ +1. Select an owner for the new repository, enter a repository name, select your preferred privacy setting, and click **Create repository from template**. +1. On the main page of the newly created repository, click the **{% octicon "code" aria-label="The code icon" %} Code** button and select the **Codespaces** tab. + + ![新建代码空间按钮](/assets/images/help/codespaces/new-codespace-button.png) + + If you don’t see this tab, {% data variables.product.prodname_github_codespaces %} isn't available for you. For more information about access to {% data variables.product.prodname_github_codespaces %}, see "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-github-codespaces)." + +1. On the **Codespaces** tab, click **Create codespace on main**. diff --git a/translations/zh-CN/data/reusables/codespaces/rebuild-command.md b/translations/zh-CN/data/reusables/codespaces/rebuild-command.md index b7598729fd13..22a3ae780c30 100644 --- a/translations/zh-CN/data/reusables/codespaces/rebuild-command.md +++ b/translations/zh-CN/data/reusables/codespaces/rebuild-command.md @@ -1,5 +1,3 @@ -1. Access the {% data variables.product.prodname_vscode_command_palette %} (Shift + Command + P / Ctrl + Shift + P), then start typing "rebuild". 选择 **Codespaces: Rebuild Container(代码空间:重建容器)**。 +1. Access the {% data variables.product.prodname_vscode_command_palette_shortname %} (Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux)), then start typing "rebuild". 选择 **Codespaces: Rebuild Container(代码空间:重建容器)**。 ![重建容器选项](/assets/images/help/codespaces/codespaces-rebuild.png) - - diff --git a/translations/zh-CN/data/reusables/codespaces/remote-explorer.md b/translations/zh-CN/data/reusables/codespaces/remote-explorer.md index c46ed9b53925..545bdcf0c91d 100644 --- a/translations/zh-CN/data/reusables/codespaces/remote-explorer.md +++ b/translations/zh-CN/data/reusables/codespaces/remote-explorer.md @@ -2,7 +2,7 @@ **Note**: If the Remote Explorer is not displayed in the Activity Bar: -1. Access the command palette. For example, by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux). +1. Access the Command Palette. For example, by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux). 1. Type: `codespaces`. 1. Click **Codespaces: Details**. diff --git a/translations/zh-CN/data/reusables/dependabot/dependabot-alerts-filters.md b/translations/zh-CN/data/reusables/dependabot/dependabot-alerts-filters.md index 0a2e0ad1ba34..29684cdd929f 100644 --- a/translations/zh-CN/data/reusables/dependabot/dependabot-alerts-filters.md +++ b/translations/zh-CN/data/reusables/dependabot/dependabot-alerts-filters.md @@ -2,7 +2,7 @@ You can sort and filter {% data variables.product.prodname_dependabot_alerts %} | 选项 | 描述 | 示例 | |:---------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `生态系统` | Displays alerts for the selected ecosystem | Use `ecosystem:npm` to show {% data variables.product.prodname_dependabot_alerts %} for npm |{% ifversion fpt or ghec or ghes > 3.5 %} +| `生态系统` | Displays alerts for the selected ecosystem | Use `ecosystem:npm` to show {% data variables.product.prodname_dependabot_alerts %} for npm |{% ifversion fpt or ghec or ghes > 3.5 or ghae-issue-7891 %} | `has` | Displays alerts meeting the selected filter criteria | Use `has:patch` to show alerts related to advisories that have a patch{% ifversion dependabot-alerts-vulnerable-calls %}
Use `has:vulnerable-calls` to show alerts relating to calls to vulnerable functions{% endif %} {% endif %} | `is` | Displays alerts based on their state | Use `is:open` to show open alerts | diff --git a/translations/zh-CN/data/reusables/dependency-review/dependency-review-action-beta-note.md b/translations/zh-CN/data/reusables/dependency-review/dependency-review-action-beta-note.md index 47fc2e3a3fec..6c5922c01c39 100644 --- a/translations/zh-CN/data/reusables/dependency-review/dependency-review-action-beta-note.md +++ b/translations/zh-CN/data/reusables/dependency-review/dependency-review-action-beta-note.md @@ -2,4 +2,4 @@ **注:**{% data variables.product.prodname_dependency_review_action %} 目前处于公测阶段,可能会更改。 -{% endnote %} +{% endnote %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/dependency-review/dependency-review-action-overview.md b/translations/zh-CN/data/reusables/dependency-review/dependency-review-action-overview.md index fdfb2f6f8c34..d3b89434d276 100644 --- a/translations/zh-CN/data/reusables/dependency-review/dependency-review-action-overview.md +++ b/translations/zh-CN/data/reusables/dependency-review/dependency-review-action-overview.md @@ -1,3 +1,3 @@ The {% data variables.product.prodname_dependency_review_action %} scans your pull requests for dependency changes and raises an error if any new dependencies have known vulnerabilities. The action is supported by an API endpoint that compares the dependencies between two revisions and reports any differences. -For more information about the action and the API endpoint, see "[About dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-reinforcement)," and "[Dependency review](/rest/dependency-graph/dependency-review)" in the API documentation, respectively. +For more information about the action and the API endpoint, see the [`dependency-review-action`](https://github.com/actions/dependency-review-action) documentation, and "[Dependency review](/rest/dependency-graph/dependency-review)" in the API documentation. diff --git a/translations/zh-CN/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md b/translations/zh-CN/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md index c5d610006352..d9e308eee95d 100644 --- a/translations/zh-CN/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md +++ b/translations/zh-CN/data/reusables/enterprise_site_admin_settings/pgp-key-env-variable.md @@ -1,4 +1,4 @@ -1. Define the key as a environment variable for {% data variables.product.product_name %}, replacing `` with the GPG key ID. +1. Define the key as an environment variable for {% data variables.product.product_name %}, replacing `` with the GPG key ID. ```bash{:copy} ghe-config "secrets.gpgverify.web-signing-key" "$(gpg --export-secret-keys -a | awk '{printf "%s\\n", $0}')" diff --git a/translations/zh-CN/data/reusables/gated-features/hosted-runners.md b/translations/zh-CN/data/reusables/gated-features/hosted-runners.md new file mode 100644 index 000000000000..4f1e2137bbfb --- /dev/null +++ b/translations/zh-CN/data/reusables/gated-features/hosted-runners.md @@ -0,0 +1 @@ +The {% data variables.actions.hosted_runner %}s feature is currently in beta for organizations and enterprises using the {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %} plans, and is subject to change. \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/getting-started/bearer-vs-token.md b/translations/zh-CN/data/reusables/getting-started/bearer-vs-token.md new file mode 100644 index 000000000000..9dd0b62adaba --- /dev/null +++ b/translations/zh-CN/data/reusables/getting-started/bearer-vs-token.md @@ -0,0 +1 @@ +In most cases, you can use `Authorization: Bearer` or `Authorization: token` to pass a token. However, if you are passing a JSON web token (JWT), you must use `Authorization: Bearer`. \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/gpg/copy-gpg-key-id.md b/translations/zh-CN/data/reusables/gpg/copy-gpg-key-id.md index f5de6e1efb6c..51cdb3d2e331 100644 --- a/translations/zh-CN/data/reusables/gpg/copy-gpg-key-id.md +++ b/translations/zh-CN/data/reusables/gpg/copy-gpg-key-id.md @@ -1,9 +1,9 @@ 1. 从 GPG 密钥列表中复制您想要使用的 GPG 密钥 ID 的长形式。 在此例中,GPG 密钥 ID 是 `3AA5C34371567BD2`: - ```shell + ```shell{:copy} $ gpg --list-secret-keys --keyid-format=long /Users/hubot/.gnupg/secring.gpg ------------------------------------ sec 4096R/3AA5C34371567BD2 2016-03-10 [expires: 2017-03-10] uid Hubot ssb 4096R/42B317FD4BA89E7A 2016-03-10 - ``` + ``` diff --git a/translations/zh-CN/data/reusables/gpg/list-keys-with-note.md b/translations/zh-CN/data/reusables/gpg/list-keys-with-note.md index 38cea23d7434..3ad866aa38ec 100644 --- a/translations/zh-CN/data/reusables/gpg/list-keys-with-note.md +++ b/translations/zh-CN/data/reusables/gpg/list-keys-with-note.md @@ -1,10 +1,11 @@ - 1. 使用 `gpg --list-secret-keys --keyid-format=long` 命令列出您拥有其公钥和私钥的长形式 GPG 密钥。 签名提交或标记需要私钥。 - ```shell - $ gpg --list-secret-keys --keyid-format=long -``` - {% note %} - **注:**Linux上的一些 GPG 安装可能需要使用 `gpg2 --list-keyid-form LONG` 查看您现有密钥的列表。 在这种情况下,您还需要运行 `git config --global gpg.program gpg2` 来配置 Git 使用 `git gpg2`。 + ```shell{:copy} + $ gpg --list-secret-keys --keyid-format=long + ``` + + {% note %} + + **注:**Linux上的一些 GPG 安装可能需要使用 `gpg2 --list-keyid-form LONG` 查看您现有密钥的列表。 在这种情况下,您还需要运行 `git config --global gpg.program gpg2` 来配置 Git 使用 `git gpg2`。 - {% endnote %} + {% endnote %} diff --git a/translations/zh-CN/data/reusables/identity-and-permissions/ipv6-allow-lists.md b/translations/zh-CN/data/reusables/identity-and-permissions/ipv6-allow-lists.md new file mode 100644 index 000000000000..3c26491fe2fb --- /dev/null +++ b/translations/zh-CN/data/reusables/identity-and-permissions/ipv6-allow-lists.md @@ -0,0 +1,7 @@ +{% ifversion fpt or ghec %} +{% note %} + +**Note:** {% data variables.product.company_short %} is gradually rolling out support for IPv6. As {% data variables.product.prodname_dotcom %} services continue to add IPv6 support, we will start recognizing IPv6 addresses of {% data variables.product.prodname_dotcom %} users. To prevent possible access interruptions, please ensure you have added any necessary IPv6 addresses to your IP allow list. + +{% endnote %} +{% endif %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/organizations/about-following-organizations.md b/translations/zh-CN/data/reusables/organizations/about-following-organizations.md new file mode 100644 index 000000000000..52e52467fbf5 --- /dev/null +++ b/translations/zh-CN/data/reusables/organizations/about-following-organizations.md @@ -0,0 +1 @@ +When you follow organizations on {% data variables.product.product_name %}, you'll see their {% ifversion fpt or ghec %}public{% endif %} activity on your personal dashboard. This activity includes new discussions, sponsorships, and repositories. \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/organizations/follow-organizations-beta.md b/translations/zh-CN/data/reusables/organizations/follow-organizations-beta.md new file mode 100644 index 000000000000..27d068eb4616 --- /dev/null +++ b/translations/zh-CN/data/reusables/organizations/follow-organizations-beta.md @@ -0,0 +1,5 @@ +{% note %} + +**注意:** 关注组织的功能目前处于公开测试阶段,可能会发生变化。 + +{% endnote %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/package_registry/authenticate-packages.md b/translations/zh-CN/data/reusables/package_registry/authenticate-packages.md index a766f6e96d9f..5ca4e91584b2 100644 --- a/translations/zh-CN/data/reusables/package_registry/authenticate-packages.md +++ b/translations/zh-CN/data/reusables/package_registry/authenticate-packages.md @@ -4,4 +4,4 @@ You can use a personal access token (PAT) to authenticate to {% data variables.p To authenticate to a {% data variables.product.prodname_registry %} registry within a {% data variables.product.prodname_actions %} workflow, you can use: - `GITHUB_TOKEN` to publish packages associated with the workflow repository. -- a PAT to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). +- a PAT with at least `packages:read` scope to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). diff --git a/translations/zh-CN/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md b/translations/zh-CN/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md deleted file mode 100644 index a54f9a084454..000000000000 --- a/translations/zh-CN/data/reusables/package_registry/authenticate_with_pat_for_container_registry.md +++ /dev/null @@ -1,11 +0,0 @@ -{% ifversion fpt or ghec or ghes > 3.4 %} - -To authenticate to the {% data variables.product.prodname_container_registry %} within a {% data variables.product.prodname_actions %} workflow, use the `GITHUB_TOKEN` for the best security and experience. If your workflow is using a personal access token (PAT) to authenticate to `{% data reusables.package_registry.container-registry-hostname %}`, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. - -{% ifversion fpt or ghec %}For guidance on updating your workflows that authenticate to `{% data reusables.package_registry.container-registry-hostname %}` with a personal access token, see "[Upgrading a workflow that accesses `ghcr.io`](/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions#upgrading-a-workflow-that-accesses-ghcrio)."{% endif %} - -For more information about the `GITHUB_TOKEN`, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)." - -If you're using the {% data variables.product.prodname_container_registry %} in actions, follow our security best practices at "[Security hardening for GitHub Actions](/actions/getting-started-with-github-actions/security-hardening-for-github-actions#considering-cross-repository-access)." - -{% endif %} diff --git a/translations/zh-CN/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md b/translations/zh-CN/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md new file mode 100644 index 000000000000..9eb44525c718 --- /dev/null +++ b/translations/zh-CN/data/reusables/package_registry/authenticate_with_pat_for_v2_registry.md @@ -0,0 +1,7 @@ +If your workflow is using a personal access token (PAT) to authenticate to a registry, then we highly recommend you update your workflow to use the `GITHUB_TOKEN`. + +{% ifversion fpt or ghec %}For guidance on updating your workflows that authenticate to a registry with a personal access token, see "[Upgrading a workflow that accesses a registry using a PAT](/packages/managing-github-packages-using-github-actions-workflows/publishing-and-installing-a-package-with-github-actions#upgrading-a-workflow-that-accesses-a-registry-using-a-pat)."{% endif %} + +有关 `GITHUB_TOKEN` 的更多信息,请参阅“[工作流程中的身份验证](/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)”。 + +For more information about the best practises when using a registry in actions, see "[Security hardening for GitHub Actions](/actions/getting-started-with-github-actions/security-hardening-for-github-actions#considering-cross-repository-access)." diff --git a/translations/zh-CN/data/reusables/package_registry/no-graphql-to-delete-packages.md b/translations/zh-CN/data/reusables/package_registry/no-graphql-to-delete-packages.md new file mode 100644 index 000000000000..cbab609f2b0e --- /dev/null +++ b/translations/zh-CN/data/reusables/package_registry/no-graphql-to-delete-packages.md @@ -0,0 +1 @@ +{% ifversion fpt or ghec %} The {% data variables.product.prodname_registry %} GraphQL API does not support containers or Docker images that use the package namespace `https://ghcr.io/OWNER/PACKAGE-NAME`, or npm images that use the package namespace `https://npm.pkg.github.com/OWNER/PACKAGE-NAME`.{% endif %} \ No newline at end of file diff --git a/translations/zh-CN/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md b/translations/zh-CN/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md index 313d4af66958..0e349b01cbac 100644 --- a/translations/zh-CN/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md +++ b/translations/zh-CN/data/reusables/release-notes/ghas-3.4-secret-scanning-known-issue.md @@ -1,16 +1,16 @@ -{% ifversion ghes > 3.1 or ghes < 3.5 %} +{% ifversion ghes < 3.5 %} -In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server 3.5 or later may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 when you upgrade from an earlier release to 3.5 or later. A fix for 3.5 and later will be available in an upcoming patch release. +In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server 3.5 or later may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 when you upgrade from an earlier release to 3.5 or later. A fix is available in the [3.5.5](/enterprise-server@3.5/admin/release-notes#3.5.5) and [3.6.1](/enterprise-server@3.6/admin/release-notes#3.6.1) patch releases. -To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). [Updated: 2022-08-16] +To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). [Updated: 2022-09-01] -{% elsif ghes > 3.4 or ghes < 3.7 %} +{% elsif ghes = 3.5 or ghes = 3.6 %} -In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server {{ currentVersion }} may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 as you upgrade to the latest release. To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). +In some cases, GitHub Advanced Security customers who upgrade to GitHub Enterprise Server {{ allVersions[currentVersion].currentRelease }} may notice that alerts from secret scanning are missing in the web UI and REST API. To ensure the alerts remain visible, do not skip 3.4 as you upgrade to the latest release. To plan an upgrade through 3.4, see the [Upgrade assistant](https://support.github.com/enterprise/server-upgrade). - To display the missing alerts for all repositories owned by an organization, organization owners can navigate to the organization's **Code security and analysis** settings, then click **Enable all** for secret scanning. 更多信息请参阅“[管理组织的安全和分析设置](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-existing-repositories)”。 - To display the missing alerts for an individual repository, people with admin access to the repository can disable then enable secret scanning for the repository. 更多信息请参阅“[管理仓库的安全和分析设置](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)”。 -A fix will be available in an upcoming patch release. [Updated: 2022-08-16] +A fix is available in the {% ifversion ghes = 3.5 %}[3.5.5](/admin/release-notes#3.5.5){% elsif ghes = 3.6 %}[3.6.1](/admin/release-notes#3.6.1){% endif %} patch release. [Updated: 2022-09-01] {% endif %} diff --git a/translations/zh-CN/data/variables/actions.yml b/translations/zh-CN/data/variables/actions.yml index 756188416423..0cf389344306 100644 --- a/translations/zh-CN/data/variables/actions.yml +++ b/translations/zh-CN/data/variables/actions.yml @@ -1,2 +1,3 @@ --- azure_portal: 'Azure Portal' +hosted_runner: 'larger runner' diff --git a/translations/zh-CN/data/variables/product.yml b/translations/zh-CN/data/variables/product.yml index 5d09c47040a5..7e67ff46533d 100644 --- a/translations/zh-CN/data/variables/product.yml +++ b/translations/zh-CN/data/variables/product.yml @@ -112,6 +112,10 @@ prodname_registry: 'GitHub Packages' prodname_container_registry: 'Container registry' prodname_docker_registry_namespace: '{% ifversion fpt or ghec %}`docker.pkg.github.com`{% elsif ghes or ghae %}docker.HOSTNAME{% endif %}' prodname_container_registry_namespace: '{% ifversion fpt or ghec %}`ghcr.io`{% elsif ghes or ghae %}containers.HOSTNAME{% endif %}' +prodname_npm_registry: 'npm 注册表' +prodname_ghcr_and_npm_registry: '{% data variables.product.prodname_container_registry %}{% ifversion packages-npm-v2 %} and {% data variables.product.prodname_npm_registry %}{% endif %}' +prodname_ghcr_or_npm_registry: '{% data variables.product.prodname_container_registry %}{% ifversion packages-npm-v2 %} or {% data variables.product.prodname_npm_registry %}{% endif %}' +prodname_ghcr_and_npm_registry_full: '{% data variables.product.prodname_container_registry %} (`ghcr.io`){% ifversion packages-npm-v2 %} and {% data variables.product.prodname_npm_registry %} (`npm.pkg.github.com`){% endif %}' #GitHub Insights prodname_insights: 'GitHub Insights' #GitHub Sponsors
Runner imageImagen de ejecutor Etiqueta de flujo de trabajo YAML Notas
-Migrate to ubuntu-20.04 or ubuntu-22.04. Para obtener más información, consulta esta publicación del blog de GitHub. +Migrarse a ubuntu-20.04 o ubuntu-22.04. Para obtener más información, consulta esta publicación del blog de GitHub.